ddlglot

Welcome to ddlglot’s documentation!

ddlglot is a Python library that provides a fluent builder API for generating DDL (Data Definition Language) statements using SQLGlot’s AST.

Features

• Fluent API: Chain method calls to build DDL statements

• Multiple Dialects: Support for Spark, Delta Lake, Hive, PostgreSQL, DuckDB, BigQuery, SQLite

• Type Safe: Full type hints and validation

• SQLGlot Powered: Leverage SQLGlot’s AST for SQL generation

Quick Start

from ddlglot import create

# Create a table for PostgreSQL
sql = (
    create("table")
    .name("public.users")
    .column("id", "INT", not_null=True)
    .column("name", "VARCHAR(100)")
    .sql(dialect="postgres", pretty=True)
)

Output:

CREATE TABLE public.users (
  id INT NOT NULL,
  name VARCHAR(100)
)

Contents:

• Quick Start
  • Installation
  • Basic Usage
  • Column Definitions
  • Table Constraints
  • Views and CTAS
  • Dialect-Specific Features
  • Pretty Printing
• Motivation
  • Origin
  • The Problem with Raw SQL
  • Why Not Use an ORM Instead?
  • When Not to Use ddlglot
  • The Solution: ddlglot
  • Practical Example: Ibis + ddlglot for Spark
  • Comparison with Similar Tools
  • What ddlglot Does NOT Do
• Dialects Reference
  • Type Translation Tables
  • Dialect Feature Matrix
  • Known Limitations
  • Error Handling
• Core Builder
  • Method Classification
  • Methods Reference
  • IndexBuilder and create_index()
  • Supported Dialects
• API Reference
  • ddlglot

Installation

pip install ddlglot

License

MIT License