Skip to content

Commit 93d8c14

Browse files
olavloiteolavloite
authored
feat: support (ignore) show and set search_path (#288)
* feat: support show search_path * fix: only include public in search path * feat: add support for set search_path * feat: add support for set search_path * fix: remove special handling of UNKNOWN We can safely remove the special handling of UNKNOWN statements, as the case where there is no command tag is already handled at the beginning of the method. * docs: add todo to remove later
1 parent ae1f2f3 commit 93d8c14

File tree

8 files changed

+231
-12
lines changed

8 files changed

+231
-12
lines changed

‎src/main/java/com/google/cloud/spanner/pgadapter/statements/BackendConnection.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ public static final class NoResult implements StatementResult {
806806
this.commandTag = null;
807807
}
808808

809-
private NoResult(String commandTag) {
809+
public NoResult(String commandTag) {
810810
this.commandTag = commandTag;
811811
}
812812

‎src/main/java/com/google/cloud/spanner/pgadapter/statements/local/SetSearchPathStatement.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package com.google.cloud.spanner.pgadapter.statements.local;
16+
17+
import com.google.api.core.InternalApi;
18+
import com.google.cloud.spanner.connection.StatementResult;
19+
import com.google.cloud.spanner.pgadapter.statements.BackendConnection;
20+
import com.google.cloud.spanner.pgadapter.statements.BackendConnection.NoResult;
21+
22+
/**
23+
* A no-op SET search_path implementation. This should be removed once support has been added to the
24+
* Connection API.
25+
*/
26+
// TODO: Remove this once search_path support has been added to the Connection API.
27+
@InternalApi
28+
public class SetSearchPathStatement implements LocalStatement {
29+
public static final SetSearchPathStatement INSTANCE = new SetSearchPathStatement();
30+
31+
private SetSearchPathStatement() {}
32+
33+
@Override
34+
public String[] getSql() {
35+
return new String[] {
36+
"set search_path to public",
37+
"SET search_path TO public",
38+
"SET SEARCH_PATH TO public",
39+
"set search_path to \"public\"",
40+
"SET search_path TO \"public\"",
41+
"SET SEARCH_PATH TO \"public\"",
42+
"set search_path to \"$user\", public",
43+
"SET search_path TO \"$user\", public",
44+
"SET SEARCH_PATH TO \"$user\", public",
45+
"set search_path to \"$user\", \"public\"",
46+
"SET search_path TO \"$user\", \"public\"",
47+
"SET SEARCH_PATH TO \"$user\", \"public\"",
48+
// Some tools prepend the current search_path with 'public' without properly checking whether
49+
// 'public' is already part of the existing search path.
50+
"set search_path to public, public",
51+
"SET search_path TO public, public",
52+
"SET SEARCH_PATH TO public, public",
53+
"set search_path to public, \"public\"",
54+
"SET search_path TO public, \"public\"",
55+
"SET SEARCH_PATH TO public, \"public\"",
56+
"set search_path to public, \"$user\", public",
57+
"SET search_path TO public, \"$user\", public",
58+
"SET SEARCH_PATH TO public, \"$user\", public",
59+
"set search_path to public, \"$user\", \"public\"",
60+
"SET search_path TO public, \"$user\", \"public\"",
61+
"SET SEARCH_PATH TO public, \"$user\", \"public\"",
62+
};
63+
}
64+
65+
@Override
66+
public StatementResult execute(BackendConnection backendConnection) {
67+
return new NoResult("SET");
68+
}
69+
}

‎src/main/java/com/google/cloud/spanner/pgadapter/statements/local/ShowSearchPathStatement.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package com.google.cloud.spanner.pgadapter.statements.local;
16+
17+
import com.google.api.core.InternalApi;
18+
import com.google.cloud.spanner.ResultSet;
19+
import com.google.cloud.spanner.ResultSets;
20+
import com.google.cloud.spanner.Struct;
21+
import com.google.cloud.spanner.Type;
22+
import com.google.cloud.spanner.Type.StructField;
23+
import com.google.cloud.spanner.connection.StatementResult;
24+
import com.google.cloud.spanner.pgadapter.statements.BackendConnection;
25+
import com.google.cloud.spanner.pgadapter.statements.BackendConnection.QueryResult;
26+
import com.google.common.collect.ImmutableList;
27+
28+
@InternalApi
29+
public class ShowSearchPathStatement implements LocalStatement {
30+
public static final ShowSearchPathStatement INSTANCE = new ShowSearchPathStatement();
31+
32+
private ShowSearchPathStatement() {}
33+
34+
@Override
35+
public String[] getSql() {
36+
return new String[] {
37+
"show search_path", "SHOW search_path", "SHOW SEARCH_PATH",
38+
};
39+
}
40+
41+
@Override
42+
public StatementResult execute(BackendConnection backendConnection) {
43+
ResultSet resultSet =
44+
ResultSets.forRows(
45+
Type.struct(StructField.of("search_path", Type.string())),
46+
ImmutableList.of(
47+
Struct.newBuilder()
48+
.set("search_path")
49+
.to(backendConnection.getCurrentSchema())
50+
.build()));
51+
return new QueryResult(resultSet);
52+
}
53+
}

‎src/main/java/com/google/cloud/spanner/pgadapter/utils/ClientAutoDetector.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
import com.google.cloud.spanner.pgadapter.statements.local.SelectCurrentCatalogStatement;
2222
import com.google.cloud.spanner.pgadapter.statements.local.SelectCurrentDatabaseStatement;
2323
import com.google.cloud.spanner.pgadapter.statements.local.SelectCurrentSchemaStatement;
24+
import com.google.cloud.spanner.pgadapter.statements.local.SetSearchPathStatement;
25+
import com.google.cloud.spanner.pgadapter.statements.local.ShowSearchPathStatement;
2426
import com.google.cloud.spanner.pgadapter.statements.local.ShowServerVersionStatement;
2527
import com.google.common.collect.ImmutableList;
2628
import java.util.List;
@@ -39,7 +41,9 @@ public class ClientAutoDetector {
3941
SelectCurrentSchemaStatement.INSTANCE,
4042
SelectCurrentDatabaseStatement.INSTANCE,
4143
SelectCurrentCatalogStatement.INSTANCE,
42-
ShowServerVersionStatement.INSTANCE);
44+
ShowSearchPathStatement.INSTANCE,
45+
ShowServerVersionStatement.INSTANCE,
46+
SetSearchPathStatement.INSTANCE);
4347

4448
public enum WellKnownClient {
4549
PSQL {

‎src/main/java/com/google/cloud/spanner/pgadapter/wireprotocol/ControlMessage.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,7 @@ public void sendSpannerResult(IntermediateStatement statement, QueryMode mode, l
250250
switch (statement.getStatementType()) {
251251
case DDL:
252252
case CLIENT_SIDE:
253+
case UNKNOWN:
253254
new CommandCompleteResponse(this.outputStream, command).send(false);
254255
break;
255256
case QUERY:
@@ -270,7 +271,6 @@ public void sendSpannerResult(IntermediateStatement statement, QueryMode mode, l
270271
command += ("INSERT".equals(command) ? " 0 " : " ") + statement.getUpdateCount();
271272
new CommandCompleteResponse(this.outputStream, command).send(false);
272273
break;
273-
case UNKNOWN:
274274
default:
275275
throw new IllegalStateException("Unknown statement type: " + statement.getStatement());
276276
}

‎src/test/java/com/google/cloud/spanner/pgadapter/ControlMessageTest.java‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
package com.google.cloud.spanner.pgadapter;
1616

1717
import static org.junit.Assert.assertEquals;
18-
import static org.junit.Assert.assertThrows;
1918
import static org.mockito.Mockito.mock;
2019
import static org.mockito.Mockito.when;
2120

@@ -105,19 +104,34 @@ public void testInsertResult() throws Exception {
105104
}
106105

107106
@Test
108-
public void testUnknownStatementTypeThrowsError() {
107+
public void testUnknownStatementTypeDoesNotThrowError() throws Exception {
108+
ByteArrayOutputStream buffer = new ByteArrayOutputStream();
109+
DataOutputStream outputStream = new DataOutputStream(buffer);
110+
DataInputStream inputStream =
111+
new DataInputStream(
112+
new ByteArrayInputStream(new byte[] {(byte) QUERY_IDENTIFIER, 0, 0, 0, 5, 0}));
113+
114+
when(connectionMetadata.peekInputStream()).thenReturn(inputStream);
115+
when(connectionMetadata.peekOutputStream()).thenReturn(outputStream);
109116
when(connectionHandler.getConnectionMetadata()).thenReturn(connectionMetadata);
110117
ExecuteMessage executeMessage =
111118
new ExecuteMessage(connectionHandler, ManuallyCreatedToken.MANUALLY_CREATED_TOKEN);
112119
IntermediateStatement intermediateStatement = mock(IntermediateStatement.class);
113-
when(intermediateStatement.getCommandTag()).thenReturn("PARSE");
120+
when(intermediateStatement.getCommandTag()).thenReturn("parse");
114121
when(intermediateStatement.getStatementType()).thenReturn(StatementType.UNKNOWN);
115-
when(intermediateStatement.getStatement()).thenReturn("parse foo from bar");
116122

117-
IllegalStateException exception =
118-
assertThrows(
119-
IllegalStateException.class,
120-
() -> executeMessage.sendSpannerResult(intermediateStatement, QueryMode.SIMPLE, 0L));
121-
assertEquals("Unknown statement type: parse foo from bar", exception.getMessage());
123+
executeMessage.sendSpannerResult(intermediateStatement, QueryMode.SIMPLE, 0L);
124+
125+
DataInputStream outputReader =
126+
new DataInputStream(new ByteArrayInputStream(buffer.toByteArray()));
127+
// identifier
128+
outputReader.readByte();
129+
// length
130+
outputReader.readInt();
131+
final String resultMessage = "parse";
132+
int numOfBytes = resultMessage.getBytes(UTF8).length;
133+
byte[] bytes = new byte[numOfBytes];
134+
assertEquals(numOfBytes, outputReader.read(bytes, 0, numOfBytes));
135+
assertEquals(resultMessage, new String(bytes, UTF8));
122136
}
123137
}

‎src/test/java/com/google/cloud/spanner/pgadapter/JdbcMockServerTest.java‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,38 @@ public void testSelectCurrentCatalog() throws SQLException {
183183
assertEquals(0, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
184184
}
185185

186+
@Test
187+
public void testShowSearchPath() throws SQLException {
188+
String sql = "show search_path";
189+
190+
try (Connection connection = DriverManager.getConnection(createUrl())) {
191+
try (ResultSet resultSet = connection.createStatement().executeQuery(sql)) {
192+
assertTrue(resultSet.next());
193+
assertEquals("public", resultSet.getString("search_path"));
194+
assertFalse(resultSet.next());
195+
}
196+
}
197+
198+
// The statement is handled locally and not sent to Cloud Spanner.
199+
assertEquals(0, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
200+
}
201+
202+
@Test
203+
public void testSetSearchPath() throws SQLException {
204+
String sql = "set search_path to public";
205+
206+
try (Connection connection = DriverManager.getConnection(createUrl())) {
207+
try (java.sql.Statement statement = connection.createStatement()) {
208+
assertFalse(statement.execute(sql));
209+
assertEquals(0, statement.getUpdateCount());
210+
assertFalse(statement.getMoreResults());
211+
}
212+
}
213+
214+
// The statement is handled locally and not sent to Cloud Spanner.
215+
assertEquals(0, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
216+
}
217+
186218
@Test
187219
public void testShowServerVersion() throws SQLException {
188220
String sql = "show server_version";

‎src/test/java/com/google/cloud/spanner/pgadapter/statements/local/ShowSearchPathStatementTest.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package com.google.cloud.spanner.pgadapter.statements.local;
16+
17+
import static org.junit.Assert.assertEquals;
18+
import static org.junit.Assert.assertFalse;
19+
import static org.junit.Assert.assertTrue;
20+
import static org.mockito.Mockito.mock;
21+
import static org.mockito.Mockito.when;
22+
23+
import com.google.cloud.spanner.ResultSet;
24+
import com.google.cloud.spanner.pgadapter.statements.BackendConnection;
25+
import org.junit.Test;
26+
import org.junit.runner.RunWith;
27+
import org.junit.runners.JUnit4;
28+
29+
@RunWith(JUnit4.class)
30+
public class ShowSearchPathStatementTest {
31+
32+
@Test
33+
public void testExecute() {
34+
for (String schema : new String[] {"public", "my_schema"}) {
35+
BackendConnection backendConnection = mock(BackendConnection.class);
36+
when(backendConnection.getCurrentSchema()).thenReturn(schema);
37+
38+
try (ResultSet resultSet =
39+
ShowSearchPathStatement.INSTANCE.execute(backendConnection).getResultSet()) {
40+
assertTrue(resultSet.next());
41+
assertEquals(1, resultSet.getColumnCount());
42+
assertEquals(schema, resultSet.getString("search_path"));
43+
assertFalse(resultSet.next());
44+
}
45+
}
46+
}
47+
}

0 commit comments

Comments
 (0)