format

Overview ¶

Package format provides well-formatted SQL output for ClickHouse DDL statements.

This package takes parsed parser statements and generates clean, readable SQL with consistent formatting, proper indentation, and standardized styling. It separates formatting concerns from parsing and migration logic.

Key features:

• Consistent indentation and spacing
• Proper line breaks for readability
• Standardized keyword casing
• Column alignment in table definitions
• Comprehensive support for all DDL statement types
• ClickHouse-optimized backtick formatting for identifiers

Usage:

// Object-oriented API with default options
formatter := format.New(format.Defaults)

// Object-oriented API with custom options
formatter := format.New(format.FormatterOptions{
	IndentSize:        2,
	UppercaseKeywords: false,
	AlignColumns:      true,
})

var buf bytes.Buffer
err := formatter.Format(&buf, statements...)

// Functional API
var buf bytes.Buffer
err := format.Format(&buf, format.Defaults, statements...)

// Convenient SQL formatting
sqlResult, _ := parser.ParseString("CREATE DATABASE test; CREATE TABLE test.users (id UInt64) ENGINE = MergeTree();")
var buf bytes.Buffer
err := format.FormatSQL(&buf, format.Defaults, sqlResult)

The formatter supports all ClickHouse DDL operations including databases, tables, dictionaries, views, and SELECT statements with proper formatting for complex features like CTEs, window functions, and nested structures.

Package format provides well-formatted SQL output for ClickHouse DDL statements.

This package takes parsed parser statements and generates clean, readable SQL with consistent formatting, proper indentation, and standardized styling. It separates formatting concerns from parsing and migration logic.

Key features: - Consistent indentation and spacing - Proper line breaks for readability - Standardized keyword casing - Column alignment in table definitions - Comprehensive support for all DDL statement types

Example usage:

stmt := &parser.Statement{CreateTable: &parser.CreateTableStmt{
	Name: "users",
	Database: stringPtr("analytics"),
	Columns: []*parser.Column{
		{Name: "id", Type: &parser.DataType{Simple: &parser.SimpleDataType{Name: "UInt64"}}},
		{Name: "name", Type: &parser.DataType{Simple: &parser.SimpleDataType{Name: "String"}}},
	},
	Engine: &parser.TableEngine{Name: "MergeTree"},
}}

formatted := format.Format(nil, stmt)
fmt.Println(formatted)

Output:

CREATE TABLE `analytics`.`users` (
    `id` UInt64,
    `name` String
) ENGINE = MergeTree();