nl.topicus.jdbc.shaded.com.google.spanner.v1.ReadRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation
Show all versions of spanner-jdbc Show documentation
JDBC Driver for Google Cloud Spanner
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/spanner/v1/spanner.proto
package nl.topicus.jdbc.shaded.com.google.spanner.v1;
public interface ReadRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.spanner.v1.ReadRequest)
nl.topicus.jdbc.shaded.com.google.protobuf.MessageOrBuilder {
/**
*
* Required. The session in which the read should be performed.
*
*
* string session = 1;
*/
java.lang.String getSession();
/**
*
* Required. The session in which the read should be performed.
*
*
* string session = 1;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString
getSessionBytes();
/**
*
* The transaction to use. If none is provided, the default is a
* temporary read-only transaction with strong concurrency.
*
*
* .google.spanner.v1.TransactionSelector transaction = 2;
*/
boolean hasTransaction();
/**
*
* The transaction to use. If none is provided, the default is a
* temporary read-only transaction with strong concurrency.
*
*
* .google.spanner.v1.TransactionSelector transaction = 2;
*/
nl.topicus.jdbc.shaded.com.google.spanner.v1.TransactionSelector getTransaction();
/**
*
* The transaction to use. If none is provided, the default is a
* temporary read-only transaction with strong concurrency.
*
*
* .google.spanner.v1.TransactionSelector transaction = 2;
*/
nl.topicus.jdbc.shaded.com.google.spanner.v1.TransactionSelectorOrBuilder getTransactionOrBuilder();
/**
*
* Required. The name of the table in the database to be read.
*
*
* string table = 3;
*/
java.lang.String getTable();
/**
*
* Required. The name of the table in the database to be read.
*
*
* string table = 3;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString
getTableBytes();
/**
*
* If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is
* used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set]
* and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
*
*
* string index = 4;
*/
java.lang.String getIndex();
/**
*
* If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is
* used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set]
* and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
*
*
* string index = 4;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString
getIndexBytes();
/**
*
* The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*
*
* repeated string columns = 5;
*/
java.util.List
getColumnsList();
/**
*
* The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*
*
* repeated string columns = 5;
*/
int getColumnsCount();
/**
*
* The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*
*
* repeated string columns = 5;
*/
java.lang.String getColumns(int index);
/**
*
* The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*
*
* repeated string columns = 5;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString
getColumnsBytes(int index);
/**
*
* Required. `key_set` identifies the rows to be yielded. `key_set` names the
* primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index]
* is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names
* index keys in [index][google.spanner.v1.ReadRequest.index].
* If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded
* in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order
* (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is not
* empty, rows will be yielded in an unspecified order.
* It is not an error for the `key_set` to name rows that do not
* exist in the database. Read yields nothing for nonexistent rows.
*
*
* .google.spanner.v1.KeySet key_set = 6;
*/
boolean hasKeySet();
/**
*
* Required. `key_set` identifies the rows to be yielded. `key_set` names the
* primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index]
* is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names
* index keys in [index][google.spanner.v1.ReadRequest.index].
* If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded
* in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order
* (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is not
* empty, rows will be yielded in an unspecified order.
* It is not an error for the `key_set` to name rows that do not
* exist in the database. Read yields nothing for nonexistent rows.
*
*
* .google.spanner.v1.KeySet key_set = 6;
*/
nl.topicus.jdbc.shaded.com.google.spanner.v1.KeySet getKeySet();
/**
*
* Required. `key_set` identifies the rows to be yielded. `key_set` names the
* primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index]
* is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names
* index keys in [index][google.spanner.v1.ReadRequest.index].
* If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded
* in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order
* (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is not
* empty, rows will be yielded in an unspecified order.
* It is not an error for the `key_set` to name rows that do not
* exist in the database. Read yields nothing for nonexistent rows.
*
*
* .google.spanner.v1.KeySet key_set = 6;
*/
nl.topicus.jdbc.shaded.com.google.spanner.v1.KeySetOrBuilder getKeySetOrBuilder();
/**
*
* If greater than zero, only the first `limit` rows are yielded. If `limit`
* is zero, the default is no limit. A limit cannot be specified if
* `partition_token` is set.
*
*
* int64 limit = 8;
*/
long getLimit();
/**
*
* If this request is resuming a previously interrupted read,
* `resume_token` should be copied from the last
* [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this
* enables the new read to resume where the last read left off. The
* rest of the request parameters must exactly match the request
* that yielded this token.
*
*
* bytes resume_token = 9;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString getResumeToken();
/**
*
* If present, results will be restricted to the specified partition
* previously created using PartitionRead(). There must be an exact
* match for the values of fields common to this message and the
* PartitionReadRequest message used to create this partition_token.
*
*
* bytes partition_token = 10;
*/
nl.topicus.jdbc.shaded.com.google.protobuf.ByteString getPartitionToken();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy