Adding support for comment in table/view (AfterShip#104)

sharadgaur · git-hulk · git-hulk · commit ff27c77cc8f7 · 2024-11-29T16:44:45.000+08:00
Signed-off-by: Sharad Gaur &lt;sharadgaur@gmail.com&gt;
Co-authored-by: hulk &lt;hulk.website@gmail.com&gt;
diff --git a/parser/ast.go b/parser/ast.go
@@ -1490,6 +1490,7 @@ type CreateTable struct {
 	Engine       *EngineExpr
 	SubQuery     *SubQuery
 	HasTemporary bool
+	Comment      *StringLiteral
 }
 
 func (c *CreateTable) Pos() Pos {
@@ -1534,6 +1535,10 @@ func (c *CreateTable) String() string {
 		builder.WriteString(" AS ")
 		builder.WriteString(c.SubQuery.String())
 	}
+	if c.Comment != nil {
+		builder.WriteString(" COMMENT ")
+		builder.WriteString(c.Comment.String())
+	}
 	return builder.String()
 }
 
@@ -1578,6 +1583,7 @@ type CreateMaterializedView struct {
 	Destination  *DestinationClause
 	SubQuery     *SubQuery
 	Populate     bool
+	Comment      *StringLiteral
 }
 
 func (c *CreateMaterializedView) Pos() Pos {
@@ -1621,6 +1627,11 @@ func (c *CreateMaterializedView) String() string {
 		builder.WriteString(" AS ")
 		builder.WriteString(c.SubQuery.String())
 	}
+
+	if c.Comment != nil {
+		builder.WriteString(" COMMENT ")
+		builder.WriteString(c.Comment.String())
+	}
 	return builder.String()
 }
 
diff --git a/parser/parser_common.go b/parser/parser_common.go
@@ -137,6 +137,13 @@ func (p *Parser) tryParseUUID() (*UUID, error) {
 	return p.parseUUID()
 }
 
+func (p *Parser) tryParseComment() (*StringLiteral, error) {
+	if p.tryConsumeKeyword(KeywordComment) == nil {
+		return nil, nil
+	}
+	return p.parseString(p.Pos())
+}
+
 func (p *Parser) tryParseIfExists() (bool, error) {
 	if p.tryConsumeKeyword(KeywordIf) == nil {
 		return false, nil
diff --git a/parser/parser_table.go b/parser/parser_table.go
@@ -166,6 +166,12 @@ func (p *Parser) parseCreateTable(pos Pos) (*CreateTable, error) {
 		createTable.SubQuery = subQuery
 		createTable.StatementEnd = subQuery.End()
 	}
+
+	comment, err := p.tryParseComment()
+	if err != nil {
+		return nil, err
+	}
+	createTable.Comment = comment
 	return createTable, nil
 }
 
diff --git a/parser/parser_view.go b/parser/parser_view.go
@@ -69,6 +69,12 @@ func (p *Parser) parseCreateMaterializedView(pos Pos) (*CreateMaterializedView,
 		createMaterializedView.SubQuery = subQuery
 		createMaterializedView.StatementEnd = subQuery.End()
 	}
+
+	comment, err := p.tryParseComment()
+	if err != nil {
+		return nil, err
+	}
+	createMaterializedView.Comment = comment
 	return createMaterializedView, nil
 }
 
diff --git a/parser/testdata/ddl/create_materialized_view_basic.sql b/parser/testdata/ddl/create_materialized_view_basic.sql
@@ -18,4 +18,5 @@ SELECT f1,
 FROM
     infra_bm.table_name1
 WHERE
-    infra_bm.table_name1.event = 'test-event';
+    infra_bm.table_name1.event = 'test-event'
+COMMENT 'Comment for table';
diff --git a/parser/testdata/ddl/create_table_basic.sql b/parser/testdata/ddl/create_table_basic.sql
@@ -26,4 +26,5 @@ CREATE TABLE IF NOT EXISTS test.events_local (
 PRIMARY KEY (f0, f1, f2)
 PARTITION BY toYYYYMMDD(f3)
 TTL f3 + INTERVAL 6 MONTH
-ORDER BY (f1,f2,f3)
+ORDER BY (f1,f2,f3)
+COMMENT 'Comment for table';
diff --git a/parser/testdata/ddl/format/create_materialized_view_basic.sql b/parser/testdata/ddl/format/create_materialized_view_basic.sql
@@ -19,7 +19,8 @@ SELECT f1,
 FROM
     infra_bm.table_name1
 WHERE
-    infra_bm.table_name1.event = 'test-event';
+    infra_bm.table_name1.event = 'test-event'
+COMMENT 'Comment for table';
 
 -- Format SQL:
-CREATE MATERIALIZED VIEW infra_bm.view_name ON CLUSTER 'default_cluster' TO infra_bm.table_name (`f1` DateTime64(3), `f2` String, `f3` String, `f4` String, `f5` String, `f6` Int64) AS SELECT f1, f2, visitParamExtractString(properties, 'f3') AS f3, visitParamExtractString(properties, 'f4') AS f4, visitParamExtractString(properties, 'f5') AS f5, visitParamExtractInt(properties, 'f6') AS f6 FROM infra_bm.table_name1 WHERE infra_bm.table_name1.event = 'test-event';
+CREATE MATERIALIZED VIEW infra_bm.view_name ON CLUSTER 'default_cluster' TO infra_bm.table_name (`f1` DateTime64(3), `f2` String, `f3` String, `f4` String, `f5` String, `f6` Int64) AS SELECT f1, f2, visitParamExtractString(properties, 'f3') AS f3, visitParamExtractString(properties, 'f4') AS f4, visitParamExtractString(properties, 'f5') AS f5, visitParamExtractInt(properties, 'f6') AS f6 FROM infra_bm.table_name1 WHERE infra_bm.table_name1.event = 'test-event' COMMENT 'Comment for table';
diff --git a/parser/testdata/ddl/format/create_table_basic.sql b/parser/testdata/ddl/format/create_table_basic.sql
@@ -28,6 +28,7 @@ PRIMARY KEY (f0, f1, f2)
 PARTITION BY toYYYYMMDD(f3)
 TTL f3 + INTERVAL 6 MONTH
 ORDER BY (f1,f2,f3)
+COMMENT 'Comment for table';
 
 -- Format SQL:
-CREATE TABLE IF NOT EXISTS test.events_local (f0 String, f1 String CODEC(ZSTD(1)), f2 VARCHAR(255), f3 Datetime, f4 Datetime, f5 Map(String, String), f6 String, f7 Nested(f70 UInt32, f71 UInt32, f72 DateTime, f73 Int64, f74 Int64, f75 String), f8 Datetime DEFAULT now(), f9 String MATERIALIZED toString(f7['f70']), f10 String ALIAS f11) ENGINE = MergeTree PRIMARY KEY (f0, f1, f2) PARTITION BY toYYYYMMDD(f3) TTL f3 + INTERVAL 6 MONTH ORDER BY (f1, f2, f3);
+CREATE TABLE IF NOT EXISTS test.events_local (f0 String, f1 String CODEC(ZSTD(1)), f2 VARCHAR(255), f3 Datetime, f4 Datetime, f5 Map(String, String), f6 String, f7 Nested(f70 UInt32, f71 UInt32, f72 DateTime, f73 Int64, f74 Int64, f75 String), f8 Datetime DEFAULT now(), f9 String MATERIALIZED toString(f7['f70']), f10 String ALIAS f11) ENGINE = MergeTree PRIMARY KEY (f0, f1, f2) PARTITION BY toYYYYMMDD(f3) TTL f3 + INTERVAL 6 MONTH ORDER BY (f1, f2, f3) COMMENT 'Comment for table';
diff --git a/parser/testdata/ddl/output/attach_table_basic.sql.golden.json b/parser/testdata/ddl/output/attach_table_basic.sql.golden.json
@@ -476,6 +476,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/bug_001.sql.golden.json b/parser/testdata/ddl/output/bug_001.sql.golden.json
@@ -564,6 +564,7 @@
         "Except": null
       }
     },
-    "Populate": false
+    "Populate": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_distributed_table.sql.golden.json b/parser/testdata/ddl/output/create_distributed_table.sql.golden.json
@@ -139,6 +139,7 @@
       "OrderBy": null
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_materialized_view_basic.sql.golden.json b/parser/testdata/ddl/output/create_materialized_view_basic.sql.golden.json
@@ -531,6 +531,11 @@
         "Except": null
       }
     },
-    "Populate": false
+    "Populate": false,
+    "Comment": {
+      "LiteralPos": 548,
+      "LiteralEnd": 565,
+      "Literal": "Comment for table"
+    }
   }
 ]
diff --git a/parser/testdata/ddl/output/create_materialized_view_with_empty_table_schema.sql.golden.json b/parser/testdata/ddl/output/create_materialized_view_with_empty_table_schema.sql.golden.json
@@ -541,6 +541,7 @@
         "Except": null
       }
     },
-    "Populate": true
+    "Populate": true,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_basic.sql.golden.json b/parser/testdata/ddl/output/create_table_basic.sql.golden.json
@@ -838,6 +838,11 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": {
+      "LiteralPos": 687,
+      "LiteralEnd": 704,
+      "Literal": "Comment for table"
+    }
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_codec_delta.sql.golden.json b/parser/testdata/ddl/output/create_table_with_codec_delta.sql.golden.json
@@ -763,6 +763,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_index.sql.golden.json b/parser/testdata/ddl/output/create_table_with_index.sql.golden.json
@@ -817,6 +817,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_keyword_partition_by.sql.golden.json b/parser/testdata/ddl/output/create_table_with_keyword_partition_by.sql.golden.json
@@ -244,6 +244,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_nullable.sql.golden.json b/parser/testdata/ddl/output/create_table_with_nullable.sql.golden.json
@@ -422,6 +422,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_on_clsuter.sql.golden.json b/parser/testdata/ddl/output/create_table_with_on_clsuter.sql.golden.json
@@ -476,6 +476,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_sample_by.sql.golden.json b/parser/testdata/ddl/output/create_table_with_sample_by.sql.golden.json
@@ -304,6 +304,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]
diff --git a/parser/testdata/ddl/output/create_table_with_uuid.sql.golden.json b/parser/testdata/ddl/output/create_table_with_uuid.sql.golden.json
@@ -482,6 +482,7 @@
       }
     },
     "SubQuery": null,
-    "HasTemporary": false
+    "HasTemporary": false,
+    "Comment": null
   }
 ]

Original file line number	Diff line number	Diff line change
`@@ -1490,6 +1490,7 @@ type CreateTable struct {`
`1490`	`1490`	`Engine *EngineExpr`
`1491`	`1491`	`SubQuery *SubQuery`
`1492`	`1492`	`HasTemporary bool`
	`1493`	`+ Comment *StringLiteral`
`1493`	`1494`	`}`
`1494`	`1495`
`1495`	`1496`	`func (c *CreateTable) Pos() Pos {`
`@@ -1534,6 +1535,10 @@ func (c *CreateTable) String() string {`
`1534`	`1535`	`builder.WriteString(" AS ")`
`1535`	`1536`	`builder.WriteString(c.SubQuery.String())`
`1536`	`1537`	`}`
	`1538`	`+ if c.Comment != nil {`
	`1539`	`+ builder.WriteString(" COMMENT ")`
	`1540`	`+ builder.WriteString(c.Comment.String())`
	`1541`	`+ }`
`1537`	`1542`	`return builder.String()`
`1538`	`1543`	`}`
`1539`	`1544`
`@@ -1578,6 +1583,7 @@ type CreateMaterializedView struct {`
`1578`	`1583`	`Destination *DestinationClause`
`1579`	`1584`	`SubQuery *SubQuery`
`1580`	`1585`	`Populate bool`
	`1586`	`+ Comment *StringLiteral`
`1581`	`1587`	`}`
`1582`	`1588`
`1583`	`1589`	`func (c *CreateMaterializedView) Pos() Pos {`
`@@ -1621,6 +1627,11 @@ func (c *CreateMaterializedView) String() string {`
`1621`	`1627`	`builder.WriteString(" AS ")`
`1622`	`1628`	`builder.WriteString(c.SubQuery.String())`
`1623`	`1629`	`}`
	`1630`	`+`
	`1631`	`+ if c.Comment != nil {`
	`1632`	`+ builder.WriteString(" COMMENT ")`
	`1633`	`+ builder.WriteString(c.Comment.String())`
	`1634`	`+ }`
`1624`	`1635`	`return builder.String()`
`1625`	`1636`	`}`
`1626`	`1637`
Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,12 @@ func (p Parser) parseCreateTable(pos Pos) (CreateTable, error) {`
`166`	`166`	`createTable.SubQuery = subQuery`
`167`	`167`	`createTable.StatementEnd = subQuery.End()`
`168`	`168`	`}`
	`169`	`+`
	`170`	`+ comment, err := p.tryParseComment()`
	`171`	`+ if err != nil {`
	`172`	`+ return nil, err`
	`173`	`+ }`
	`174`	`+ createTable.Comment = comment`
`169`	`175`	`return createTable, nil`
`170`	`176`	`}`
`171`	`177`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,12 @@ func (p Parser) parseCreateMaterializedView(pos Pos) (CreateMaterializedView,`
`69`	`69`	`createMaterializedView.SubQuery = subQuery`
`70`	`70`	`createMaterializedView.StatementEnd = subQuery.End()`
`71`	`71`	`}`
	`72`	`+`
	`73`	`+ comment, err := p.tryParseComment()`
	`74`	`+ if err != nil {`
	`75`	`+ return nil, err`
	`76`	`+ }`
	`77`	`+ createMaterializedView.Comment = comment`
`72`	`78`	`return createMaterializedView, nil`
`73`	`79`	`}`
`74`	`80`
Original file line number	Diff line number	Diff line change
`@@ -476,6 +476,7 @@`
`476`	`476`	`}`
`477`	`477`	`},`
`478`	`478`	`"SubQuery": null,`
`479`		`- "HasTemporary": false`
	`479`	`+ "HasTemporary": false,`
	`480`	`+ "Comment": null`
`480`	`481`	`}`
`481`	`482`	`]`
Original file line number	Diff line number	Diff line change
`@@ -564,6 +564,7 @@`
`564`	`564`	`"Except": null`
`565`	`565`	`}`
`566`	`566`	`},`
`567`		`- "Populate": false`
	`567`	`+ "Populate": false,`
	`568`	`+ "Comment": null`
`568`	`569`	`}`
`569`	`570`	`]`