Skip to content

Commit 1cd576b

Browse files
manticore-projectsmanticore-projects
committed
feat: DuckDB STRUCT with curly brackets and explicit Column Type Cast
Signed-off-by: Andreas Reichel <andreas@manticore-projects.com>
1 parent 5cb4c55 commit 1cd576b

File tree

6 files changed

+84
-29
lines changed

6 files changed

+84
-29
lines changed

‎src/main/java/net/sf/jsqlparser/expression/StructType.java

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,13 @@
3232
*
3333
*/
3434
public class StructType extends ASTNodeAccessImpl implements Expression {
35-
public enum Dialect { BIG_QUERY, DUCKDB };
36-
37-
public Dialect getDialect() {
38-
return dialect;
39-
}
40-
41-
public StructType setDialect(Dialect dialect) {
42-
this.dialect = dialect;
43-
return this;
44-
}
45-
46-
private Dialect dialect = Dialect.BIG_QUERY;
35+
private Dialect dialect = Dialect.BIG_QUERY;;
4736
private String keyword;
4837
private List<Map.Entry<String, ColDataType>> parameters;
4938
private List<SelectItem<?>> arguments;
5039

51-
public StructType(Dialect dialect, String keyword, List<Map.Entry<String, ColDataType>> parameters,
40+
public StructType(Dialect dialect, String keyword,
41+
List<Map.Entry<String, ColDataType>> parameters,
5242
List<SelectItem<?>> arguments) {
5343
this.dialect = dialect;
5444
this.keyword = keyword;
@@ -63,6 +53,15 @@ public StructType(Dialect dialect, List<Map.Entry<String, ColDataType>> paramete
6353
this.arguments = arguments;
6454
}
6555

56+
public Dialect getDialect() {
57+
return dialect;
58+
}
59+
60+
public StructType setDialect(Dialect dialect) {
61+
this.dialect = dialect;
62+
return this;
63+
}
64+
6665
public String getKeyword() {
6766
return keyword;
6867
}
@@ -91,20 +90,20 @@ public StructType setArguments(List<SelectItem<?>> arguments) {
9190
}
9291

9392
public StructType add(Expression expression, String aliasName) {
94-
if (arguments==null) {
95-
arguments= new ArrayList<>();
93+
if (arguments == null) {
94+
arguments = new ArrayList<>();
9695
}
9796
arguments.add(new SelectItem<>(expression, aliasName));
9897

9998
return this;
10099
}
101100

102101
public StringBuilder appendTo(StringBuilder builder) {
103-
if (keyword != null) {
102+
if (dialect != Dialect.DUCKDB && keyword != null) {
104103
builder.append(keyword);
105104
}
106105

107-
if (parameters != null && !parameters.isEmpty()) {
106+
if (dialect != Dialect.DUCKDB && parameters != null && !parameters.isEmpty()) {
108107
builder.append("<");
109108
int i = 0;
110109

@@ -126,7 +125,7 @@ public StringBuilder appendTo(StringBuilder builder) {
126125

127126
if (arguments != null && !arguments.isEmpty()) {
128127

129-
if (dialect==Dialect.DUCKDB) {
128+
if (dialect == Dialect.DUCKDB) {
130129
builder.append("{ ");
131130
int i = 0;
132131
for (SelectItem<?> e : arguments) {
@@ -152,6 +151,20 @@ public StringBuilder appendTo(StringBuilder builder) {
152151
}
153152
}
154153

154+
if (dialect == Dialect.DUCKDB && parameters != null && !parameters.isEmpty()) {
155+
builder.append("::STRUCT( ");
156+
int i = 0;
157+
158+
for (Map.Entry<String, ColDataType> e : parameters) {
159+
if (0 < i++) {
160+
builder.append(",");
161+
}
162+
builder.append(e.getKey()).append(" ");
163+
builder.append(e.getValue());
164+
}
165+
builder.append(")");
166+
}
167+
155168
return builder;
156169
}
157170

@@ -164,4 +177,8 @@ public String toString() {
164177
public void accept(ExpressionVisitor expressionVisitor) {
165178
expressionVisitor.visit(this);
166179
}
180+
181+
public enum Dialect {
182+
BIG_QUERY, DUCKDB
183+
}
167184
}

‎src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,11 +1112,13 @@ public void visit(TSQLRightJoin tsqlRightJoin) {
11121112

11131113
@Override
11141114
public void visit(StructType structType) {
1115-
if (structType.getKeyword() != null) {
1115+
if (structType.getDialect() != StructType.Dialect.DUCKDB
1116+
&& structType.getKeyword() != null) {
11161117
buffer.append(structType.getKeyword());
11171118
}
11181119

1119-
if (structType.getParameters() != null && !structType.getParameters().isEmpty()) {
1120+
if (structType.getDialect() != StructType.Dialect.DUCKDB
1121+
&& structType.getParameters() != null && !structType.getParameters().isEmpty()) {
11201122
buffer.append("<");
11211123
int i = 0;
11221124
for (Map.Entry<String, ColDataType> e : structType.getParameters()) {
@@ -1136,7 +1138,7 @@ public void visit(StructType structType) {
11361138
}
11371139

11381140
if (structType.getArguments() != null && !structType.getArguments().isEmpty()) {
1139-
if (structType.getDialect()==StructType.Dialect.DUCKDB) {
1141+
if (structType.getDialect() == StructType.Dialect.DUCKDB) {
11401142
buffer.append("{ ");
11411143
int i = 0;
11421144
for (SelectItem<?> e : structType.getArguments()) {
@@ -1161,6 +1163,20 @@ public void visit(StructType structType) {
11611163
buffer.append(")");
11621164
}
11631165
}
1166+
1167+
if (structType.getDialect() == StructType.Dialect.DUCKDB
1168+
&& structType.getParameters() != null && !structType.getParameters().isEmpty()) {
1169+
buffer.append("::STRUCT( ");
1170+
int i = 0;
1171+
for (Map.Entry<String, ColDataType> e : structType.getParameters()) {
1172+
if (0 < i++) {
1173+
buffer.append(",");
1174+
}
1175+
buffer.append(e.getKey()).append(" ");
1176+
buffer.append(e.getValue());
1177+
}
1178+
buffer.append(")");
1179+
}
11641180
}
11651181

11661182
}

‎src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1848,7 +1848,7 @@ String RelObjectNameWithoutValue() :
18481848
{ Token tk = null; }
18491849
{
18501850
( tk=<S_IDENTIFIER> | tk=<S_QUOTED_IDENTIFIER> | tk=<K_DATE_LITERAL> | tk=<K_DATETIMELITERAL> | tk=<K_STRING_FUNCTION_NAME> | tk=<K_ISOLATION> | tk=<K_TIME_KEY_EXPR>
1851-
| tk="ACTION" | tk="ACTIVE" | tk="ADD" | tk="ADVANCE" | tk="ADVISE" | tk="AGAINST" | tk="ALGORITHM" | tk="ALTER" | tk="ANALYZE" | tk="APPLY" | tk="ARCHIVE" | tk="ARRAY" | tk="ASC" | tk="AT" | tk="AUTHORIZATION" | tk="AUTO" | tk="BEGIN" | tk="BERNOULLI" | tk="BINARY" | tk="BIT" | tk="BLOCK" | tk="BROWSE" | tk="BUFFERS" | tk="BY" | tk="BYTE" | tk="BYTES" | tk="CACHE" | tk="CALL" | tk="CASCADE" | tk="CASE" | tk="CAST" | tk="CHANGE" | tk="CHANGES" | tk="CHAR" | tk="CHARACTER" | tk="CHECKPOINT" | tk="CLOSE" | tk="COLLATE" | tk="COLUMN" | tk="COLUMNS" | tk="COMMENT" | tk="COMMIT" | tk="CONCURRENTLY" | tk="CONFLICT" | tk="CONSTRAINTS" | tk="CONVERT" | tk="COSTS" | tk="CS" | tk="CYCLE" | tk="DATA" | tk="DATABASE" | tk="DATETIME" | tk="DDL" | tk="DECLARE" | tk="DEFAULT" | tk="DEFERRABLE" | tk="DELAYED" | tk="DELETE" | tk="DESC" | tk="DESCRIBE" | tk="DISABLE" | tk="DISCONNECT" | tk="DIV" | tk="DML" | tk="DO" | tk="DOMAIN" | tk="DROP" | tk="DUMP" | tk="DUPLICATE" | tk="ELEMENTS" | tk="EMIT" | tk="ENABLE" | tk="END" | tk="ESCAPE" | tk="EXCLUDE" | tk="EXEC" | tk="EXECUTE" | tk="EXPLAIN" | tk="EXPLICIT" | tk="EXTENDED" | tk="EXTRACT" | tk="FALSE" | tk="FILTER" | tk="FIRST" | tk="FLUSH" | tk="FN" | tk="FOLLOWING" | tk="FORMAT" | tk="FULLTEXT" | tk="FUNCTION" | tk="GRANT" | tk="GUARD" | tk="HASH" | tk="HISTORY" | tk="HOPPING" | tk="INCLUDE" | tk="INCREMENT" | tk="INDEX" | tk="INSERT" | tk="INTERLEAVE" | tk="INTERPRET" | tk="INVALIDATE" | tk="ISNULL" | tk="JSON" | tk="KEEP" | tk="KEY" | tk="KEYS" | tk="LAST" | tk="LEADING" | tk="LINK" | tk="LOCAL" | tk="LOCKED" | tk="LOG" | tk="LOOP" | tk="MATCH" | tk="MATCHED" | tk="MATERIALIZED" | tk="MAXVALUE" | tk="MEMBER" | tk="MERGE" | tk="MINVALUE" | tk="MODIFY" | tk="MOVEMENT" | tk="NEXT" | tk="NO" | tk="NOCACHE" | tk="NOKEEP" | tk="NOLOCK" | tk="NOMAXVALUE" | tk="NOMINVALUE" | tk="NOORDER" | tk="NOTHING" | tk="NOTNULL" | tk="NOVALIDATE" | tk="NOWAIT" | tk="NULLS" | tk="OF" | tk="OFF" | tk="OPEN" | tk="OVER" | tk="OVERLAPS" | tk="PARALLEL" | tk="PARENT" | tk="PARTITION" | tk="PATH" | tk="PERCENT" | tk="PLACING" | tk="PRECEDING" | tk="PRECISION" | tk="PRIMARY" | tk="PRIOR" | tk="PURGE" | tk="QUERY" | tk="QUICK" | tk="QUIESCE" | tk="RANGE" | tk="RAW" | tk="READ" | tk="RECYCLEBIN" | tk="REFERENCES" | tk="REFRESH" | tk="REGEXP" | tk="REGISTER" | tk="REMOTE" | tk="RENAME" | tk="REPEATABLE" | tk="REPLACE" | tk="RESET" | tk="RESTART" | tk="RESTRICT" | tk="RESTRICTED" | tk="RESUMABLE" | tk="RESUME" | tk="RETURN" | tk="RLIKE" | tk="ROLLBACK" | tk="ROLLUP" | tk="ROOT" | tk="ROW" | tk="ROWS" | tk="RR" | tk="RS" | tk="SAVEPOINT" | tk="SCHEMA" | tk="SECURE" | tk="SEED" | tk="SEPARATOR" | tk="SEQUENCE" | tk="SESSION" | tk="SETS" | tk="SHARE" | tk="SHOW" | tk="SHUTDOWN" | tk="SIBLINGS" | tk="SIGNED" | tk="SIMILAR" | tk="SIZE" | tk="SKIP" | tk="STORED" | tk="STRING" | tk="STRUCT" | tk="SUSPEND" | tk="SWITCH" | tk="SYNONYM" | tk="SYSTEM" | tk="TABLE" | tk="TABLESPACE" | tk="TEMP" | tk="TEMPORARY" | tk="THEN" | tk="TIMEOUT" | tk="TIMESTAMPTZ" | tk="TIMEZONE" | tk="TO" | tk="TRIGGER" | tk="TRUE" | tk="TRUNCATE" | tk="TUMBLING" | tk="TYPE" | tk="UNLOGGED" | tk="UNQIESCE" | tk="UNSIGNED" | tk="UPDATE" | tk="UPSERT" | tk="UR" | tk="USER" | tk="VALIDATE" | tk="VERBOSE" | tk="VIEW" | tk="VOLATILE" | tk="WAIT" | tk="WITHIN" | tk="WITHOUT" | tk="WORK" | tk="XML" | tk="XMLAGG" | tk="XMLDATA" | tk="XMLSCHEMA" | tk="XMLTEXT" | tk="XSINIL" | tk="YAML" | tk="YES" | tk="ZONE" )
1851+
| tk="ACTION" | tk="ACTIVE" | tk="ADD" | tk="ADVANCE" | tk="ADVISE" | tk="AGAINST" | tk="ALGORITHM" | tk="ALTER" | tk="ANALYZE" | tk="APPLY" | tk="ARCHIVE" | tk="ARRAY" | tk="ASC" | tk="AT" | tk="AUTHORIZATION" | tk="AUTO" | tk="BEGIN" | tk="BERNOULLI" | tk="BINARY" | tk="BIT" | tk="BLOCK" | tk="BROWSE" | tk="BUFFERS" | tk="BY" | tk="BYTE" | tk="BYTES" | tk="CACHE" | tk="CALL" | tk="CASCADE" | tk="CASE" | tk="CAST" | tk="CHANGE" | tk="CHANGES" | tk="CHAR" | tk="CHARACTER" | tk="CHECKPOINT" | tk="CLOSE" | tk="COLLATE" | tk="COLUMN" | tk="COLUMNS" | tk="COMMENT" | tk="COMMIT" | tk="CONCURRENTLY" | tk="CONFLICT" | tk="CONSTRAINTS" | tk="CONVERT" | tk="COSTS" | tk="CS" | tk="CYCLE" | tk="DATA" | tk="DATABASE" | tk="DATETIME" | tk="DDL" | tk="DECLARE" | tk="DEFAULT" | tk="DEFERRABLE" | tk="DELAYED" | tk="DELETE" | tk="DESC" | tk="DESCRIBE" | tk="DISABLE" | tk="DISCONNECT" | tk="DIV" | tk="DML" | tk="DO" | tk="DOMAIN" | tk="DROP" | tk="DUMP" | tk="DUPLICATE" | tk="ELEMENTS" | tk="EMIT" | tk="ENABLE" | tk="END" | tk="ESCAPE" | tk="EXCLUDE" | tk="EXEC" | tk="EXECUTE" | tk="EXPLAIN" | tk="EXPLICIT" | tk="EXTENDED" | tk="EXTRACT" | tk="FALSE" | tk="FILTER" | tk="FIRST" | tk="FLUSH" | tk="FN" | tk="FOLLOWING" | tk="FORMAT" | tk="FULLTEXT" | tk="FUNCTION" | tk="GRANT" | tk="GUARD" | tk="HASH" | tk="HISTORY" | tk="HOPPING" | tk="INCLUDE" | tk="INCREMENT" | tk="INDEX" | tk="INSERT" | tk="INTERLEAVE" | tk="INTERPRET" | tk="INVALIDATE" | tk="ISNULL" | tk="JSON" | tk="KEEP" | tk="KEY" | tk="KEYS" | tk="LAST" | tk="LEADING" | tk="LINK" | tk="LOCAL" | tk="LOCKED" | tk="LOG" | tk="LOOP" | tk="MATCH" | tk="MATCHED" | tk="MATERIALIZED" | tk="MAXVALUE" | tk="MEMBER" | tk="MERGE" | tk="MINVALUE" | tk="MODIFY" | tk="MOVEMENT" | tk="NEXT" | tk="NO" | tk="NOCACHE" | tk="NOKEEP" | tk="NOLOCK" | tk="NOMAXVALUE" | tk="NOMINVALUE" | tk="NOORDER" | tk="NOTHING" | tk="NOTNULL" | tk="NOVALIDATE" | tk="NOWAIT" | tk="NULLS" | tk="OF" | tk="OFF" | tk="OPEN" | tk="OVER" | tk="OVERLAPS" | tk="PARALLEL" | tk="PARENT" | tk="PARTITION" | tk="PATH" | tk="PERCENT" | tk="PLACING" | tk="PRECEDING" | tk="PRECISION" | tk="PRIMARY" | tk="PRIOR" | tk="PURGE" | tk="QUERY" | tk="QUICK" | tk="QUIESCE" | tk="RANGE" | tk="RAW" | tk="READ" | tk="RECURSIVE" | tk="RECYCLEBIN" | tk="REFERENCES" | tk="REFRESH" | tk="REGEXP" | tk="REGISTER" | tk="REMOTE" | tk="RENAME" | tk="REPEATABLE" | tk="REPLACE" | tk="RESET" | tk="RESTART" | tk="RESTRICT" | tk="RESTRICTED" | tk="RESUMABLE" | tk="RESUME" | tk="RETURN" | tk="RLIKE" | tk="ROLLBACK" | tk="ROLLUP" | tk="ROOT" | tk="ROW" | tk="ROWS" | tk="RR" | tk="RS" | tk="SAVEPOINT" | tk="SCHEMA" | tk="SECURE" | tk="SEED" | tk="SEPARATOR" | tk="SEQUENCE" | tk="SESSION" | tk="SETS" | tk="SHARE" | tk="SHOW" | tk="SHUTDOWN" | tk="SIBLINGS" | tk="SIGNED" | tk="SIMILAR" | tk="SIZE" | tk="SKIP" | tk="STORED" | tk="STRING" | tk="STRUCT" | tk="SUSPEND" | tk="SWITCH" | tk="SYNONYM" | tk="SYSTEM" | tk="TABLE" | tk="TABLESPACE" | tk="TEMP" | tk="TEMPORARY" | tk="THEN" | tk="TIMEOUT" | tk="TIMESTAMPTZ" | tk="TIMEZONE" | tk="TO" | tk="TRIGGER" | tk="TRUE" | tk="TRUNCATE" | tk="TUMBLING" | tk="TYPE" | tk="UNLOGGED" | tk="UNQIESCE" | tk="UNSIGNED" | tk="UPDATE" | tk="UPSERT" | tk="UR" | tk="USER" | tk="VALIDATE" | tk="VERBOSE" | tk="VIEW" | tk="VOLATILE" | tk="WAIT" | tk="WITHIN" | tk="WITHOUT" | tk="WORK" | tk="XML" | tk="XMLAGG" | tk="XMLDATA" | tk="XMLSCHEMA" | tk="XMLTEXT" | tk="XSINIL" | tk="YAML" | tk="YES" | tk="ZONE" )
18521852
{ return tk.image; }
18531853
}
18541854

@@ -2442,7 +2442,7 @@ WithItem WithItem() #WithItem:
24422442
Select select;
24432443
}
24442444
{
2445-
[ <K_RECURSIVE> { withItem.setRecursive(true); } ]
2445+
[ LOOKAHEAD(2) <K_RECURSIVE> { withItem.setRecursive(true); } ]
24462446
name=RelObjectName() { withItem.setAlias( new Alias( name, false)); }
24472447
[ "(" selectItems=SelectItemsList() ")" { withItem.setWithItemList(selectItems); } ]
24482448
<K_AS> select = ParenthesedSelect() { withItem.setSelect(select); }
@@ -4552,6 +4552,10 @@ StructType StructType() #StruckType:
45524552
id = RelObjectName() <DOUBLE_COLON> expression = Expression() { arguments.add( new SelectItem( expression, id) ); }
45534553
)*
45544554
<CLOSING_CURLY_BRACKET>
4555+
4556+
(
4557+
LOOKAHEAD(2) "::" <K_STRUCT> "(" parameters = StructParameters() ")"
4558+
)*
45554559
)
45564560

45574561
// don't parse this as an Struct, but rather use an Expressionlist

‎src/site/sphinx/keywords.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,6 @@ The following Keywords are **restricted** in JSQLParser-|JSQLPARSER_VERSION| and
135135
+----------------------+-------------+-----------+
136136
| PUBLIC | Yes | |
137137
+----------------------+-------------+-----------+
138-
| RECURSIVE | Yes | Yes |
139-
+----------------------+-------------+-----------+
140138
| RETURNING | Yes | Yes |
141139
+----------------------+-------------+-----------+
142140
| RIGHT | Yes | Yes |

‎src/test/java/net/sf/jsqlparser/expression/StructTypeTest.java

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,33 @@ void testStructTypeBigQuery() throws JSQLParserException {
2626

2727
@Test
2828
void testStructTypeDuckDB() throws JSQLParserException {
29-
//@todo: check why the white-space after the "{" is needed?!
29+
// @todo: check why the white-space after the "{" is needed?!
3030
String sqlStr = "SELECT { t:'abc',len:5}";
3131
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
3232

3333
sqlStr = "SELECT UNNEST({ t:'abc', len:5 })";
3434
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
35+
36+
sqlStr = "SELECT * from (SELECT UNNEST([{ t:'abc', len:5 }]))";
37+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
38+
39+
sqlStr = "SELECT * from (SELECT UNNEST([{ t:'abc', len:5 }, ('abc', 6) ], recursive => true))";
40+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
41+
}
42+
43+
@Test
44+
void testStructTypeWithArgumentsDuckDB() throws JSQLParserException {
45+
// @todo: check why the white-space after the "{" is needed?!
46+
String sqlStr = "SELECT { t:'abc',len:5}::STRUCT( t VARCHAR, len INTEGER)";
47+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
48+
49+
sqlStr = "SELECT t, len, LPAD(t, len, ' ') as padded from (\n" +
50+
"select Unnest([\n" +
51+
" { t:'abc', len: 5}::STRUCT(t VARCHAR, len INTEGER),\n" +
52+
" { t:'abc', len: 5},\n" +
53+
" ('abc', 2),\n" +
54+
" ('例子', 4)\n" +
55+
"], \"recursive\" => true))";
56+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
3557
}
3658
}

‎src/test/java/net/sf/jsqlparser/statement/select/NestedBracketsPerformanceTest.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,10 @@ public void testRecursiveBracketExpressionIssue1019() {
124124
}
125125

126126
// maxDepth = 10 collides with the Parser Timeout = 6 seconds
127-
// temporarily restrict it to maxDepth = 4 for the moment
128127
// @todo: implement methods to set the Parser Timeout explicitly and on demand
129-
// @todo Investigate performance deterioration since JSQLParser 5.0pre development
130128
@Test
131129
public void testRecursiveBracketExpressionIssue1019_2() throws JSQLParserException {
132-
doIncreaseOfParseTimeTesting("IF(1=1, $1, 2)", "1", 4);
130+
doIncreaseOfParseTimeTesting("IF(1=1, $1, 2)", "1", 8);
133131
}
134132

135133
@Test

0 commit comments

Comments
 (0)