• Home
• com.google.cloud
• google-cloud-spanner
• 6.76.0
• source code
• DirectExecuteResultSet.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.spanner.connection.DirectExecuteResultSet Maven / Gradle / Ivy

/*
 * Copyright 2019 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.connection;

import com.google.cloud.ByteArray;
import com.google.cloud.Date;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.ProtobufResultSet;
import com.google.cloud.spanner.ResultSet;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.Struct;
import com.google.cloud.spanner.Type;
import com.google.cloud.spanner.Value;
import com.google.common.base.Preconditions;
import com.google.protobuf.AbstractMessage;
import com.google.protobuf.ProtocolMessageEnum;
import com.google.spanner.v1.ResultSetMetadata;
import com.google.spanner.v1.ResultSetStats;
import java.math.BigDecimal;
import java.util.List;
import java.util.function.Function;

/**
 * {@link ResultSet} implementation used by the Spanner connection API to ensure that the query for
 * a {@link ResultSet} is executed directly when it is created. This is done by calling {@link
 * ResultSet#next()} directly after creation. This ensures that a statement timeout can be applied
 * to the actual query execution. It also ensures that any invalid query will throw an exception at
 * execution instead of the first next() call by a client.
 */
class DirectExecuteResultSet implements ProtobufResultSet {
  private static final String MISSING_NEXT_CALL = "Must be preceded by a next() call";
  private final ResultSet delegate;
  private boolean nextCalledByClient = false;
  private final boolean initialNextResult;
  private boolean nextHasReturnedFalse = false;

  /**
   * Creates a new {@link DirectExecuteResultSet} from the given delegate {@link ResultSet}. This
   * automatically executes the query of the given delegate {@link ResultSet} by calling next() on
   * the delegate. The delegate must not have been used (i.e. next() must not have been called on
   * it).
   *
   * @param delegate The underlying {@link ResultSet} for this {@link DirectExecuteResultSet}.
   * @return a {@link DirectExecuteResultSet} that has already executed the query associated with
   *     the delegate {@link ResultSet}.
   */
  static DirectExecuteResultSet ofResultSet(ResultSet delegate) {
    return new DirectExecuteResultSet(delegate);
  }

  DirectExecuteResultSet(ResultSet delegate) {
    Preconditions.checkNotNull(delegate);
    this.delegate = delegate;
    initialNextResult = delegate.next();
  }

  @Override
  public boolean next() throws SpannerException {
    if (nextCalledByClient) {
      boolean res = delegate.next();
      nextHasReturnedFalse = !res;
      return res;
    }
    nextCalledByClient = true;
    nextHasReturnedFalse = !initialNextResult;
    return initialNextResult;
  }

  @Override
  public boolean canGetProtobufValue(int columnIndex) {
    return nextCalledByClient
        && delegate instanceof ProtobufResultSet
        && ((ProtobufResultSet) delegate).canGetProtobufValue(columnIndex);
  }

  @Override
  public com.google.protobuf.Value getProtobufValue(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    Preconditions.checkState(
        delegate instanceof ProtobufResultSet, "The result set does not support protobuf values");
    return ((ProtobufResultSet) delegate).getProtobufValue(columnIndex);
  }

  @Override
  public Struct getCurrentRowAsStruct() {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getCurrentRowAsStruct();
  }

  @Override
  public void close() {
    delegate.close();
  }

  @Override
  public ResultSetStats getStats() {
    if (nextHasReturnedFalse) {
      return delegate.getStats();
    }
    return null;
  }

  @Override
  public ResultSetMetadata getMetadata() {
    return delegate.getMetadata();
  }

  @Override
  public Type getType() {
    return delegate.getType();
  }

  @Override
  public int getColumnCount() {
    return delegate.getColumnCount();
  }

  @Override
  public int getColumnIndex(String columnName) {
    return delegate.getColumnIndex(columnName);
  }

  @Override
  public Type getColumnType(int columnIndex) {
    return delegate.getColumnType(columnIndex);
  }

  @Override
  public Type getColumnType(String columnName) {
    return delegate.getColumnType(columnName);
  }

  @Override
  public boolean isNull(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.isNull(columnIndex);
  }

  @Override
  public boolean isNull(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.isNull(columnName);
  }

  @Override
  public boolean getBoolean(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBoolean(columnIndex);
  }

  @Override
  public boolean getBoolean(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBoolean(columnName);
  }

  @Override
  public long getLong(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLong(columnIndex);
  }

  @Override
  public long getLong(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLong(columnName);
  }

  @Override
  public float getFloat(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloat(columnIndex);
  }

  @Override
  public double getDouble(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDouble(columnIndex);
  }

  @Override
  public BigDecimal getBigDecimal(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBigDecimal(columnName);
  }

  @Override
  public BigDecimal getBigDecimal(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBigDecimal(columnIndex);
  }

  @Override
  public float getFloat(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloat(columnName);
  }

  @Override
  public double getDouble(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDouble(columnName);
  }

  @Override
  public String getString(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getString(columnIndex);
  }

  @Override
  public String getString(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getString(columnName);
  }

  @Override
  public String getJson(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getJson(columnIndex);
  }

  @Override
  public String getJson(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getJson(columnName);
  }

  @Override
  public String getPgJsonb(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getPgJsonb(columnIndex);
  }

  @Override
  public String getPgJsonb(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getPgJsonb(columnName);
  }

  @Override
  public ByteArray getBytes(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBytes(columnIndex);
  }

  @Override
  public ByteArray getBytes(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBytes(columnName);
  }

  @Override
  public Timestamp getTimestamp(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getTimestamp(columnIndex);
  }

  @Override
  public Timestamp getTimestamp(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getTimestamp(columnName);
  }

  @Override
  public Date getDate(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDate(columnIndex);
  }

  @Override
  public Date getDate(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDate(columnName);
  }

  @Override
  public Value getValue(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getValue(columnIndex);
  }

  @Override
  public Value getValue(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getValue(columnName);
  }

  @Override
  public boolean[] getBooleanArray(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBooleanArray(columnIndex);
  }

  @Override
  public boolean[] getBooleanArray(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBooleanArray(columnName);
  }

  @Override
  public List getBooleanList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBooleanList(columnIndex);
  }

  @Override
  public List getBooleanList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBooleanList(columnName);
  }

  @Override
  public long[] getLongArray(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLongArray(columnIndex);
  }

  @Override
  public long[] getLongArray(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLongArray(columnName);
  }

  @Override
  public List getLongList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLongList(columnIndex);
  }

  @Override
  public List getLongList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getLongList(columnName);
  }

  @Override
  public float[] getFloatArray(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloatArray(columnIndex);
  }

  @Override
  public float[] getFloatArray(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloatArray(columnName);
  }

  @Override
  public List getFloatList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloatList(columnIndex);
  }

  @Override
  public List getFloatList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getFloatList(columnName);
  }

  @Override
  public double[] getDoubleArray(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDoubleArray(columnIndex);
  }

  @Override
  public double[] getDoubleArray(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDoubleArray(columnName);
  }

  @Override
  public List getDoubleList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDoubleList(columnIndex);
  }

  @Override
  public List getDoubleList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDoubleList(columnName);
  }

  @Override
  public List getBigDecimalList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBigDecimalList(columnIndex);
  }

  @Override
  public List getBigDecimalList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBigDecimalList(columnName);
  }

  @Override
  public List getStringList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getStringList(columnIndex);
  }

  @Override
  public List getStringList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getStringList(columnName);
  }

  @Override
  public List getJsonList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getJsonList(columnIndex);
  }

  @Override
  public List getJsonList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getJsonList(columnName);
  }

  @Override
  public List getPgJsonbList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getPgJsonbList(columnIndex);
  }

  @Override
  public List getPgJsonbList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getPgJsonbList(columnName);
  }

  @Override
  public List getBytesList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBytesList(columnIndex);
  }

  @Override
  public List getBytesList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getBytesList(columnName);
  }

  @Override
  public List getTimestampList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getTimestampList(columnIndex);
  }

  @Override
  public List getTimestampList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getTimestampList(columnName);
  }

  @Override
  public List getDateList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDateList(columnIndex);
  }

  @Override
  public List getDateList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getDateList(columnName);
  }

  @Override
  public  List getProtoMessageList(int columnIndex, T message) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoMessageList(columnIndex, message);
  }

  @Override
  public  List getProtoMessageList(String columnName, T message) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoMessageList(columnName, message);
  }

  @Override
  public  List getProtoEnumList(
      int columnIndex, Function method) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoEnumList(columnIndex, method);
  }

  @Override
  public  List getProtoEnumList(
      String columnName, Function method) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoEnumList(columnName, method);
  }

  @Override
  public List getStructList(int columnIndex) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getStructList(columnIndex);
  }

  @Override
  public List getStructList(String columnName) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getStructList(columnName);
  }

  @Override
  public  T getProtoEnum(
      int columnIndex, Function method) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoEnum(columnIndex, method);
  }

  @Override
  public  T getProtoEnum(
      String columnName, Function method) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoEnum(columnName, method);
  }

  @Override
  public  T getProtoMessage(int columnIndex, T message) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoMessage(columnIndex, message);
  }

  @Override
  public  T getProtoMessage(String columnName, T message) {
    Preconditions.checkState(nextCalledByClient, MISSING_NEXT_CALL);
    return delegate.getProtoMessage(columnName, message);
  }

  @Override
  public boolean equals(Object o) {
    if (!(o instanceof DirectExecuteResultSet)) {
      return false;
    }
    return ((DirectExecuteResultSet) o).delegate.equals(delegate);
  }

  @Override
  public int hashCode() {
    return delegate.hashCode();
  }
}