Skip to content

Commit ad132ee

Browse files
manticore-projectsmanticore-projects
committed
feat: add DuckDB SUMMARIZE table | select
- fixes #2064 Signed-off-by: Andreas Reichel <[email protected]> Signed-off-by: manticore-projects <[email protected]>
1 parent 6a9b58f commit ad132ee

File tree

6 files changed

+89
-28
lines changed

6 files changed

+89
-28
lines changed

‎src/main/java/net/sf/jsqlparser/statement/ExplainStatement.java‎

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
import java.io.Serializable;
1313
import java.util.LinkedHashMap;
14+
import java.util.List;
1415
import java.util.stream.Collectors;
1516

1617
import net.sf.jsqlparser.schema.Table;
@@ -20,17 +21,40 @@
2021
* An {@code EXPLAIN} statement
2122
*/
2223
public class ExplainStatement implements Statement {
23-
24+
private String keyword;
2425
private Select select;
2526
private LinkedHashMap<OptionType, Option> options;
2627
private Table table;
2728

29+
public ExplainStatement(String keyword) {
30+
this.keyword = keyword;
31+
}
32+
2833
public ExplainStatement() {
29-
// empty constructor
34+
this("EXPLAIN");
3035
}
3136

32-
public ExplainStatement(Select select) {
37+
public ExplainStatement(String keyword, Table table) {
38+
this.keyword = keyword;
39+
this.table = table;
40+
this.select = null;
41+
}
42+
43+
public ExplainStatement(String keyword, Select select, List<Option> optionList) {
44+
this.keyword = keyword;
3345
this.select = select;
46+
this.table = null;
47+
48+
if (optionList != null && !optionList.isEmpty()) {
49+
options = new LinkedHashMap<>();
50+
for (Option o : optionList) {
51+
options.put(o.getType(), o);
52+
}
53+
}
54+
}
55+
56+
public ExplainStatement(Select select) {
57+
this("EXPLAIN", select, null);
3458
}
3559

3660
public Table getTable() {
@@ -76,25 +100,34 @@ public Option getOption(OptionType optionType) {
76100
return options.get(optionType);
77101
}
78102

103+
public String getKeyword() {
104+
return keyword;
105+
}
106+
107+
public ExplainStatement setKeyword(String keyword) {
108+
this.keyword = keyword;
109+
return this;
110+
}
111+
79112
@Override
80113
public String toString() {
81-
StringBuilder statementBuilder = new StringBuilder("EXPLAIN");
114+
StringBuilder builder = new StringBuilder(keyword);
82115
if (table != null) {
83-
statementBuilder.append(" ").append(table);
116+
builder.append(" ").append(table);
84117
} else {
85118
if (options != null) {
86-
statementBuilder.append(" ");
87-
statementBuilder.append(options.values().stream().map(Option::formatOption)
119+
builder.append(" ");
120+
builder.append(options.values().stream().map(Option::formatOption)
88121
.collect(Collectors.joining(" ")));
89122
}
90123

91-
statementBuilder.append(" ");
124+
builder.append(" ");
92125
if (select != null) {
93-
statementBuilder.append(select.toString());
126+
select.appendTo(builder);
94127
}
95128
}
96129

97-
return statementBuilder.toString();
130+
return builder.toString();
98131
}
99132

100133
@Override

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ public <S> StringBuilder visit(DescribeStatement describe, S context) {
381381

382382
@Override
383383
public <S> StringBuilder visit(ExplainStatement explainStatement, S context) {
384-
buffer.append("EXPLAIN ");
384+
buffer.append(explainStatement.getKeyword()).append(" ");
385385
if (explainStatement.getTable() != null) {
386386
buffer.append(explainStatement.getTable());
387387
} else if (explainStatement.getOptions() != null) {

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

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
441441
| <K_STORED: "STORED">
442442
| <K_STRING: "STRING">
443443
| <K_STRUCT: "STRUCT">
444+
| <K_SUMMARIZE: "SUMMARIZE">
444445
| <K_SUSPEND:"SUSPEND">
445446
| <K_SWITCH: "SWITCH">
446447
| <K_SYNONYM:"SYNONYM">
@@ -1184,33 +1185,28 @@ DescribeStatement Describe(): {
11841185
}
11851186
}
11861187

1187-
ExplainStatement Explain(): {
1188+
ExplainStatement Explain():
1189+
{
1190+
Token tk;
11881191
Select select;
1189-
Table table = null;
1190-
List<ExplainStatement.Option> options = null;
1191-
ExplainStatement es = new ExplainStatement();
1192-
} {
1193-
<K_EXPLAIN>
1192+
Table table;
1193+
List<ExplainStatement.Option> options;
1194+
}
1195+
{
1196+
( tk=<K_EXPLAIN> | tk = <K_SUMMARIZE> )
11941197
(
11951198
LOOKAHEAD(3)(
11961199
options=ExplainStatementOptions()
11971200
select = Select( )
11981201
{
1199-
es.setStatement(select);
1200-
if (options != null && !options.isEmpty()) {
1201-
for(ExplainStatement.Option o : options) {
1202-
es.addOption(o);
1203-
}
1204-
}
1202+
return new ExplainStatement(tk.image, select, options);
12051203
}
12061204
)
12071205
|
12081206
(
1209-
table=Table( ) { es.setTable(table); }
1207+
table=Table( ) { return new ExplainStatement(tk.image, table); }
12101208
)
1211-
12121209
)
1213-
{ return es; }
12141210
}
12151211

12161212
/**
@@ -1994,7 +1990,7 @@ String RelObjectNameWithoutValue() :
19941990
{ Token tk = null; }
19951991
{
19961992
( tk=<DATA_TYPE> | 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> | tk=<K_TEXT_LITERAL>
1997-
| tk="ACTION" | tk="ACTIVE" | tk="ADD" | tk="ADVANCE" | tk="ADVISE" | tk="AGAINST" | tk="ALGORITHM" | tk="ALTER" | tk="ANALYZE" | tk="APPLY" | tk="APPROXIMATE" | tk="ARCHIVE" | tk="ARRAY" | tk="ASC" | tk="AT" | tk="AUTHORIZATION" | tk="AUTO" | tk="BASE64" | 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="DBA_RECYCLEBIN" | tk="DDL" | tk="DECLARE" | 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="GROUP_CONCAT" | tk="GUARD" | tk="HASH" | tk="HIGH_PRIORITY" | tk="HISTORY" | tk="HOPPING" | tk="INCLUDE" | tk="INCLUDE_NULL_VALUES" | tk="INCREMENT" | tk="INDEX" | tk="INSERT" | tk="INTERLEAVE" | tk="INTERPRET" | tk="INVALIDATE" | tk="ISNULL" | tk="JSON" | tk="JSON_ARRAY" | tk="JSON_ARRAYAGG" | tk="JSON_OBJECT" | tk="JSON_OBJECTAGG" | tk="KEEP" | tk="KEY" | tk="KEYS" | tk="LAST" | tk="LEADING" | tk="LINK" | tk="LOCAL" | tk="LOCKED" | tk="LOG" | tk="LONGTEXT" | tk="LOOP" | tk="LOW_PRIORITY" | tk="MATCH" | tk="MATCHED" | tk="MATERIALIZED" | tk="MAX" | tk="MAXVALUE" | tk="MEDIUMTEXT" | tk="MEMBER" | tk="MERGE" | tk="MIN" | 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="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="REGEXP_LIKE" | tk="REGISTER" | tk="REMOTE" | tk="RENAME" | tk="REPEATABLE" | tk="REPLACE" | tk="RESET" | tk="RESPECT" | 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="SAFE_CAST" | 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="TEXT" | tk="THEN" | tk="TIMEOUT" | tk="TIMESTAMPTZ" | tk="TIMEZONE" | tk="TINYTEXT" | tk="TO" | tk="TRIGGER" | tk="TRUE" | tk="TRUNCATE" | tk="TRY_CAST" | 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="WITHOUT_ARRAY_WRAPPER" | tk="WORK" | tk="XML" | tk="XMLAGG" | tk="XMLDATA" | tk="XMLSCHEMA" | tk="XMLTEXT" | tk="XSINIL" | tk="YAML" | tk="YES" | tk="ZONE" )
1993+
| tk="ACTION" | tk="ACTIVE" | tk="ADD" | tk="ADVANCE" | tk="ADVISE" | tk="AGAINST" | tk="ALGORITHM" | tk="ALTER" | tk="ANALYZE" | tk="APPLY" | tk="APPROXIMATE" | tk="ARCHIVE" | tk="ARRAY" | tk="ASC" | tk="AT" | tk="AUTHORIZATION" | tk="AUTO" | tk="BASE64" | 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="DBA_RECYCLEBIN" | tk="DDL" | tk="DECLARE" | 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="GROUP_CONCAT" | tk="GUARD" | tk="HASH" | tk="HIGH_PRIORITY" | tk="HISTORY" | tk="HOPPING" | tk="INCLUDE" | tk="INCLUDE_NULL_VALUES" | tk="INCREMENT" | tk="INDEX" | tk="INSERT" | tk="INTERLEAVE" | tk="INTERPRET" | tk="INVALIDATE" | tk="ISNULL" | tk="JSON" | tk="JSON_ARRAY" | tk="JSON_ARRAYAGG" | tk="JSON_OBJECT" | tk="JSON_OBJECTAGG" | tk="KEEP" | tk="KEY" | tk="KEYS" | tk="LAST" | tk="LEADING" | tk="LINK" | tk="LOCAL" | tk="LOCKED" | tk="LOG" | tk="LONGTEXT" | tk="LOOP" | tk="LOW_PRIORITY" | tk="MATCH" | tk="MATCHED" | tk="MATERIALIZED" | tk="MAX" | tk="MAXVALUE" | tk="MEDIUMTEXT" | tk="MEMBER" | tk="MERGE" | tk="MIN" | 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="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="REGEXP_LIKE" | tk="REGISTER" | tk="REMOTE" | tk="RENAME" | tk="REPEATABLE" | tk="REPLACE" | tk="RESET" | tk="RESPECT" | 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="SAFE_CAST" | 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="SUMMARIZE" | tk="SUSPEND" | tk="SWITCH" | tk="SYNONYM" | tk="SYSTEM" | tk="TABLE" | tk="TABLESPACE" | tk="TEMP" | tk="TEMPORARY" | tk="TEXT" | tk="THEN" | tk="TIMEOUT" | tk="TIMESTAMPTZ" | tk="TIMEZONE" | tk="TINYTEXT" | tk="TO" | tk="TRIGGER" | tk="TRUE" | tk="TRUNCATE" | tk="TRY_CAST" | 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="WITHOUT_ARRAY_WRAPPER" | tk="WORK" | tk="XML" | tk="XMLAGG" | tk="XMLDATA" | tk="XMLSCHEMA" | tk="XMLTEXT" | tk="XSINIL" | tk="YAML" | tk="YES" | tk="ZONE" )
19981994
{ return tk.image; }
19991995
}
20001996

‎src/site/sphinx/keywords.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The following Keywords are **restricted** in JSQLParser-|JSQLPARSER_VERSION| and
3737
+----------------------+-------------+-----------+
3838
| CURRENT | Yes | Yes |
3939
+----------------------+-------------+-----------+
40-
| DEFAULT | Yes | |
40+
| DEFAULT | Yes | |
4141
+----------------------+-------------+-----------+
4242
| DISTINCT | Yes | Yes |
4343
+----------------------+-------------+-----------+

‎src/test/java/net/sf/jsqlparser/statement/ExplainStatementTest.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package net.sf.jsqlparser.statement;
2+
3+
import net.sf.jsqlparser.JSQLParserException;
4+
import net.sf.jsqlparser.test.TestUtils;
5+
import org.junit.jupiter.api.Test;
6+
7+
class ExplainStatementTest {
8+
9+
@Test
10+
void testDuckDBSummarizeTable() throws JSQLParserException {
11+
String sqlStr = "SUMMARIZE cfe.test;";
12+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
13+
}
14+
15+
@Test
16+
void testDuckDBSummarizeSelect() throws JSQLParserException {
17+
String sqlStr = "SUMMARIZE SELECT * FROM cfe.test;";
18+
TestUtils.assertSqlCanBeParsedAndDeparsed(sqlStr, true);
19+
}
20+
}

‎src/test/java/net/sf/jsqlparser/util/TablesNamesFinderTest.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,5 +573,17 @@ void testAlterTableIssue2062() throws JSQLParserException {
573573
tables = TablesNamesFinder.findTables(sqlStr);
574574
assertThat(tables).containsExactlyInAnyOrder("the_cool_db.the_table");
575575
}
576+
577+
@Test
578+
void testInsertTableIssue() throws JSQLParserException {
579+
String sqlStr = "INSERT INTO the_cool_db.the_table\n"
580+
+ " VALUES ( 'something' ) \n"
581+
+ ";";
582+
Set<String> tables = TablesNamesFinder.findTablesOrOtherSources(sqlStr);
583+
assertThat(tables).containsExactlyInAnyOrder("the_cool_db.the_table");
584+
585+
tables = TablesNamesFinder.findTables(sqlStr);
586+
assertThat(tables).containsExactlyInAnyOrder("the_cool_db.the_table");
587+
}
576588
}
577589

0 commit comments

Comments
 (0)