com.google.cloud.spanner.pgadapter.wireprotocol.CopyFailMessage 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

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.ConnectionHandler.ConnectionStatus;
import com.google.cloud.spanner.pgadapter.error.PGException;
import com.google.cloud.spanner.pgadapter.error.SQLState;
import com.google.cloud.spanner.pgadapter.statements.CopyStatement;
import com.google.cloud.spanner.pgadapter.utils.MutationWriter;
import java.text.MessageFormat;

/**
 * Normally used to signal a copy command failed. Spanner does not currently support copies, so send
 * will throw a descriptive error to be sent to the user. Note that we do parse this in order for
 * this to be future proof, and to ensure the input stream is flushed of the command (in order to
 * continue receiving properly)
 */
@InternalApi
public class CopyFailMessage extends ControlMessage {
  protected static final char IDENTIFIER = 'f';

  private final CopyStatement statement;
  private final String errorMessage;

  public CopyFailMessage(ConnectionHandler connection) throws Exception {
    super(connection);
    this.errorMessage = this.readAll();
    this.statement = connection.getActiveCopyStatement();
  }

  @Override
  protected void sendPayload() throws Exception {
    if (this.statement != null) {
      MutationWriter mutationWriter = this.statement.getMutationWriter();
      mutationWriter.rollback();
      statement.close();
      this.statement.handleExecutionException(
          PGException.newBuilder(this.errorMessage).setSQLState(SQLState.QueryCanceled).build());
    }
    // Clear the COPY_IN status to indicate that we finished unsuccessfully. This will cause the
    // inline handling of incoming (copy) messages to stop and the server to return an error message
    // and to resume normal operation.
    this.connection.setStatus(ConnectionStatus.COPY_FAILED);
  }

  @Override
  protected String getMessageName() {
    return "Copy Fail";
  }

  @Override
  protected String getPayloadString() {
    return new MessageFormat("Length: {0}").format(new Object[] {this.length});
  }

  @Override
  public String getIdentifier() {
    return String.valueOf(IDENTIFIER);
  }

  public String getErrorMessage() {
    return this.errorMessage;
  }
}