
com.google.cloud.spanner.pgadapter.statements.PrepareStatement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-spanner-pgadapter Show documentation
Show all versions of google-cloud-spanner-pgadapter Show documentation
The PGAdapter server implements the PostgreSQL wire-protocol, but sends all received statements
to a Cloud Spanner database instead of a PostgreSQL database. The Cloud Spanner database must
have been created to use the PostgreSQL dialect. See https://cloud.google.com/spanner/docs/quickstart-console#postgresql
for more information on how to create PostgreSQL dialect databases on Cloud Spanner.
The newest version!
// 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 com.google.api.core.InternalApi;
import com.google.cloud.spanner.Dialect;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.connection.AbstractStatementParser;
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.metadata.OptionsMetadata;
import com.google.cloud.spanner.pgadapter.statements.BackendConnection.NoResult;
import com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName;
import com.google.cloud.spanner.pgadapter.statements.SimpleParser.TypeDefinition;
import com.google.cloud.spanner.pgadapter.wireprotocol.ControlMessage.ManuallyCreatedToken;
import com.google.cloud.spanner.pgadapter.wireprotocol.ControlMessage.PreparedType;
import com.google.cloud.spanner.pgadapter.wireprotocol.DescribeMessage;
import com.google.cloud.spanner.pgadapter.wireprotocol.ParseMessage;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.Futures;
import java.util.List;
import java.util.concurrent.Future;
import java.util.stream.Collectors;
import org.postgresql.core.Oid;
@InternalApi
public class PrepareStatement extends IntermediatePortalStatement {
private static final ImmutableMap TYPE_NAME_TO_OID_MAPPING =
ImmutableMap.builder()
.put("unknown", Oid.UNSPECIFIED)
.put("bigint", Oid.INT8)
.put("bigint[]", Oid.INT8_ARRAY)
.put("int8", Oid.INT8)
.put("int8[]", Oid.INT8_ARRAY)
.put("int4", Oid.INT4)
.put("int4[]", Oid.INT4_ARRAY)
.put("int2", Oid.INT2)
.put("int2[]", Oid.INT2_ARRAY)
.put("int", Oid.INT4)
.put("int[]", Oid.INT4_ARRAY)
.put("integer", Oid.INT4)
.put("integer[]", Oid.INT4_ARRAY)
.put("boolean", Oid.BOOL)
.put("boolean[]", Oid.BOOL_ARRAY)
.put("bool", Oid.BOOL)
.put("bool[]", Oid.BOOL_ARRAY)
.put("bytea", Oid.BYTEA)
.put("bytea[]", Oid.BYTEA_ARRAY)
.put("character varying", Oid.VARCHAR)
.put("character varying[]", Oid.VARCHAR_ARRAY)
.put("varchar", Oid.VARCHAR)
.put("varchar[]", Oid.VARCHAR_ARRAY)
.put("date", Oid.DATE)
.put("date[]", Oid.DATE_ARRAY)
.put("double precision", Oid.FLOAT8)
.put("double precision[]", Oid.FLOAT8_ARRAY)
.put("float8", Oid.FLOAT8)
.put("float8[]", Oid.FLOAT8_ARRAY)
.put("real", Oid.FLOAT4)
.put("real[]", Oid.FLOAT4_ARRAY)
.put("float4", Oid.FLOAT4)
.put("float4[]", Oid.FLOAT4_ARRAY)
.put("jsonb", Oid.JSONB)
.put("jsonb[]", Oid.JSONB_ARRAY)
.put("numeric", Oid.NUMERIC)
.put("numeric[]", Oid.NUMERIC_ARRAY)
.put("decimal", Oid.NUMERIC)
.put("decimal[]", Oid.NUMERIC_ARRAY)
.put("text", Oid.TEXT)
.put("text[]", Oid.TEXT_ARRAY)
.put("timestamp with time zone", Oid.TIMESTAMPTZ)
.put("timestamp with time zone[]", Oid.TIMESTAMPTZ_ARRAY)
.put("timestamptz", Oid.TIMESTAMPTZ)
.put("timestamptz[]", Oid.TIMESTAMPTZ_ARRAY)
.build();
static final class ParsedPreparedStatement {
final String name;
final int[] dataTypes;
final Statement originalPreparedStatement;
final ParsedStatement parsedPreparedStatement;
private ParsedPreparedStatement(String name, int[] dataTypes, String sql) {
this.name = name;
this.dataTypes = dataTypes;
this.originalPreparedStatement = Statement.of(sql);
this.parsedPreparedStatement =
AbstractStatementParser.getInstance(Dialect.POSTGRESQL).parse(originalPreparedStatement);
}
}
private final ParsedPreparedStatement preparedStatement;
public PrepareStatement(
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.preparedStatement = parse(originalStatement.getSql());
}
@Override
public String getCommandTag() {
return "PREPARE";
}
@Override
public StatementType getStatementType() {
return StatementType.CLIENT_SIDE;
}
@Override
public void executeAsync(BackendConnection backendConnection) {
if (!this.executed) {
this.executed = true;
try {
new ParseMessage(
connectionHandler,
preparedStatement.name,
preparedStatement.dataTypes,
preparedStatement.parsedPreparedStatement,
preparedStatement.originalPreparedStatement)
.send();
new DescribeMessage(
connectionHandler,
PreparedType.Statement,
preparedStatement.name,
ManuallyCreatedToken.MANUALLY_CREATED_TOKEN)
.send();
} catch (Exception exception) {
setFutureStatementResult(Futures.immediateFailedFuture(exception));
return;
}
setFutureStatementResult(Futures.immediateFuture(new NoResult(getCommandTag())));
}
}
@Override
public Future describeAsync(BackendConnection backendConnection) {
// Return null to indicate that this PREPARE statement does not return any
// RowDescriptionResponse.
return Futures.immediateFuture(null);
}
@Override
public IntermediatePortalStatement createPortal(
String name,
byte[][] parameters,
List parameterFormatCodes,
List resultFormatCodes) {
// PREPARE does not support binding any parameters, so we just return the same statement.
return this;
}
static ParsedPreparedStatement parse(String sql) {
Preconditions.checkNotNull(sql);
SimpleParser parser = new SimpleParser(sql);
if (!parser.eatKeyword("prepare")) {
throw PGExceptionFactory.newPGException("not a valid PREPARE statement: " + sql);
}
TableOrIndexName name = parser.readTableOrIndexName();
if (name == null || name.schema != null) {
throw PGExceptionFactory.newPGException("invalid prepared statement name");
}
ImmutableList.Builder dataTypesBuilder = ImmutableList.builder();
if (parser.eatToken("(")) {
List dataTypesNames = parser.parseExpressionList();
if (dataTypesNames == null || dataTypesNames.isEmpty()) {
throw PGExceptionFactory.newPGException("invalid data type list");
}
if (!parser.eatToken(")")) {
throw PGExceptionFactory.newPGException("missing closing parentheses in data type list");
}
dataTypesBuilder.addAll(
dataTypesNames.stream()
.map(PrepareStatement::dataTypeNameToOid)
.collect(Collectors.toList()));
}
if (!parser.eatKeyword("as")) {
throw PGExceptionFactory.newPGException("missing 'AS' keyword in PREPARE statement: " + sql);
}
return new ParsedPreparedStatement(
name.name,
dataTypesBuilder.build().stream().mapToInt(i -> i).toArray(),
parser.getSql().substring(parser.getPos()).trim());
}
static int dataTypeNameToOid(String type) {
SimpleParser parser = new SimpleParser(type);
TypeDefinition typeDefinition = parser.readType();
Integer oid =
TYPE_NAME_TO_OID_MAPPING.get(typeDefinition.getNameAndArrayBrackets().toLowerCase());
if (oid != null) {
return oid;
}
throw PGExceptionFactory.newPGException("unknown type name: " + type);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy