Add beautify format support for CREATE DICTIONARY statements (#253)

Copilot · git-hulk · web-flow · commit bf5be1223055 · 2026-02-13T14:37:42.000+08:00
---------

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: git-hulk &lt;4987594+git-hulk@users.noreply.github.com&gt;
diff --git a/parser/format.go b/parser/format.go
@@ -771,12 +771,13 @@ func (c *CreateDictionary) FormatSQL(formatter *Formatter) {
 	}
 
 	if c.Engine != nil {
-		formatter.WriteByte(whitespace)
+		formatter.Break()
 		formatter.WriteExpr(c.Engine)
 	}
 
 	if c.Comment != nil {
-		formatter.WriteString(" COMMENT ")
+		formatter.Break()
+		formatter.WriteString("COMMENT ")
 		formatter.WriteExpr(c.Comment)
 	}
 
@@ -1182,42 +1183,36 @@ func (d *DictionaryAttribute) FormatSQL(formatter *Formatter) {
 }
 
 func (d *DictionaryEngineClause) FormatSQL(formatter *Formatter) {
-	paddingSpace := false
 	if d.PrimaryKey != nil {
 		formatter.WriteExpr(d.PrimaryKey)
-		paddingSpace = true
 	}
 	if d.Source != nil {
-		if paddingSpace {
-			formatter.WriteByte(whitespace)
+		if d.PrimaryKey != nil {
+			formatter.Break()
 		}
 		formatter.WriteExpr(d.Source)
-		paddingSpace = true
 	}
 	if d.Lifetime != nil {
-		if paddingSpace {
-			formatter.WriteByte(whitespace)
+		if d.PrimaryKey != nil || d.Source != nil {
+			formatter.Break()
 		}
 		formatter.WriteExpr(d.Lifetime)
-		paddingSpace = true
 	}
 	if d.Layout != nil {
-		if paddingSpace {
-			formatter.WriteByte(whitespace)
+		if d.PrimaryKey != nil || d.Source != nil || d.Lifetime != nil {
+			formatter.Break()
 		}
 		formatter.WriteExpr(d.Layout)
-		paddingSpace = true
 	}
 	if d.Range != nil {
-		if paddingSpace {
-			formatter.WriteByte(whitespace)
+		if d.PrimaryKey != nil || d.Source != nil || d.Lifetime != nil || d.Layout != nil {
+			formatter.Break()
 		}
 		formatter.WriteExpr(d.Range)
-		paddingSpace = true
 	}
 	if d.Settings != nil {
-		if paddingSpace {
-			formatter.WriteByte(whitespace)
+		if d.PrimaryKey != nil || d.Source != nil || d.Lifetime != nil || d.Layout != nil || d.Range != nil {
+			formatter.Break()
 		}
 		formatter.WriteString("SETTINGS(")
 		for i, item := range d.Settings.Items {
@@ -1275,14 +1270,20 @@ func (d *DictionaryRangeClause) FormatSQL(formatter *Formatter) {
 }
 
 func (d *DictionarySchemaClause) FormatSQL(formatter *Formatter) {
-	formatter.WriteString("(")
+	formatter.WriteByte('(')
+	formatter.Indent()
 	for i, attr := range d.Attributes {
-		if i > 0 {
-			formatter.WriteString(", ")
+		if i == 0 {
+			formatter.NewLine()
+		} else {
+			formatter.WriteByte(',')
+			formatter.Break()
 		}
 		formatter.WriteExpr(attr)
 	}
-	formatter.WriteString(")")
+	formatter.Dedent()
+	formatter.NewLine()
+	formatter.WriteByte(')')
 }
 
 func (d *DictionarySourceClause) FormatSQL(formatter *Formatter) {
diff --git a/parser/testdata/ddl/format/beautify/create_dictionary_basic.sql b/parser/testdata/ddl/format/beautify/create_dictionary_basic.sql
@@ -21,4 +21,16 @@ LAYOUT(HASHED())
 SETTINGS(max_block_size = 8192);
 
 -- Beautify SQL:
-CREATE DICTIONARY test.my_dict (id UInt64, name String DEFAULT '', value Float64 EXPRESSION toFloat64OrZero(name), parent_id UInt64 HIERARCHICAL, is_active UInt8 INJECTIVE, object_id UInt64 IS_OBJECT_ID) PRIMARY KEY id SOURCE(MYSQL(host 'localhost' port 3306 user 'default' password '' db 'test' table 'dict_table')) LIFETIME(MIN 1000 MAX 2000) LAYOUT(HASHED()) SETTINGS(max_block_size=8192);
+CREATE DICTIONARY test.my_dict (
+  id UInt64,
+  name String DEFAULT '',
+  value Float64 EXPRESSION toFloat64OrZero(name),
+  parent_id UInt64 HIERARCHICAL,
+  is_active UInt8 INJECTIVE,
+  object_id UInt64 IS_OBJECT_ID
+)
+PRIMARY KEY id
+SOURCE(MYSQL(host 'localhost' port 3306 user 'default' password '' db 'test' table 'dict_table'))
+LIFETIME(MIN 1000 MAX 2000)
+LAYOUT(HASHED())
+SETTINGS(max_block_size=8192);
diff --git a/parser/testdata/ddl/format/beautify/create_dictionary_comprehensive.sql b/parser/testdata/ddl/format/beautify/create_dictionary_comprehensive.sql
@@ -24,4 +24,16 @@ LAYOUT(HASHED())
 SETTINGS(max_block_size = 8192, max_insert_block_size = 1048576);
 
 -- Beautify SQL:
-CREATE OR REPLACE DICTIONARY test.comprehensive_dict UUID '12345678-1234-1234-1234-123456789012' ON CLUSTER production_cluster (id UInt64, name String DEFAULT '', value Float64 EXPRESSION toFloat64OrZero(name), parent_id UInt64 HIERARCHICAL, is_active UInt8 INJECTIVE, object_id UInt64 IS_OBJECT_ID) PRIMARY KEY id SOURCE(MYSQL(host 'localhost' port 3306 user 'root' password 'secret' db 'test_db' table 'dictionary_table')) LIFETIME(MIN 1000 MAX 2000) LAYOUT(HASHED()) SETTINGS(max_block_size=8192, max_insert_block_size=1048576);
+CREATE OR REPLACE DICTIONARY test.comprehensive_dict UUID '12345678-1234-1234-1234-123456789012' ON CLUSTER production_cluster (
+  id UInt64,
+  name String DEFAULT '',
+  value Float64 EXPRESSION toFloat64OrZero(name),
+  parent_id UInt64 HIERARCHICAL,
+  is_active UInt8 INJECTIVE,
+  object_id UInt64 IS_OBJECT_ID
+)
+PRIMARY KEY id
+SOURCE(MYSQL(host 'localhost' port 3306 user 'root' password 'secret' db 'test_db' table 'dictionary_table'))
+LIFETIME(MIN 1000 MAX 2000)
+LAYOUT(HASHED())
+SETTINGS(max_block_size=8192, max_insert_block_size=1048576);
diff --git a/parser/testdata/ddl/format/beautify/create_dictionary_with_comment.sql b/parser/testdata/ddl/format/beautify/create_dictionary_with_comment.sql
@@ -23,4 +23,17 @@ COMMENT 'This is a test dictionary with comment';
 
 
 -- Beautify SQL:
-CREATE DICTIONARY test.my_dict (id UInt64, name String DEFAULT '', value Float64 EXPRESSION toFloat64OrZero(name), parent_id UInt64 HIERARCHICAL, is_active UInt8 INJECTIVE, object_id UInt64 IS_OBJECT_ID) PRIMARY KEY id SOURCE(MYSQL(host 'localhost' port 3306 user 'default' password '' db 'test' table 'dict_table')) LIFETIME(MIN 1000 MAX 2000) LAYOUT(HASHED()) SETTINGS(max_block_size=8192) COMMENT 'This is a test dictionary with comment';
+CREATE DICTIONARY test.my_dict (
+  id UInt64,
+  name String DEFAULT '',
+  value Float64 EXPRESSION toFloat64OrZero(name),
+  parent_id UInt64 HIERARCHICAL,
+  is_active UInt8 INJECTIVE,
+  object_id UInt64 IS_OBJECT_ID
+)
+PRIMARY KEY id
+SOURCE(MYSQL(host 'localhost' port 3306 user 'default' password '' db 'test' table 'dict_table'))
+LIFETIME(MIN 1000 MAX 2000)
+LAYOUT(HASHED())
+SETTINGS(max_block_size=8192)
+COMMENT 'This is a test dictionary with comment';

Original file line number	Diff line number	Diff line change
`@@ -771,12 +771,13 @@ func (c CreateDictionary) FormatSQL(formatter Formatter) {`
`771`	`771`	`}`
`772`	`772`
`773`	`773`	`if c.Engine != nil {`
`774`		`- formatter.WriteByte(whitespace)`
	`774`	`+ formatter.Break()`
`775`	`775`	`formatter.WriteExpr(c.Engine)`
`776`	`776`	`}`
`777`	`777`
`778`	`778`	`if c.Comment != nil {`
`779`		`- formatter.WriteString(" COMMENT ")`
	`779`	`+ formatter.Break()`
	`780`	`+ formatter.WriteString("COMMENT ")`
`780`	`781`	`formatter.WriteExpr(c.Comment)`
`781`	`782`	`}`
`782`	`783`
`@@ -1182,42 +1183,36 @@ func (d DictionaryAttribute) FormatSQL(formatter Formatter) {`
`1182`	`1183`	`}`
`1183`	`1184`
`1184`	`1185`	`func (d DictionaryEngineClause) FormatSQL(formatter Formatter) {`
`1185`		`- paddingSpace := false`
`1186`	`1186`	`if d.PrimaryKey != nil {`
`1187`	`1187`	`formatter.WriteExpr(d.PrimaryKey)`
`1188`		`- paddingSpace = true`
`1189`	`1188`	`}`
`1190`	`1189`	`if d.Source != nil {`
`1191`		`- if paddingSpace {`
`1192`		`- formatter.WriteByte(whitespace)`
	`1190`	`+ if d.PrimaryKey != nil {`
	`1191`	`+ formatter.Break()`
`1193`	`1192`	`}`
`1194`	`1193`	`formatter.WriteExpr(d.Source)`
`1195`		`- paddingSpace = true`
`1196`	`1194`	`}`
`1197`	`1195`	`if d.Lifetime != nil {`
`1198`		`- if paddingSpace {`
`1199`		`- formatter.WriteByte(whitespace)`
	`1196`	`+ if d.PrimaryKey != nil \|\| d.Source != nil {`
	`1197`	`+ formatter.Break()`
`1200`	`1198`	`}`
`1201`	`1199`	`formatter.WriteExpr(d.Lifetime)`
`1202`		`- paddingSpace = true`
`1203`	`1200`	`}`
`1204`	`1201`	`if d.Layout != nil {`
`1205`		`- if paddingSpace {`
`1206`		`- formatter.WriteByte(whitespace)`
	`1202`	`+ if d.PrimaryKey != nil \|\| d.Source != nil \|\| d.Lifetime != nil {`
	`1203`	`+ formatter.Break()`
`1207`	`1204`	`}`
`1208`	`1205`	`formatter.WriteExpr(d.Layout)`
`1209`		`- paddingSpace = true`
`1210`	`1206`	`}`
`1211`	`1207`	`if d.Range != nil {`
`1212`		`- if paddingSpace {`
`1213`		`- formatter.WriteByte(whitespace)`
	`1208`	`+ if d.PrimaryKey != nil \|\| d.Source != nil \|\| d.Lifetime != nil \|\| d.Layout != nil {`
	`1209`	`+ formatter.Break()`
`1214`	`1210`	`}`
`1215`	`1211`	`formatter.WriteExpr(d.Range)`
`1216`		`- paddingSpace = true`
`1217`	`1212`	`}`
`1218`	`1213`	`if d.Settings != nil {`
`1219`		`- if paddingSpace {`
`1220`		`- formatter.WriteByte(whitespace)`
	`1214`	`+ if d.PrimaryKey != nil \|\| d.Source != nil \|\| d.Lifetime != nil \|\| d.Layout != nil \|\| d.Range != nil {`
	`1215`	`+ formatter.Break()`
`1221`	`1216`	`}`
`1222`	`1217`	`formatter.WriteString("SETTINGS(")`
`1223`	`1218`	`for i, item := range d.Settings.Items {`
`@@ -1275,14 +1270,20 @@ func (d DictionaryRangeClause) FormatSQL(formatter Formatter) {`
`1275`	`1270`	`}`
`1276`	`1271`
`1277`	`1272`	`func (d DictionarySchemaClause) FormatSQL(formatter Formatter) {`
`1278`		`- formatter.WriteString("(")`
	`1273`	`+ formatter.WriteByte('(')`
	`1274`	`+ formatter.Indent()`
`1279`	`1275`	`for i, attr := range d.Attributes {`
`1280`		`- if i > 0 {`
`1281`		`- formatter.WriteString(", ")`
	`1276`	`+ if i == 0 {`
	`1277`	`+ formatter.NewLine()`
	`1278`	`+ } else {`
	`1279`	`+ formatter.WriteByte(',')`
	`1280`	`+ formatter.Break()`
`1282`	`1281`	`}`
`1283`	`1282`	`formatter.WriteExpr(attr)`
`1284`	`1283`	`}`
`1285`		`- formatter.WriteString(")")`
	`1284`	`+ formatter.Dedent()`
	`1285`	`+ formatter.NewLine()`
	`1286`	`+ formatter.WriteByte(')')`
`1286`	`1287`	`}`
`1287`	`1288`
`1288`	`1289`	`func (d DictionarySourceClause) FormatSQL(formatter Formatter) {`