Skip to content

Commit 1742a36

Browse files
minleejaeminleejae
committed
Structure SQL Server routine operations and table return types
1 parent eddb1fb commit 1742a36

10 files changed

Lines changed: 502 additions & 21 deletions

File tree

‎src/main/java/net/sf/jsqlparser/parser/feature/Feature.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,8 @@ public enum Feature {
660660
* @see CreateFunctionalStatement
661661
*/
662662
functionalStatement,
663+
664+
alterFunction, alterProcedure, createOrAlterRoutine,
663665
/**
664666
* SQL block starting with "BEGIN" and ends with "END" statement is allowed
665667
*

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

Lines changed: 76 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
import java.util.Collections;
1515
import java.util.List;
1616
import java.util.Optional;
17+
import java.util.function.Consumer;
18+
import net.sf.jsqlparser.statement.create.function.FunctionReturnType;
19+
import net.sf.jsqlparser.statement.create.table.TableElement;
1720

1821
/**
1922
* A base for the declaration of function like statements
@@ -23,6 +26,39 @@ public abstract class CreateFunctionalStatement implements Statement {
2326
private String kind;
2427
private boolean orReplace = false;
2528

29+
public enum Operation {
30+
CREATE, ALTER, CREATE_OR_ALTER
31+
}
32+
33+
private Operation operation = Operation.CREATE;
34+
private FunctionReturnType returnType;
35+
private List<String> routineBodyParts;
36+
37+
public Operation getOperation() {
38+
return operation;
39+
}
40+
41+
public void setOperation(Operation operation) {
42+
this.operation = operation;
43+
}
44+
45+
public FunctionReturnType getReturnType() {
46+
return returnType;
47+
}
48+
49+
public void setReturnType(FunctionReturnType returnType) {
50+
this.returnType = returnType;
51+
}
52+
53+
public List<String> getRoutineBodyParts() {
54+
return routineBodyParts;
55+
}
56+
57+
public void setRoutineBodyParts(List<String> parts) {
58+
routineBodyParts = parts;
59+
}
60+
61+
2662
private List<String> functionDeclarationParts;
2763

2864
protected CreateFunctionalStatement(String kind) {
@@ -41,7 +77,9 @@ protected CreateFunctionalStatement(boolean orReplace, String kind,
4177
}
4278

4379
/**
44-
* @return the declaration parts after {@code CREATE FUNCTION|PROCEDURE}
80+
* @return the declaration parts after {@code CREATE FUNCTION|PROCEDURE}. For a SQL Server
81+
* function with a structured {@link #getReturnType()}, these are the name and parameter
82+
* tokens before RETURNS; {@link #getRoutineBodyParts()} holds the remaining tokens.
4583
*/
4684
public List<String> getFunctionDeclarationParts() {
4785
return functionDeclarationParts;
@@ -66,22 +104,43 @@ public void setOrReplace(boolean orReplace) {
66104
* @return a whitespace appended String with the declaration parts with some minimal formatting.
67105
*/
68106
public String formatDeclaration() {
69-
StringBuilder declaration = new StringBuilder();
70-
int currIndex = 0;
71-
while (currIndex < functionDeclarationParts.size()) {
72-
String token = functionDeclarationParts.get(currIndex);
73-
declaration.append(token);
74-
// if the next token is a ; don't put a space
75-
if (currIndex + 1 < functionDeclarationParts.size()) {
76-
// peek ahead just to format nicely
77-
String nextToken = functionDeclarationParts.get(currIndex + 1);
78-
if (!nextToken.equals(";")) {
79-
declaration.append(" ");
80-
}
107+
StringBuilder builder = new StringBuilder();
108+
return appendDeclarationTo(builder, builder::append).toString();
109+
}
110+
111+
private StringBuilder appendDeclarationTo(StringBuilder builder,
112+
Consumer<TableElement> printer) {
113+
appendTokens(builder, functionDeclarationParts);
114+
if (returnType != null) {
115+
builder.append(' ');
116+
returnType.appendTo(builder, printer);
117+
if (routineBodyParts != null && !routineBodyParts.isEmpty()) {
118+
builder.append(' ');
119+
appendTokens(builder, routineBodyParts);
81120
}
82-
currIndex++;
83121
}
84-
return declaration.toString();
122+
return builder;
123+
}
124+
125+
private static void appendTokens(StringBuilder builder, List<String> tokens) {
126+
if (tokens == null) {
127+
return;
128+
}
129+
for (int i = 0; i < tokens.size(); i++) {
130+
if (i > 0 && !";".equals(tokens.get(i))) {
131+
builder.append(' ');
132+
}
133+
builder.append(tokens.get(i));
134+
}
135+
}
136+
137+
public StringBuilder appendTo(StringBuilder builder, Consumer<TableElement> printer) {
138+
builder.append(operation.name().replace('_', ' ')).append(' ');
139+
if (orReplace && operation == Operation.CREATE) {
140+
builder.append("OR REPLACE ");
141+
}
142+
builder.append(kind).append(' ');
143+
return appendDeclarationTo(builder, printer);
85144
}
86145

87146
@Override
@@ -91,9 +150,8 @@ public <T, S> T accept(StatementVisitor<T> statementVisitor, S context) {
91150

92151
@Override
93152
public String toString() {
94-
return "CREATE "
95-
+ (orReplace ? "OR REPLACE " : "")
96-
+ kind + " " + formatDeclaration();
153+
StringBuilder builder = new StringBuilder();
154+
return appendTo(builder, builder::append).toString();
97155
}
98156

99157
public CreateFunctionalStatement withFunctionDeclarationParts(

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,13 @@ public <S> T visit(AlterSequence alterSequence, S context) {
548548

549549
@Override
550550
public <S> T visit(CreateFunctionalStatement createFunctionalStatement, S context) {
551+
if (createFunctionalStatement.getReturnType() != null
552+
&& createFunctionalStatement.getReturnType().getTableElements() != null) {
553+
createFunctionalStatement.getReturnType().getTableElements()
554+
.forEach(element -> TableDefinitionTraversal.visit(element,
555+
expression -> expression.accept(expressionVisitor, context),
556+
table -> table.accept(fromItemVisitor, context)));
557+
}
551558
return null;
552559
}
553560

‎src/main/java/net/sf/jsqlparser/statement/create/function/FunctionReturnType.java‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
/*-
2+
* #%L
3+
* JSQLParser library
4+
* %%
5+
* Copyright (C) 2004 - 2026 JSQLParser
6+
* %%
7+
* Dual licensed under GNU LGPL 2.1 or Apache License 2.0
8+
* #L%
9+
*/
10+
package net.sf.jsqlparser.statement.create.function;
11+
12+
import java.io.Serializable;
13+
import java.util.ArrayList;
14+
import java.util.List;
15+
import java.util.function.Consumer;
16+
import net.sf.jsqlparser.statement.create.table.ColDataType;
17+
import net.sf.jsqlparser.statement.create.table.TableElement;
18+
19+
/** A SQL Server scalar, inline table or declared table return type. */
20+
public class FunctionReturnType implements Serializable {
21+
private ColDataType dataType;
22+
private boolean table;
23+
private String tableVariable;
24+
private List<TableElement> tableElements;
25+
26+
public ColDataType getDataType() {
27+
return dataType;
28+
}
29+
30+
public void setDataType(ColDataType dataType) {
31+
this.dataType = dataType;
32+
}
33+
34+
public boolean isTable() {
35+
return table;
36+
}
37+
38+
public void setTable(boolean table) {
39+
this.table = table;
40+
}
41+
42+
public String getTableVariable() {
43+
return tableVariable;
44+
}
45+
46+
public void setTableVariable(String variable) {
47+
this.tableVariable = variable;
48+
}
49+
50+
/** Null for an inline return table; otherwise columns and constraints in source order. */
51+
public List<TableElement> getTableElements() {
52+
return tableElements;
53+
}
54+
55+
public void setTableElements(List<TableElement> elements) {
56+
this.tableElements = elements;
57+
}
58+
59+
public <T extends TableElement> List<T> getTableElements(Class<T> type) {
60+
List<T> result = new ArrayList<>();
61+
if (tableElements != null) {
62+
for (TableElement element : tableElements) {
63+
if (type.isInstance(element)) {
64+
result.add(type.cast(element));
65+
}
66+
}
67+
}
68+
return result;
69+
}
70+
71+
public StringBuilder appendTo(StringBuilder builder, Consumer<TableElement> printer) {
72+
builder.append("RETURNS ");
73+
if (!table) {
74+
return builder.append(dataType);
75+
}
76+
if (tableVariable != null) {
77+
builder.append(tableVariable).append(' ');
78+
}
79+
builder.append("TABLE");
80+
if (tableElements != null) {
81+
builder.append(" (");
82+
for (int i = 0; i < tableElements.size(); i++) {
83+
if (i > 0) {
84+
builder.append(", ");
85+
}
86+
printer.accept(tableElements.get(i));
87+
}
88+
builder.append(')');
89+
}
90+
return builder;
91+
}
92+
93+
@Override
94+
public String toString() {
95+
StringBuilder builder = new StringBuilder();
96+
return appendTo(builder, builder::append).toString();
97+
}
98+
}

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,8 @@ public <S> StringBuilder visit(AlterSequence alterSequence, S context) {
491491

492492
@Override
493493
public <S> StringBuilder visit(CreateFunctionalStatement createFunctionalStatement, S context) {
494-
builder.append(createFunctionalStatement.toString());
494+
createFunctionalStatement.appendTo(builder,
495+
new TableElementDeParser(builder, expressionDeParser)::deParse);
495496
return builder;
496497
}
497498

‎src/main/java/net/sf/jsqlparser/util/validation/feature/SqlServerVersion.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ public enum SqlServerVersion implements Version {
9696
Feature.createTableFromSelect, // https://docs.microsoft.com/en-us/sql/t-sql/statements/create-function-transact-sql?view=sql-server-ver15
9797
// https://docs.microsoft.com/en-us/sql/t-sql/statements/create-procedure-transact-sql?view=sql-server-ver15
9898
Feature.functionalStatement, Feature.createProcedure, Feature.createFunction,
99+
Feature.alterFunction, Feature.alterProcedure, Feature.createOrAlterRoutine,
99100
Feature.block,
100101
Feature.declare,
101102
Feature.tableVariable, // https://docs.microsoft.com/en-us/sql/t-sql/statements/create-schema-transact-sql?view=sql-server-ver15

‎src/main/java/net/sf/jsqlparser/util/validation/validator/StatementValidator.java‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -378,10 +378,27 @@ public <S> Void visit(AlterSequence alterSequence, S context) {
378378
@Override
379379
public <S> Void visit(CreateFunctionalStatement createFunctionalStatement, S context) {
380380
validateFeature(Feature.functionalStatement);
381+
if (createFunctionalStatement
382+
.getOperation() == CreateFunctionalStatement.Operation.CREATE_OR_ALTER) {
383+
validateFeature(Feature.createOrAlterRoutine);
384+
}
385+
if (createFunctionalStatement.getReturnType() != null
386+
&& createFunctionalStatement.getReturnType().getTableElements() != null) {
387+
createFunctionalStatement.getReturnType().getTableElements()
388+
.forEach(element -> net.sf.jsqlparser.util.TableDefinitionTraversal.visit(
389+
element,
390+
this::validateOptionalExpression, this::validateOptionalFromItem));
391+
}
381392
if (createFunctionalStatement instanceof CreateFunction) {
382-
validateFeature(Feature.createFunction);
393+
validateFeature(createFunctionalStatement
394+
.getOperation() == CreateFunctionalStatement.Operation.ALTER
395+
? Feature.alterFunction
396+
: Feature.createFunction);
383397
} else if (createFunctionalStatement instanceof CreateProcedure) {
384-
validateFeature(Feature.createProcedure);
398+
validateFeature(createFunctionalStatement
399+
.getOperation() == CreateFunctionalStatement.Operation.ALTER
400+
? Feature.alterProcedure
401+
: Feature.createProcedure);
385402
}
386403
return null;
387404
}

0 commit comments

Comments
 (0)