-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support DISCARD statements (#1863)
* feat: support DISCARD statements Adds support for DISCARD ALL|PLANS|SEQUENCES|TEMP|TEMPORARY statements. All but ALL are no-ops. * chore: run code formatter
- Loading branch information
Showing
7 changed files
with
249 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
src/main/java/com/google/cloud/spanner/pgadapter/statements/DiscardStatement.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.google.cloud.spanner.pgadapter.statements; | ||
|
|
||
| import com.google.cloud.spanner.Statement; | ||
| import com.google.cloud.spanner.connection.AbstractStatementParser.ParsedStatement; | ||
| import com.google.cloud.spanner.connection.AbstractStatementParser.StatementType; | ||
| import com.google.cloud.spanner.connection.StatementResult; | ||
| import com.google.cloud.spanner.pgadapter.ConnectionHandler; | ||
| import com.google.cloud.spanner.pgadapter.error.PGExceptionFactory; | ||
| import com.google.cloud.spanner.pgadapter.error.SQLState; | ||
| import com.google.cloud.spanner.pgadapter.metadata.OptionsMetadata; | ||
| import com.google.cloud.spanner.pgadapter.statements.BackendConnection.ConnectionState; | ||
| import com.google.cloud.spanner.pgadapter.statements.BackendConnection.NoResult; | ||
| import com.google.cloud.spanner.pgadapter.statements.DiscardStatement.ParsedDiscardStatement.DiscardType; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.common.util.concurrent.Futures; | ||
| import java.util.List; | ||
| import java.util.concurrent.Future; | ||
|
|
||
| public class DiscardStatement extends IntermediatePortalStatement { | ||
| static final class ParsedDiscardStatement { | ||
| enum DiscardType { | ||
| PLANS, | ||
| SEQUENCES, | ||
| TEMPORARY, | ||
| ALL, | ||
| } | ||
|
|
||
| final DiscardType type; | ||
|
|
||
| private ParsedDiscardStatement(DiscardType type) { | ||
| this.type = type; | ||
| } | ||
| } | ||
|
|
||
| private final ParsedDiscardStatement discardStatement; | ||
|
|
||
| public DiscardStatement( | ||
| ConnectionHandler connectionHandler, | ||
| OptionsMetadata options, | ||
| String name, | ||
| ParsedStatement parsedStatement, | ||
| Statement originalStatement) { | ||
| super( | ||
| name, | ||
| new IntermediatePreparedStatement( | ||
| connectionHandler, | ||
| options, | ||
| name, | ||
| NO_PARAMETER_TYPES, | ||
| parsedStatement, | ||
| originalStatement), | ||
| NO_PARAMS, | ||
| ImmutableList.of(), | ||
| ImmutableList.of()); | ||
| this.discardStatement = parse(originalStatement.getSql()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getCommandTag() { | ||
| return "DISCARD"; | ||
| } | ||
|
|
||
| @Override | ||
| public StatementType getStatementType() { | ||
| return StatementType.CLIENT_SIDE; | ||
| } | ||
|
|
||
| @Override | ||
| public void executeAsync(BackendConnection backendConnection) { | ||
| this.executed = true; | ||
| try { | ||
| switch (discardStatement.type) { | ||
| case ALL: | ||
| if (backendConnection.getConnectionState() == ConnectionState.TRANSACTION) { | ||
| setFutureStatementResult( | ||
| Futures.immediateFailedFuture( | ||
| PGExceptionFactory.newPGException( | ||
| "DISCARD ALL cannot run inside a transaction block", | ||
| SQLState.ActiveSqlTransaction))); | ||
| return; | ||
| } | ||
| connectionHandler.closeAllStatements(); | ||
| break; | ||
| case PLANS: | ||
| case SEQUENCES: | ||
| case TEMPORARY: | ||
| default: | ||
| // The default is no-op as PGAdapter does not support clearing plans, sequences or | ||
| // temporary tables. | ||
| } | ||
| } catch (Exception exception) { | ||
| setFutureStatementResult(Futures.immediateFailedFuture(exception)); | ||
| return; | ||
| } | ||
| setFutureStatementResult(Futures.immediateFuture(new NoResult())); | ||
| } | ||
|
|
||
| @Override | ||
| public Future<StatementResult> describeAsync(BackendConnection backendConnection) { | ||
| // Return null to indicate that this DISCARD statement does not return any | ||
| // RowDescriptionResponse. | ||
| return Futures.immediateFuture(null); | ||
| } | ||
|
|
||
| @Override | ||
| public IntermediatePortalStatement createPortal( | ||
| String name, | ||
| byte[][] parameters, | ||
| List<Short> parameterFormatCodes, | ||
| List<Short> resultFormatCodes) { | ||
| // DISCARD does not support binding any parameters, so we just return the same statement. | ||
| return this; | ||
| } | ||
|
|
||
| static ParsedDiscardStatement parse(String sql) { | ||
| Preconditions.checkNotNull(sql); | ||
|
|
||
| SimpleParser parser = new SimpleParser(sql); | ||
| if (!parser.eatKeyword("discard")) { | ||
| throw PGExceptionFactory.newPGException("not a valid DISCARD statement: " + sql); | ||
| } | ||
| DiscardType type; | ||
| if (parser.eatKeyword("all")) { | ||
| type = DiscardType.ALL; | ||
| } else if (parser.eatKeyword("plans")) { | ||
| type = DiscardType.PLANS; | ||
| } else if (parser.eatKeyword("sequences")) { | ||
| type = DiscardType.SEQUENCES; | ||
| } else if (parser.eatKeyword("temp") || parser.eatKeyword("temporary")) { | ||
| type = DiscardType.TEMPORARY; | ||
| } else { | ||
| throw PGExceptionFactory.newPGException("Invalid DISCARD statement: " + parser.getSql()); | ||
| } | ||
| parser.throwIfHasMoreTokens(); | ||
| return new ParsedDiscardStatement(type); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
src/test/java/com/google/cloud/spanner/pgadapter/statements/DiscardStatementTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.google.cloud.spanner.pgadapter.statements; | ||
|
|
||
| import static com.google.cloud.spanner.pgadapter.statements.DiscardStatement.parse; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertThrows; | ||
|
|
||
| import com.google.cloud.spanner.pgadapter.error.PGException; | ||
| import com.google.cloud.spanner.pgadapter.statements.DiscardStatement.ParsedDiscardStatement.DiscardType; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class DiscardStatementTest { | ||
|
|
||
| @Test | ||
| public void testParse() { | ||
| assertEquals(DiscardType.ALL, parse("discard all").type); | ||
| assertEquals(DiscardType.PLANS, parse("discard plans").type); | ||
| assertEquals(DiscardType.SEQUENCES, parse("discard sequences").type); | ||
| assertEquals(DiscardType.TEMPORARY, parse("discard temp").type); | ||
| assertEquals(DiscardType.TEMPORARY, parse("discard temporary").type); | ||
| assertEquals(DiscardType.TEMPORARY, parse("discard/*comment*/temporary").type); | ||
|
|
||
| assertThrows(PGException.class, () -> parse("discard foo")); | ||
| assertThrows(PGException.class, () -> parse("discard")); | ||
| assertThrows(PGException.class, () -> parse("deallocate all foo")); | ||
| assertThrows(PGException.class, () -> parse("discard temp all")); | ||
| } | ||
| } |