
com.google.cloud.spanner.pgadapter.wireprotocol.ExecuteMessage 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 2020 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.wireprotocol;
import com.google.api.core.InternalApi;
import com.google.cloud.spanner.pgadapter.ConnectionHandler;
import com.google.cloud.spanner.pgadapter.statements.BackendConnection;
import com.google.cloud.spanner.pgadapter.statements.CopyStatement;
import com.google.cloud.spanner.pgadapter.statements.IntermediatePreparedStatement;
import java.text.MessageFormat;
/** Executes a portal. */
@InternalApi
public class ExecuteMessage extends AbstractQueryProtocolMessage {
protected static final char IDENTIFIER = 'E';
private final String name;
private final int maxRows;
private final IntermediatePreparedStatement statement;
private final boolean cleanupAfterExecute;
public ExecuteMessage(ConnectionHandler connection) throws Exception {
super(connection);
this.name = this.readAll();
this.maxRows = this.inputStream.readInt();
this.statement = this.connection.getPortal(this.name);
this.cleanupAfterExecute = true;
}
/** Constructor for execute messages that are generated by the simple query protocol. */
public ExecuteMessage(ConnectionHandler connection, ManuallyCreatedToken manuallyCreatedToken) {
this(connection, "", 0, null, true, manuallyCreatedToken);
}
public ExecuteMessage(
ConnectionHandler connection,
String name,
int maxRows,
String commandTag,
boolean cleanupAfterExecute,
ManuallyCreatedToken manuallyCreatedToken) {
super(connection, 8, manuallyCreatedToken);
this.name = name;
this.maxRows = maxRows;
this.statement = this.connection.getPortal(this.name);
if (commandTag != null) {
this.statement.setCommandTag(commandTag);
}
this.cleanupAfterExecute = cleanupAfterExecute;
}
@Override
void buffer(BackendConnection backendConnection) {
this.statement.executeAsync(backendConnection);
}
@Override
public void flush() throws Exception {
this.handleExecute();
}
@Override
protected String getMessageName() {
return "Execute";
}
@Override
protected String getPayloadString() {
return new MessageFormat("Length: {0}, " + "Name: {1}, " + "Max Rows: {2}")
.format(new Object[] {this.length, this.name, this.maxRows});
}
@Override
public String getIdentifier() {
return String.valueOf(IDENTIFIER);
}
public String getName() {
return this.name;
}
public int getMaxRows() {
return this.maxRows;
}
@Override
public String getSql() {
return this.statement.getSql();
}
@Override
protected int getHeaderLength() {
return 8;
}
/**
* Called when an execute message is received.
*
* @throws Exception if sending the message back to the client causes an error.
*/
private void handleExecute() throws Exception {
// Copy response is handled directly in the COPY protocol.
if (this.statement instanceof CopyStatement) {
if (this.statement.hasException()) {
throw this.statement.getException();
}
} else {
if (this.statement.hasException()) {
this.handleError(this.statement.getException());
} else {
try {
this.sendSpannerResult(this.statement, this.queryMode, this.maxRows);
} catch (Exception exception) {
handleError(exception);
}
}
}
if (cleanupAfterExecute) {
this.connection.cleanUp(this.statement);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy