...
ActiveGo 1.8Package spanner
Overview ▹
Index ▹
Variables
var ExecuteSqlRequest_QueryMode_name = map[int32]string{
0: "NORMAL",
1: "PLAN",
2: "PROFILE",
}
var ExecuteSqlRequest_QueryMode_value = map[string]int32{
"NORMAL": 0,
"PLAN": 1,
"PROFILE": 2,
}
var PlanNode_Kind_name = map[int32]string{
0: "KIND_UNSPECIFIED",
1: "RELATIONAL",
2: "SCALAR",
}
var PlanNode_Kind_value = map[string]int32{
"KIND_UNSPECIFIED": 0,
"RELATIONAL": 1,
"SCALAR": 2,
}
var TypeCode_name = map[int32]string{
0: "TYPE_CODE_UNSPECIFIED",
1: "BOOL",
2: "INT64",
3: "FLOAT64",
4: "TIMESTAMP",
5: "DATE",
6: "STRING",
7: "BYTES",
8: "ARRAY",
9: "STRUCT",
}
var TypeCode_value = map[string]int32{
"TYPE_CODE_UNSPECIFIED": 0,
"BOOL": 1,
"INT64": 2,
"FLOAT64": 3,
"TIMESTAMP": 4,
"DATE": 5,
"STRING": 6,
"BYTES": 7,
"ARRAY": 8,
"STRUCT": 9,
}
func RegisterSpannerServer ¶
func RegisterSpannerServer(s *grpc.Server, srv SpannerServer)
type BeginTransactionRequest ¶
The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
type BeginTransactionRequest struct {
// Required. The session in which the transaction runs.
Session string `protobuf:"bytes,1,opt,name=session" json:"session,omitempty"`
// Required. Options for the new transaction.
Options *TransactionOptions `protobuf:"bytes,2,opt,name=options" json:"options,omitempty"`
}
func (*BeginTransactionRequest) Descriptor ¶
func (*BeginTransactionRequest) Descriptor() ([]byte, []int)
func (*BeginTransactionRequest) GetOptions ¶
func (m *BeginTransactionRequest) GetOptions() *TransactionOptions
func (*BeginTransactionRequest) GetSession ¶
func (m *BeginTransactionRequest) GetSession() string
func (*BeginTransactionRequest) ProtoMessage ¶
func (*BeginTransactionRequest) ProtoMessage()
func (*BeginTransactionRequest) Reset ¶
func (m *BeginTransactionRequest) Reset()
func (*BeginTransactionRequest) String ¶
func (m *BeginTransactionRequest) String() string
type CommitRequest ¶
The request for [Commit][google.spanner.v1.Spanner.Commit].
type CommitRequest struct {
// Required. The session in which the transaction to be committed is running.
Session string `protobuf:"bytes,1,opt,name=session" json:"session,omitempty"`
// Required. The transaction in which to commit.
//
// Types that are valid to be assigned to Transaction:
// *CommitRequest_TransactionId
// *CommitRequest_SingleUseTransaction
Transaction isCommitRequest_Transaction `protobuf_oneof:"transaction"`
// The mutations to be executed when this transaction commits. All
// mutations are applied atomically, in the order they appear in
// this list.
Mutations []*Mutation `protobuf:"bytes,4,rep,name=mutations" json:"mutations,omitempty"`
}
func (*CommitRequest) Descriptor ¶
func (*CommitRequest) Descriptor() ([]byte, []int)
func (*CommitRequest) GetMutations ¶
func (m *CommitRequest) GetMutations() []*Mutation
func (*CommitRequest) GetSession ¶
func (m *CommitRequest) GetSession() string
func (*CommitRequest) GetSingleUseTransaction ¶
func (m *CommitRequest) GetSingleUseTransaction() *TransactionOptions
func (*CommitRequest) GetTransaction ¶
func (m *CommitRequest) GetTransaction() isCommitRequest_Transaction
func (*CommitRequest) GetTransactionId ¶
func (m *CommitRequest) GetTransactionId() []byte
func (*CommitRequest) ProtoMessage ¶
func (*CommitRequest) ProtoMessage()
func (*CommitRequest) Reset ¶
func (m *CommitRequest) Reset()
func (*CommitRequest) String ¶
func (m *CommitRequest) String() string
func (*CommitRequest) XXX_OneofFuncs ¶
func (*CommitRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type CommitRequest_SingleUseTransaction ¶
type CommitRequest_SingleUseTransaction struct {
SingleUseTransaction *TransactionOptions `protobuf:"bytes,3,opt,name=single_use_transaction,json=singleUseTransaction,oneof"`
}
type CommitRequest_TransactionId ¶
type CommitRequest_TransactionId struct {
TransactionId []byte `protobuf:"bytes,2,opt,name=transaction_id,json=transactionId,proto3,oneof"`
}
type CommitResponse ¶
The response for [Commit][google.spanner.v1.Spanner.Commit].
type CommitResponse struct {
// The Cloud Spanner timestamp at which the transaction committed.
CommitTimestamp *google_protobuf3.Timestamp `protobuf:"bytes,1,opt,name=commit_timestamp,json=commitTimestamp" json:"commit_timestamp,omitempty"`
}
func (*CommitResponse) Descriptor ¶
func (*CommitResponse) Descriptor() ([]byte, []int)
func (*CommitResponse) GetCommitTimestamp ¶
func (m *CommitResponse) GetCommitTimestamp() *google_protobuf3.Timestamp
func (*CommitResponse) ProtoMessage ¶
func (*CommitResponse) ProtoMessage()
func (*CommitResponse) Reset ¶
func (m *CommitResponse) Reset()
func (*CommitResponse) String ¶
func (m *CommitResponse) String() string
type CreateSessionRequest ¶
The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].
type CreateSessionRequest struct {
// Required. The database in which the new session is created.
Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
}
func (*CreateSessionRequest) Descriptor ¶
func (*CreateSessionRequest) Descriptor() ([]byte, []int)
func (*CreateSessionRequest) GetDatabase ¶
func (m *CreateSessionRequest) GetDatabase() string
func (*CreateSessionRequest) ProtoMessage ¶
func (*CreateSessionRequest) ProtoMessage()
func (*CreateSessionRequest) Reset ¶
func (m *CreateSessionRequest) Reset()
func (*CreateSessionRequest) String ¶
func (m *CreateSessionRequest) String() string
type DeleteSessionRequest ¶
The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].
type DeleteSessionRequest struct {
// Required. The name of the session to delete.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*DeleteSessionRequest) Descriptor ¶
func (*DeleteSessionRequest) Descriptor() ([]byte, []int)
func (*DeleteSessionRequest) GetName ¶
func (m *DeleteSessionRequest) GetName() string
func (*DeleteSessionRequest) ProtoMessage ¶
func (*DeleteSessionRequest) ProtoMessage()
func (*DeleteSessionRequest) Reset ¶
func (m *DeleteSessionRequest) Reset()
func (*DeleteSessionRequest) String ¶
func (m *DeleteSessionRequest) String() string
type ExecuteSqlRequest ¶
The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
type ExecuteSqlRequest struct {
// Required. The session in which the SQL query should be performed.
Session string `protobuf:"bytes,1,opt,name=session" json:"session,omitempty"`
// The transaction to use. If none is provided, the default is a
// temporary read-only transaction with strong concurrency.
Transaction *TransactionSelector `protobuf:"bytes,2,opt,name=transaction" json:"transaction,omitempty"`
// Required. The SQL query string.
Sql string `protobuf:"bytes,3,opt,name=sql" json:"sql,omitempty"`
// The SQL query string can contain parameter placeholders. A parameter
// placeholder consists of `'@'` followed by the parameter
// name. Parameter names consist of any combination of letters,
// numbers, and underscores.
//
// Parameters can appear anywhere that a literal value is expected. The same
// parameter name can be used more than once, for example:
// `"WHERE id > @msg_id AND id < @msg_id + 100"`
//
// It is an error to execute an SQL query with unbound parameters.
//
// Parameter values are specified using `params`, which is a JSON
// object whose keys are parameter names, and whose values are the
// corresponding parameter values.
Params *google_protobuf1.Struct `protobuf:"bytes,4,opt,name=params" json:"params,omitempty"`
// It is not always possible for Cloud Spanner to infer the right SQL type
// from a JSON value. For example, values of type `BYTES` and values
// of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
//
// In these cases, `param_types` can be used to specify the exact
// SQL type for some or all of the SQL query parameters. See the
// definition of [Type][google.spanner.v1.Type] for more information
// about SQL types.
ParamTypes map[string]*Type `protobuf:"bytes,5,rep,name=param_types,json=paramTypes" json:"param_types,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// If this request is resuming a previously interrupted SQL query
// execution, `resume_token` should be copied from the last
// [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this
// enables the new SQL query execution to resume where the last one left
// off. The rest of the request parameters must exactly match the
// request that yielded this token.
ResumeToken []byte `protobuf:"bytes,6,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
// Used to control the amount of debugging information returned in
// [ResultSetStats][google.spanner.v1.ResultSetStats].
QueryMode ExecuteSqlRequest_QueryMode `protobuf:"varint,7,opt,name=query_mode,json=queryMode,enum=google.spanner.v1.ExecuteSqlRequest_QueryMode" json:"query_mode,omitempty"`
}
func (*ExecuteSqlRequest) Descriptor ¶
func (*ExecuteSqlRequest) Descriptor() ([]byte, []int)
func (*ExecuteSqlRequest) GetParamTypes ¶
func (m *ExecuteSqlRequest) GetParamTypes() map[string]*Type
func (*ExecuteSqlRequest) GetParams ¶
func (m *ExecuteSqlRequest) GetParams() *google_protobuf1.Struct
func (*ExecuteSqlRequest) GetQueryMode ¶
func (m *ExecuteSqlRequest) GetQueryMode() ExecuteSqlRequest_QueryMode
func (*ExecuteSqlRequest) GetResumeToken ¶
func (m *ExecuteSqlRequest) GetResumeToken() []byte
func (*ExecuteSqlRequest) GetSession ¶
func (m *ExecuteSqlRequest) GetSession() string
func (*ExecuteSqlRequest) GetSql ¶
func (m *ExecuteSqlRequest) GetSql() string
func (*ExecuteSqlRequest) GetTransaction ¶
func (m *ExecuteSqlRequest) GetTransaction() *TransactionSelector
func (*ExecuteSqlRequest) ProtoMessage ¶
func (*ExecuteSqlRequest) ProtoMessage()
func (*ExecuteSqlRequest) Reset ¶
func (m *ExecuteSqlRequest) Reset()
func (*ExecuteSqlRequest) String ¶
func (m *ExecuteSqlRequest) String() string
type ExecuteSqlRequest_QueryMode ¶
Mode in which the query must be processed.
type ExecuteSqlRequest_QueryMode int32
const (
// The default mode where only the query result, without any information
// about the query plan is returned.
ExecuteSqlRequest_NORMAL ExecuteSqlRequest_QueryMode = 0
// This mode returns only the query plan, without any result rows or
// execution statistics information.
ExecuteSqlRequest_PLAN ExecuteSqlRequest_QueryMode = 1
// This mode returns both the query plan and the execution statistics along
// with the result rows.
ExecuteSqlRequest_PROFILE ExecuteSqlRequest_QueryMode = 2
)
func (ExecuteSqlRequest_QueryMode) EnumDescriptor ¶
func (ExecuteSqlRequest_QueryMode) EnumDescriptor() ([]byte, []int)
func (ExecuteSqlRequest_QueryMode) String ¶
func (x ExecuteSqlRequest_QueryMode) String() string
type GetSessionRequest ¶
The request for [GetSession][google.spanner.v1.Spanner.GetSession].
type GetSessionRequest struct {
// Required. The name of the session to retrieve.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*GetSessionRequest) Descriptor ¶
func (*GetSessionRequest) Descriptor() ([]byte, []int)
func (*GetSessionRequest) GetName ¶
func (m *GetSessionRequest) GetName() string
func (*GetSessionRequest) ProtoMessage ¶
func (*GetSessionRequest) ProtoMessage()
func (*GetSessionRequest) Reset ¶
func (m *GetSessionRequest) Reset()
func (*GetSessionRequest) String ¶
func (m *GetSessionRequest) String() string
type KeyRange ¶
KeyRange represents a range of rows in a table or index.
A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key.
Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described [here][google.spanner.v1.TypeCode].
For example, consider the following table definition:
CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate);
The following keys name rows in this table:
["Bob", "2014-09-23"] ["Alfred", "2015-06-12"]
Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`.
Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015:
"start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"]
Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included.
For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000:
"start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"]
The next example retrieves all events for `"Bob"`:
"start_closed": ["Bob"] "end_closed": ["Bob"]
To retrieve events before the year 2000:
"start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"]
The following range includes all rows in the table:
"start_closed": [] "end_closed": []
This range returns all users whose `UserName` begins with any character from A to C:
"start_closed": ["A"] "end_open": ["D"]
This range returns all users whose `UserName` begins with B:
"start_closed": ["B"] "end_open": ["C"]
Key ranges honor column sort order. For example, suppose a table is defined as follows:
CREATE TABLE DescendingSortedTable {
Key INT64,
...
) PRIMARY KEY(Key DESC);
The following range retrieves all rows with key values between 1 and 100 inclusive:
"start_closed": ["100"] "end_closed": ["1"]
Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.
type KeyRange struct {
// The start key must be provided. It can be either closed or open.
//
// Types that are valid to be assigned to StartKeyType:
// *KeyRange_StartClosed
// *KeyRange_StartOpen
StartKeyType isKeyRange_StartKeyType `protobuf_oneof:"start_key_type"`
// The end key must be provided. It can be either closed or open.
//
// Types that are valid to be assigned to EndKeyType:
// *KeyRange_EndClosed
// *KeyRange_EndOpen
EndKeyType isKeyRange_EndKeyType `protobuf_oneof:"end_key_type"`
}
func (*KeyRange) Descriptor ¶
func (*KeyRange) Descriptor() ([]byte, []int)
func (*KeyRange) GetEndClosed ¶
func (m *KeyRange) GetEndClosed() *google_protobuf1.ListValue
func (*KeyRange) GetEndKeyType ¶
func (m *KeyRange) GetEndKeyType() isKeyRange_EndKeyType
func (*KeyRange) GetEndOpen ¶
func (m *KeyRange) GetEndOpen() *google_protobuf1.ListValue
func (*KeyRange) GetStartClosed ¶
func (m *KeyRange) GetStartClosed() *google_protobuf1.ListValue
func (*KeyRange) GetStartKeyType ¶
func (m *KeyRange) GetStartKeyType() isKeyRange_StartKeyType
func (*KeyRange) GetStartOpen ¶
func (m *KeyRange) GetStartOpen() *google_protobuf1.ListValue
func (*KeyRange) ProtoMessage ¶
func (*KeyRange) ProtoMessage()
func (*KeyRange) Reset ¶
func (m *KeyRange) Reset()
func (*KeyRange) String ¶
func (m *KeyRange) String() string
func (*KeyRange) XXX_OneofFuncs ¶
func (*KeyRange) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type KeyRange_EndClosed ¶
type KeyRange_EndClosed struct {
EndClosed *google_protobuf1.ListValue `protobuf:"bytes,3,opt,name=end_closed,json=endClosed,oneof"`
}
type KeyRange_EndOpen ¶
type KeyRange_EndOpen struct {
EndOpen *google_protobuf1.ListValue `protobuf:"bytes,4,opt,name=end_open,json=endOpen,oneof"`
}
type KeyRange_StartClosed ¶
type KeyRange_StartClosed struct {
StartClosed *google_protobuf1.ListValue `protobuf:"bytes,1,opt,name=start_closed,json=startClosed,oneof"`
}
type KeyRange_StartOpen ¶
type KeyRange_StartOpen struct {
StartOpen *google_protobuf1.ListValue `protobuf:"bytes,2,opt,name=start_open,json=startOpen,oneof"`
}
type KeySet ¶
`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way.
If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.
type KeySet struct {
// A list of specific keys. Entries in `keys` should have exactly as
// many elements as there are columns in the primary or index key
// with which this `KeySet` is used. Individual key values are
// encoded as described [here][google.spanner.v1.TypeCode].
Keys []*google_protobuf1.ListValue `protobuf:"bytes,1,rep,name=keys" json:"keys,omitempty"`
// A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
// key range specifications.
Ranges []*KeyRange `protobuf:"bytes,2,rep,name=ranges" json:"ranges,omitempty"`
// For convenience `all` can be set to `true` to indicate that this
// `KeySet` matches all keys in the table or index. Note that any keys
// specified in `keys` or `ranges` are only yielded once.
All bool `protobuf:"varint,3,opt,name=all" json:"all,omitempty"`
}
func (*KeySet) Descriptor ¶
func (*KeySet) Descriptor() ([]byte, []int)
func (*KeySet) GetAll ¶
func (m *KeySet) GetAll() bool
func (*KeySet) GetKeys ¶
func (m *KeySet) GetKeys() []*google_protobuf1.ListValue
func (*KeySet) GetRanges ¶
func (m *KeySet) GetRanges() []*KeyRange
func (*KeySet) ProtoMessage ¶
func (*KeySet) ProtoMessage()
func (*KeySet) Reset ¶
func (m *KeySet) Reset()
func (*KeySet) String ¶
func (m *KeySet) String() string
type Mutation ¶
A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a [Commit][google.spanner.v1.Spanner.Commit] call.
type Mutation struct {
// Required. The operation to perform.
//
// Types that are valid to be assigned to Operation:
// *Mutation_Insert
// *Mutation_Update
// *Mutation_InsertOrUpdate
// *Mutation_Replace
// *Mutation_Delete_
Operation isMutation_Operation `protobuf_oneof:"operation"`
}
func (*Mutation) Descriptor ¶
func (*Mutation) Descriptor() ([]byte, []int)
func (*Mutation) GetDelete ¶
func (m *Mutation) GetDelete() *Mutation_Delete
func (*Mutation) GetInsert ¶
func (m *Mutation) GetInsert() *Mutation_Write
func (*Mutation) GetInsertOrUpdate ¶
func (m *Mutation) GetInsertOrUpdate() *Mutation_Write
func (*Mutation) GetOperation ¶
func (m *Mutation) GetOperation() isMutation_Operation
func (*Mutation) GetReplace ¶
func (m *Mutation) GetReplace() *Mutation_Write
func (*Mutation) GetUpdate ¶
func (m *Mutation) GetUpdate() *Mutation_Write
func (*Mutation) ProtoMessage ¶
func (*Mutation) ProtoMessage()
func (*Mutation) Reset ¶
func (m *Mutation) Reset()
func (*Mutation) String ¶
func (m *Mutation) String() string
func (*Mutation) XXX_OneofFuncs ¶
func (*Mutation) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type Mutation_Delete ¶
Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
type Mutation_Delete struct {
// Required. The table whose rows will be deleted.
Table string `protobuf:"bytes,1,opt,name=table" json:"table,omitempty"`
// Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete.
KeySet *KeySet `protobuf:"bytes,2,opt,name=key_set,json=keySet" json:"key_set,omitempty"`
}
func (*Mutation_Delete) Descriptor ¶
func (*Mutation_Delete) Descriptor() ([]byte, []int)
func (*Mutation_Delete) GetKeySet ¶
func (m *Mutation_Delete) GetKeySet() *KeySet
func (*Mutation_Delete) GetTable ¶
func (m *Mutation_Delete) GetTable() string
func (*Mutation_Delete) ProtoMessage ¶
func (*Mutation_Delete) ProtoMessage()
func (*Mutation_Delete) Reset ¶
func (m *Mutation_Delete) Reset()
func (*Mutation_Delete) String ¶
func (m *Mutation_Delete) String() string
type Mutation_Delete_ ¶
type Mutation_Delete_ struct {
Delete *Mutation_Delete `protobuf:"bytes,5,opt,name=delete,oneof"`
}
type Mutation_Insert ¶
type Mutation_Insert struct {
Insert *Mutation_Write `protobuf:"bytes,1,opt,name=insert,oneof"`
}
type Mutation_InsertOrUpdate ¶
type Mutation_InsertOrUpdate struct {
InsertOrUpdate *Mutation_Write `protobuf:"bytes,3,opt,name=insert_or_update,json=insertOrUpdate,oneof"`
}
type Mutation_Replace ¶
type Mutation_Replace struct {
Replace *Mutation_Write `protobuf:"bytes,4,opt,name=replace,oneof"`
}
type Mutation_Update ¶
type Mutation_Update struct {
Update *Mutation_Write `protobuf:"bytes,2,opt,name=update,oneof"`
}
type Mutation_Write ¶
Arguments to [insert][google.spanner.v1.Mutation.insert], [update][google.spanner.v1.Mutation.update], [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and [replace][google.spanner.v1.Mutation.replace] operations.
type Mutation_Write struct {
// Required. The table whose rows will be written.
Table string `protobuf:"bytes,1,opt,name=table" json:"table,omitempty"`
// The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
//
// The list of columns must contain enough columns to allow
// Cloud Spanner to derive values for all primary key columns in the
// row(s) to be modified.
Columns []string `protobuf:"bytes,2,rep,name=columns" json:"columns,omitempty"`
// The values to be written. `values` can contain more than one
// list of values. If it does, then multiple rows are written, one
// for each entry in `values`. Each list in `values` must have
// exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns]
// above. Sending multiple lists is equivalent to sending multiple
// `Mutation`s, each containing one `values` entry and repeating
// [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are
// encoded as described [here][google.spanner.v1.TypeCode].
Values []*google_protobuf1.ListValue `protobuf:"bytes,3,rep,name=values" json:"values,omitempty"`
}
func (*Mutation_Write) Descriptor ¶
func (*Mutation_Write) Descriptor() ([]byte, []int)
func (*Mutation_Write) GetColumns ¶
func (m *Mutation_Write) GetColumns() []string
func (*Mutation_Write) GetTable ¶
func (m *Mutation_Write) GetTable() string
func (*Mutation_Write) GetValues ¶
func (m *Mutation_Write) GetValues() []*google_protobuf1.ListValue
func (*Mutation_Write) ProtoMessage ¶
func (*Mutation_Write) ProtoMessage()
func (*Mutation_Write) Reset ¶
func (m *Mutation_Write) Reset()
func (*Mutation_Write) String ¶
func (m *Mutation_Write) String() string
type PartialResultSet ¶
Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.
type PartialResultSet struct {
// Metadata about the result set, such as row type information.
// Only present in the first response.
Metadata *ResultSetMetadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
// A streamed result set consists of a stream of values, which might
// be split into many `PartialResultSet` messages to accommodate
// large rows and/or large values. Every N complete values defines a
// row, where N is equal to the number of entries in
// [metadata.row_type.fields][google.spanner.v1.StructType.fields].
//
// Most values are encoded based on type as described
// [here][google.spanner.v1.TypeCode].
//
// It is possible that the last value in values is "chunked",
// meaning that the rest of the value is sent in subsequent
// `PartialResultSet`(s). This is denoted by the [chunked_value][google.spanner.v1.PartialResultSet.chunked_value]
// field. Two or more chunked values can be merged to form a
// complete value as follows:
//
// * `bool/number/null`: cannot be chunked
// * `string`: concatenate the strings
// * `list`: concatenate the lists. If the last element in a list is a
// `string`, `list`, or `object`, merge it with the first element in
// the next list by applying these rules recursively.
// * `object`: concatenate the (field name, field value) pairs. If a
// field name is duplicated, then apply these rules recursively
// to merge the field values.
//
// Some examples of merging:
//
// # Strings are concatenated.
// "foo", "bar" => "foobar"
//
// # Lists of non-strings are concatenated.
// [2, 3], [4] => [2, 3, 4]
//
// # Lists are concatenated, but the last and first elements are merged
// # because they are strings.
// ["a", "b"], ["c", "d"] => ["a", "bc", "d"]
//
// # Lists are concatenated, but the last and first elements are merged
// # because they are lists. Recursively, the last and first elements
// # of the inner lists are merged because they are strings.
// ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]
//
// # Non-overlapping object fields are combined.
// {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}
//
// # Overlapping object fields are merged.
// {"a": "1"}, {"a": "2"} => {"a": "12"}
//
// # Examples of merging objects containing lists of strings.
// {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}
//
// For a more complete example, suppose a streaming SQL query is
// yielding a result set whose rows contain a single string
// field. The following `PartialResultSet`s might be yielded:
//
// {
// "metadata": { ... }
// "values": ["Hello", "W"]
// "chunked_value": true
// "resume_token": "Af65..."
// }
// {
// "values": ["orl"]
// "chunked_value": true
// "resume_token": "Bqp2..."
// }
// {
// "values": ["d"]
// "resume_token": "Zx1B..."
// }
//
// This sequence of `PartialResultSet`s encodes two rows, one
// containing the field value `"Hello"`, and a second containing the
// field value `"World" = "W" + "orl" + "d"`.
Values []*google_protobuf1.Value `protobuf:"bytes,2,rep,name=values" json:"values,omitempty"`
// If true, then the final value in [values][google.spanner.v1.PartialResultSet.values] is chunked, and must
// be combined with more values from subsequent `PartialResultSet`s
// to obtain a complete field value.
ChunkedValue bool `protobuf:"varint,3,opt,name=chunked_value,json=chunkedValue" json:"chunked_value,omitempty"`
// Streaming calls might be interrupted for a variety of reasons, such
// as TCP connection loss. If this occurs, the stream of results can
// be resumed by re-sending the original request and including
// `resume_token`. Note that executing any other transaction in the
// same session invalidates the token.
ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
// Query plan and execution statistics for the query that produced this
// streaming result set. These can be requested by setting
// [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] and are sent
// only once with the last response in the stream.
Stats *ResultSetStats `protobuf:"bytes,5,opt,name=stats" json:"stats,omitempty"`
}
func (*PartialResultSet) Descriptor ¶
func (*PartialResultSet) Descriptor() ([]byte, []int)
func (*PartialResultSet) GetChunkedValue ¶
func (m *PartialResultSet) GetChunkedValue() bool
func (*PartialResultSet) GetMetadata ¶
func (m *PartialResultSet) GetMetadata() *ResultSetMetadata
func (*PartialResultSet) GetResumeToken ¶
func (m *PartialResultSet) GetResumeToken() []byte
func (*PartialResultSet) GetStats ¶
func (m *PartialResultSet) GetStats() *ResultSetStats
func (*PartialResultSet) GetValues ¶
func (m *PartialResultSet) GetValues() []*google_protobuf1.Value
func (*PartialResultSet) ProtoMessage ¶
func (*PartialResultSet) ProtoMessage()
func (*PartialResultSet) Reset ¶
func (m *PartialResultSet) Reset()
func (*PartialResultSet) String ¶
func (m *PartialResultSet) String() string
type PlanNode ¶
Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
type PlanNode struct {
// The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
Index int32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
// Used to determine the type of node. May be needed for visualizing
// different kinds of nodes differently. For example, If the node is a
// [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation
// which can be used to directly embed a description of the node in its
// parent.
Kind PlanNode_Kind `protobuf:"varint,2,opt,name=kind,enum=google.spanner.v1.PlanNode_Kind" json:"kind,omitempty"`
// The display name for the node.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
// List of child node `index`es and their relationship to this parent.
ChildLinks []*PlanNode_ChildLink `protobuf:"bytes,4,rep,name=child_links,json=childLinks" json:"child_links,omitempty"`
// Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
ShortRepresentation *PlanNode_ShortRepresentation `protobuf:"bytes,5,opt,name=short_representation,json=shortRepresentation" json:"short_representation,omitempty"`
// Attributes relevant to the node contained in a group of key-value pairs.
// For example, a Parameter Reference node could have the following
// information in its metadata:
//
// {
// "parameter_reference": "param1",
// "parameter_type": "array"
// }
Metadata *google_protobuf1.Struct `protobuf:"bytes,6,opt,name=metadata" json:"metadata,omitempty"`
// The execution statistics associated with the node, contained in a group of
// key-value pairs. Only present if the plan was returned as a result of a
// profile query. For example, number of executions, number of rows/time per
// execution etc.
ExecutionStats *google_protobuf1.Struct `protobuf:"bytes,7,opt,name=execution_stats,json=executionStats" json:"execution_stats,omitempty"`
}
func (*PlanNode) Descriptor ¶
func (*PlanNode) Descriptor() ([]byte, []int)
func (*PlanNode) GetChildLinks ¶
func (m *PlanNode) GetChildLinks() []*PlanNode_ChildLink
func (*PlanNode) GetDisplayName ¶
func (m *PlanNode) GetDisplayName() string
func (*PlanNode) GetExecutionStats ¶
func (m *PlanNode) GetExecutionStats() *google_protobuf1.Struct
func (*PlanNode) GetIndex ¶
func (m *PlanNode) GetIndex() int32
func (*PlanNode) GetKind ¶
func (m *PlanNode) GetKind() PlanNode_Kind
func (*PlanNode) GetMetadata ¶
func (m *PlanNode) GetMetadata() *google_protobuf1.Struct
func (*PlanNode) GetShortRepresentation ¶
func (m *PlanNode) GetShortRepresentation() *PlanNode_ShortRepresentation
func (*PlanNode) ProtoMessage ¶
func (*PlanNode) ProtoMessage()
func (*PlanNode) Reset ¶
func (m *PlanNode) Reset()
func (*PlanNode) String ¶
func (m *PlanNode) String() string
type PlanNode_ChildLink ¶
Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].
type PlanNode_ChildLink struct {
// The node to which the link points.
ChildIndex int32 `protobuf:"varint,1,opt,name=child_index,json=childIndex" json:"child_index,omitempty"`
// The type of the link. For example, in Hash Joins this could be used to
// distinguish between the build child and the probe child, or in the case
// of the child being an output variable, to represent the tag associated
// with the output variable.
Type string `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
// Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds
// to an output variable of the parent node. The field carries the name of
// the output variable.
// For example, a `TableScan` operator that reads rows from a table will
// have child links to the `SCALAR` nodes representing the output variables
// created for each column that is read by the operator. The corresponding
// `variable` fields will be set to the variable names assigned to the
// columns.
Variable string `protobuf:"bytes,3,opt,name=variable" json:"variable,omitempty"`
}
func (*PlanNode_ChildLink) Descriptor ¶
func (*PlanNode_ChildLink) Descriptor() ([]byte, []int)
func (*PlanNode_ChildLink) GetChildIndex ¶
func (m *PlanNode_ChildLink) GetChildIndex() int32
func (*PlanNode_ChildLink) GetType ¶
func (m *PlanNode_ChildLink) GetType() string
func (*PlanNode_ChildLink) GetVariable ¶
func (m *PlanNode_ChildLink) GetVariable() string
func (*PlanNode_ChildLink) ProtoMessage ¶
func (*PlanNode_ChildLink) ProtoMessage()
func (*PlanNode_ChildLink) Reset ¶
func (m *PlanNode_ChildLink) Reset()
func (*PlanNode_ChildLink) String ¶
func (m *PlanNode_ChildLink) String() string
type PlanNode_Kind ¶
The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of nodes that can appear in a query plan.
type PlanNode_Kind int32
const (
// Not specified.
PlanNode_KIND_UNSPECIFIED PlanNode_Kind = 0
// Denotes a Relational operator node in the expression tree. Relational
// operators represent iterative processing of rows during query execution.
// For example, a `TableScan` operation that reads rows from a table.
PlanNode_RELATIONAL PlanNode_Kind = 1
// Denotes a Scalar node in the expression tree. Scalar nodes represent
// non-iterable entities in the query plan. For example, constants or
// arithmetic operators appearing inside predicate expressions or references
// to column names.
PlanNode_SCALAR PlanNode_Kind = 2
)
func (PlanNode_Kind) EnumDescriptor ¶
func (PlanNode_Kind) EnumDescriptor() ([]byte, []int)
func (PlanNode_Kind) String ¶
func (x PlanNode_Kind) String() string
type PlanNode_ShortRepresentation ¶
Condensed representation of a node and its subtree. Only present for `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
type PlanNode_ShortRepresentation struct {
// A string representation of the expression subtree rooted at this node.
Description string `protobuf:"bytes,1,opt,name=description" json:"description,omitempty"`
// A mapping of (subquery variable name) -> (subquery node id) for cases
// where the `description` string of this node references a `SCALAR`
// subquery contained in the expression subtree rooted at this node. The
// referenced `SCALAR` subquery may not necessarily be a direct child of
// this node.
Subqueries map[string]int32 `protobuf:"bytes,2,rep,name=subqueries" json:"subqueries,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value"`
}
func (*PlanNode_ShortRepresentation) Descriptor ¶
func (*PlanNode_ShortRepresentation) Descriptor() ([]byte, []int)
func (*PlanNode_ShortRepresentation) GetDescription ¶
func (m *PlanNode_ShortRepresentation) GetDescription() string
func (*PlanNode_ShortRepresentation) GetSubqueries ¶
func (m *PlanNode_ShortRepresentation) GetSubqueries() map[string]int32
func (*PlanNode_ShortRepresentation) ProtoMessage ¶
func (*PlanNode_ShortRepresentation) ProtoMessage()
func (*PlanNode_ShortRepresentation) Reset ¶
func (m *PlanNode_ShortRepresentation) Reset()
func (*PlanNode_ShortRepresentation) String ¶
func (m *PlanNode_ShortRepresentation) String() string
type QueryPlan ¶
Contains an ordered list of nodes appearing in the query plan.
type QueryPlan struct {
// The nodes in the query plan. Plan nodes are returned in pre-order starting
// with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id` corresponds to its index in
// `plan_nodes`.
PlanNodes []*PlanNode `protobuf:"bytes,1,rep,name=plan_nodes,json=planNodes" json:"plan_nodes,omitempty"`
}
func (*QueryPlan) Descriptor ¶
func (*QueryPlan) Descriptor() ([]byte, []int)
func (*QueryPlan) GetPlanNodes ¶
func (m *QueryPlan) GetPlanNodes() []*PlanNode
func (*QueryPlan) ProtoMessage ¶
func (*QueryPlan) ProtoMessage()
func (*QueryPlan) Reset ¶
func (m *QueryPlan) Reset()
func (*QueryPlan) String ¶
func (m *QueryPlan) String() string
type ReadRequest ¶
The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].
type ReadRequest struct {
// Required. The session in which the read should be performed.
Session string `protobuf:"bytes,1,opt,name=session" json:"session,omitempty"`
// The transaction to use. If none is provided, the default is a
// temporary read-only transaction with strong concurrency.
Transaction *TransactionSelector `protobuf:"bytes,2,opt,name=transaction" json:"transaction,omitempty"`
// Required. The name of the table in the database to be read.
Table string `protobuf:"bytes,3,opt,name=table" json:"table,omitempty"`
// 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.
Index string `protobuf:"bytes,4,opt,name=index" json:"index,omitempty"`
// The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
// this request.
Columns []string `protobuf:"bytes,5,rep,name=columns" json:"columns,omitempty"`
// 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].
//
// 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).
//
// 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.
KeySet *KeySet `protobuf:"bytes,6,opt,name=key_set,json=keySet" json:"key_set,omitempty"`
// If greater than zero, only the first `limit` rows are yielded. If `limit`
// is zero, the default is no limit.
Limit int64 `protobuf:"varint,8,opt,name=limit" json:"limit,omitempty"`
// 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.
ResumeToken []byte `protobuf:"bytes,9,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
}
func (*ReadRequest) Descriptor ¶
func (*ReadRequest) Descriptor() ([]byte, []int)
func (*ReadRequest) GetColumns ¶
func (m *ReadRequest) GetColumns() []string
func (*ReadRequest) GetIndex ¶
func (m *ReadRequest) GetIndex() string
func (*ReadRequest) GetKeySet ¶
func (m *ReadRequest) GetKeySet() *KeySet
func (*ReadRequest) GetLimit ¶
func (m *ReadRequest) GetLimit() int64
func (*ReadRequest) GetResumeToken ¶
func (m *ReadRequest) GetResumeToken() []byte
func (*ReadRequest) GetSession ¶
func (m *ReadRequest) GetSession() string
func (*ReadRequest) GetTable ¶
func (m *ReadRequest) GetTable() string
func (*ReadRequest) GetTransaction ¶
func (m *ReadRequest) GetTransaction() *TransactionSelector
func (*ReadRequest) ProtoMessage ¶
func (*ReadRequest) ProtoMessage()
func (*ReadRequest) Reset ¶
func (m *ReadRequest) Reset()
func (*ReadRequest) String ¶
func (m *ReadRequest) String() string
type ResultSet ¶
Results from [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
type ResultSet struct {
// Metadata about the result set, such as row type information.
Metadata *ResultSetMetadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
// Each element in `rows` is a row whose format is defined by
// [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. The ith element
// in each row matches the ith field in
// [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. Elements are
// encoded based on type as described
// [here][google.spanner.v1.TypeCode].
Rows []*google_protobuf1.ListValue `protobuf:"bytes,2,rep,name=rows" json:"rows,omitempty"`
// Query plan and execution statistics for the query that produced this
// result set. These can be requested by setting
// [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
Stats *ResultSetStats `protobuf:"bytes,3,opt,name=stats" json:"stats,omitempty"`
}
func (*ResultSet) Descriptor ¶
func (*ResultSet) Descriptor() ([]byte, []int)
func (*ResultSet) GetMetadata ¶
func (m *ResultSet) GetMetadata() *ResultSetMetadata
func (*ResultSet) GetRows ¶
func (m *ResultSet) GetRows() []*google_protobuf1.ListValue
func (*ResultSet) GetStats ¶
func (m *ResultSet) GetStats() *ResultSetStats
func (*ResultSet) ProtoMessage ¶
func (*ResultSet) ProtoMessage()
func (*ResultSet) Reset ¶
func (m *ResultSet) Reset()
func (*ResultSet) String ¶
func (m *ResultSet) String() string
type ResultSetMetadata ¶
Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
type ResultSetMetadata struct {
// Indicates the field names and types for the rows in the result
// set. For example, a SQL query like `"SELECT UserId, UserName FROM
// Users"` could return a `row_type` value like:
//
// "fields": [
// { "name": "UserId", "type": { "code": "INT64" } },
// { "name": "UserName", "type": { "code": "STRING" } },
// ]
RowType *StructType `protobuf:"bytes,1,opt,name=row_type,json=rowType" json:"row_type,omitempty"`
// If the read or SQL query began a transaction as a side-effect, the
// information about the new transaction is yielded here.
Transaction *Transaction `protobuf:"bytes,2,opt,name=transaction" json:"transaction,omitempty"`
}
func (*ResultSetMetadata) Descriptor ¶
func (*ResultSetMetadata) Descriptor() ([]byte, []int)
func (*ResultSetMetadata) GetRowType ¶
func (m *ResultSetMetadata) GetRowType() *StructType
func (*ResultSetMetadata) GetTransaction ¶
func (m *ResultSetMetadata) GetTransaction() *Transaction
func (*ResultSetMetadata) ProtoMessage ¶
func (*ResultSetMetadata) ProtoMessage()
func (*ResultSetMetadata) Reset ¶
func (m *ResultSetMetadata) Reset()
func (*ResultSetMetadata) String ¶
func (m *ResultSetMetadata) String() string
type ResultSetStats ¶
Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
type ResultSetStats struct {
// [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
QueryPlan *QueryPlan `protobuf:"bytes,1,opt,name=query_plan,json=queryPlan" json:"query_plan,omitempty"`
// Aggregated statistics from the execution of the query. Only present when
// the query is profiled. For example, a query could return the statistics as
// follows:
//
// {
// "rows_returned": "3",
// "elapsed_time": "1.22 secs",
// "cpu_time": "1.19 secs"
// }
QueryStats *google_protobuf1.Struct `protobuf:"bytes,2,opt,name=query_stats,json=queryStats" json:"query_stats,omitempty"`
}
func (*ResultSetStats) Descriptor ¶
func (*ResultSetStats) Descriptor() ([]byte, []int)
func (*ResultSetStats) GetQueryPlan ¶
func (m *ResultSetStats) GetQueryPlan() *QueryPlan
func (*ResultSetStats) GetQueryStats ¶
func (m *ResultSetStats) GetQueryStats() *google_protobuf1.Struct
func (*ResultSetStats) ProtoMessage ¶
func (*ResultSetStats) ProtoMessage()
func (*ResultSetStats) Reset ¶
func (m *ResultSetStats) Reset()
func (*ResultSetStats) String ¶
func (m *ResultSetStats) String() string
type RollbackRequest ¶
The request for [Rollback][google.spanner.v1.Spanner.Rollback].
type RollbackRequest struct {
// Required. The session in which the transaction to roll back is running.
Session string `protobuf:"bytes,1,opt,name=session" json:"session,omitempty"`
// Required. The transaction to roll back.
TransactionId []byte `protobuf:"bytes,2,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"`
}
func (*RollbackRequest) Descriptor ¶
func (*RollbackRequest) Descriptor() ([]byte, []int)
func (*RollbackRequest) GetSession ¶
func (m *RollbackRequest) GetSession() string
func (*RollbackRequest) GetTransactionId ¶
func (m *RollbackRequest) GetTransactionId() []byte
func (*RollbackRequest) ProtoMessage ¶
func (*RollbackRequest) ProtoMessage()
func (*RollbackRequest) Reset ¶
func (m *RollbackRequest) Reset()
func (*RollbackRequest) String ¶
func (m *RollbackRequest) String() string
type Session ¶
A session in the Cloud Spanner API.
type Session struct {
// Required. The name of the session.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*Session) Descriptor ¶
func (*Session) Descriptor() ([]byte, []int)
func (*Session) GetName ¶
func (m *Session) GetName() string
func (*Session) ProtoMessage ¶
func (*Session) ProtoMessage()
func (*Session) Reset ¶
func (m *Session) Reset()
func (*Session) String ¶
func (m *Session) String() string
type SpannerClient ¶
type SpannerClient interface {
// Creates a new session. A session can be used to perform
// transactions that read and/or modify data in a Cloud Spanner database.
// Sessions are meant to be reused for many consecutive
// transactions.
//
// Sessions can only execute one transaction at a time. To execute
// multiple concurrent read-write/write-only transactions, create
// multiple sessions. Note that standalone reads and queries use a
// transaction internally, and count toward the one transaction
// limit.
//
// Cloud Spanner limits the number of sessions that can exist at any given
// time; thus, it is a good idea to delete idle and/or unneeded sessions.
// Aside from explicit deletes, Cloud Spanner can delete sessions for which no
// operations are sent for more than an hour. If a session is deleted,
// requests to it return `NOT_FOUND`.
//
// Idle sessions can be kept alive by sending a trivial SQL query
// periodically, e.g., `"SELECT 1"`.
CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Gets a session. Returns `NOT_FOUND` if the session does not exist.
// This is mainly useful for determining whether a session is still
// alive.
GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Ends a session, releasing server resources associated with it.
DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*google_protobuf4.Empty, error)
// Executes an SQL query, returning all rows in a single reply. This
// method cannot be used to return a result set larger than 10 MiB;
// if the query yields more data than that, the query fails with
// a `FAILED_PRECONDITION` error.
//
// Queries inside read-write transactions might return `ABORTED`. If
// this occurs, the application should restart the transaction from
// the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
//
// Larger result sets can be fetched in streaming fashion by calling
// [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
ExecuteSql(ctx context.Context, in *ExecuteSqlRequest, opts ...grpc.CallOption) (*ResultSet, error)
// Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result
// set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there
// is no limit on the size of the returned result set. However, no
// individual row in the result set can exceed 100 MiB, and no
// column value can exceed 10 MiB.
ExecuteStreamingSql(ctx context.Context, in *ExecuteSqlRequest, opts ...grpc.CallOption) (Spanner_ExecuteStreamingSqlClient, error)
// Reads rows from the database using key lookups and scans, as a
// simple key/value style alternative to
// [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to
// return a result set larger than 10 MiB; if the read matches more
// data than that, the read fails with a `FAILED_PRECONDITION`
// error.
//
// Reads inside read-write transactions might return `ABORTED`. If
// this occurs, the application should restart the transaction from
// the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
//
// Larger result sets can be yielded in streaming fashion by calling
// [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
Read(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (*ResultSet, error)
// Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a
// stream. Unlike [Read][google.spanner.v1.Spanner.Read], there is no limit on the
// size of the returned result set. However, no individual row in
// the result set can exceed 100 MiB, and no column value can exceed
// 10 MiB.
StreamingRead(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (Spanner_StreamingReadClient, error)
// Begins a new transaction. This step can often be skipped:
// [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
// [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a
// side-effect.
BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*Transaction, error)
// Commits a transaction. The request includes the mutations to be
// applied to rows in the database.
//
// `Commit` might return an `ABORTED` error. This can occur at any time;
// commonly, the cause is conflicts with concurrent
// transactions. However, it can also happen for a variety of other
// reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
// the transaction from the beginning, re-using the same session.
Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
// Rolls back a transaction, releasing any locks it holds. It is a good
// idea to call this for any transaction that includes one or more
// [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and
// ultimately decides not to commit.
//
// `Rollback` returns `OK` if it successfully aborts the transaction, the
// transaction was already aborted, or the transaction is not
// found. `Rollback` never returns `ABORTED`.
Rollback(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*google_protobuf4.Empty, error)
}
func NewSpannerClient ¶
func NewSpannerClient(cc *grpc.ClientConn) SpannerClient
type SpannerServer ¶
type SpannerServer interface {
// Creates a new session. A session can be used to perform
// transactions that read and/or modify data in a Cloud Spanner database.
// Sessions are meant to be reused for many consecutive
// transactions.
//
// Sessions can only execute one transaction at a time. To execute
// multiple concurrent read-write/write-only transactions, create
// multiple sessions. Note that standalone reads and queries use a
// transaction internally, and count toward the one transaction
// limit.
//
// Cloud Spanner limits the number of sessions that can exist at any given
// time; thus, it is a good idea to delete idle and/or unneeded sessions.
// Aside from explicit deletes, Cloud Spanner can delete sessions for which no
// operations are sent for more than an hour. If a session is deleted,
// requests to it return `NOT_FOUND`.
//
// Idle sessions can be kept alive by sending a trivial SQL query
// periodically, e.g., `"SELECT 1"`.
CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
// Gets a session. Returns `NOT_FOUND` if the session does not exist.
// This is mainly useful for determining whether a session is still
// alive.
GetSession(context.Context, *GetSessionRequest) (*Session, error)
// Ends a session, releasing server resources associated with it.
DeleteSession(context.Context, *DeleteSessionRequest) (*google_protobuf4.Empty, error)
// Executes an SQL query, returning all rows in a single reply. This
// method cannot be used to return a result set larger than 10 MiB;
// if the query yields more data than that, the query fails with
// a `FAILED_PRECONDITION` error.
//
// Queries inside read-write transactions might return `ABORTED`. If
// this occurs, the application should restart the transaction from
// the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
//
// Larger result sets can be fetched in streaming fashion by calling
// [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
ExecuteSql(context.Context, *ExecuteSqlRequest) (*ResultSet, error)
// Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result
// set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there
// is no limit on the size of the returned result set. However, no
// individual row in the result set can exceed 100 MiB, and no
// column value can exceed 10 MiB.
ExecuteStreamingSql(*ExecuteSqlRequest, Spanner_ExecuteStreamingSqlServer) error
// Reads rows from the database using key lookups and scans, as a
// simple key/value style alternative to
// [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to
// return a result set larger than 10 MiB; if the read matches more
// data than that, the read fails with a `FAILED_PRECONDITION`
// error.
//
// Reads inside read-write transactions might return `ABORTED`. If
// this occurs, the application should restart the transaction from
// the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.
//
// Larger result sets can be yielded in streaming fashion by calling
// [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
Read(context.Context, *ReadRequest) (*ResultSet, error)
// Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a
// stream. Unlike [Read][google.spanner.v1.Spanner.Read], there is no limit on the
// size of the returned result set. However, no individual row in
// the result set can exceed 100 MiB, and no column value can exceed
// 10 MiB.
StreamingRead(*ReadRequest, Spanner_StreamingReadServer) error
// Begins a new transaction. This step can often be skipped:
// [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
// [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a
// side-effect.
BeginTransaction(context.Context, *BeginTransactionRequest) (*Transaction, error)
// Commits a transaction. The request includes the mutations to be
// applied to rows in the database.
//
// `Commit` might return an `ABORTED` error. This can occur at any time;
// commonly, the cause is conflicts with concurrent
// transactions. However, it can also happen for a variety of other
// reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
// the transaction from the beginning, re-using the same session.
Commit(context.Context, *CommitRequest) (*CommitResponse, error)
// Rolls back a transaction, releasing any locks it holds. It is a good
// idea to call this for any transaction that includes one or more
// [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and
// ultimately decides not to commit.
//
// `Rollback` returns `OK` if it successfully aborts the transaction, the
// transaction was already aborted, or the transaction is not
// found. `Rollback` never returns `ABORTED`.
Rollback(context.Context, *RollbackRequest) (*google_protobuf4.Empty, error)
}
type Spanner_ExecuteStreamingSqlClient ¶
type Spanner_ExecuteStreamingSqlClient interface {
Recv() (*PartialResultSet, error)
grpc.ClientStream
}
type Spanner_ExecuteStreamingSqlServer ¶
type Spanner_ExecuteStreamingSqlServer interface {
Send(*PartialResultSet) error
grpc.ServerStream
}
type Spanner_StreamingReadClient ¶
type Spanner_StreamingReadClient interface {
Recv() (*PartialResultSet, error)
grpc.ClientStream
}
type Spanner_StreamingReadServer ¶
type Spanner_StreamingReadServer interface {
Send(*PartialResultSet) error
grpc.ServerStream
}
type StructType ¶
`StructType` defines the fields of a [STRUCT][google.spanner.v1.TypeCode.STRUCT] type.
type StructType struct {
// The list of fields that make up this struct. Order is
// significant, because values of this struct type are represented as
// lists, where the order of field values matches the order of
// fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields
// matches the order of columns in a read request, or the order of
// fields in the `SELECT` clause of a query.
Fields []*StructType_Field `protobuf:"bytes,1,rep,name=fields" json:"fields,omitempty"`
}
func (*StructType) Descriptor ¶
func (*StructType) Descriptor() ([]byte, []int)
func (*StructType) GetFields ¶
func (m *StructType) GetFields() []*StructType_Field
func (*StructType) ProtoMessage ¶
func (*StructType) ProtoMessage()
func (*StructType) Reset ¶
func (m *StructType) Reset()
func (*StructType) String ¶
func (m *StructType) String() string
type StructType_Field ¶
Message representing a single field of a struct.
type StructType_Field struct {
// The name of the field. For reads, this is the column name. For
// SQL queries, it is the column alias (e.g., `"Word"` in the
// query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
// `"ColName"` in the query `"SELECT ColName FROM Table"`). Some
// columns might have an empty name (e.g., !"SELECT
// UPPER(ColName)"`). Note that a query result can contain
// multiple fields with the same name.
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The type of the field.
Type *Type `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
}
func (*StructType_Field) Descriptor ¶
func (*StructType_Field) Descriptor() ([]byte, []int)
func (*StructType_Field) GetName ¶
func (m *StructType_Field) GetName() string
func (*StructType_Field) GetType ¶
func (m *StructType_Field) GetType() *Type
func (*StructType_Field) ProtoMessage ¶
func (*StructType_Field) ProtoMessage()
func (*StructType_Field) Reset ¶
func (m *StructType_Field) Reset()
func (*StructType_Field) String ¶
func (m *StructType_Field) String() string
type Transaction ¶
A transaction.
type Transaction struct {
// `id` may be used to identify the transaction in subsequent
// [Read][google.spanner.v1.Spanner.Read],
// [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql],
// [Commit][google.spanner.v1.Spanner.Commit], or
// [Rollback][google.spanner.v1.Spanner.Rollback] calls.
//
// Single-use read-only transactions do not have IDs, because
// single-use transactions do not support multiple requests.
Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// For snapshot read-only transactions, the read timestamp chosen
// for the transaction. Not returned by default: see
// [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].
ReadTimestamp *google_protobuf3.Timestamp `protobuf:"bytes,2,opt,name=read_timestamp,json=readTimestamp" json:"read_timestamp,omitempty"`
}
func (*Transaction) Descriptor ¶
func (*Transaction) Descriptor() ([]byte, []int)
func (*Transaction) GetId ¶
func (m *Transaction) GetId() []byte
func (*Transaction) GetReadTimestamp ¶
func (m *Transaction) GetReadTimestamp() *google_protobuf3.Timestamp
func (*Transaction) ProtoMessage ¶
func (*Transaction) ProtoMessage()
func (*Transaction) Reset ¶
func (m *Transaction) Reset()
func (*Transaction) String ¶
func (m *Transaction) String() string
type TransactionOptions ¶
# Transactions
Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction.
# Transaction Modes
Cloud Spanner supports two transaction modes:
1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past. Snapshot read-only transactions do not need to be committed.
For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed.
Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database.
## Locking Read-Write Transactions
Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent.
Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by [Commit][google.spanner.v1.Spanner.Commit] or [Rollback][google.spanner.v1.Spanner.Rollback]. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it.
Reads performed within a transaction acquire locks on the data being read. Writes can only be done at commit time, after all reads have been completed. Conceptually, a read-write transaction consists of zero or more reads or SQL queries followed by [Commit][google.spanner.v1.Spanner.Commit]. At any time before [Commit][google.spanner.v1.Spanner.Commit], the client can send a [Rollback][google.spanner.v1.Spanner.Rollback] request to abort the transaction.
### Semantics
Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner.
Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves.
### Retrying Aborted Transactions
When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous.
Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying.
### Idle Transactions
A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`.
If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle.
## Snapshot Read-Only Transactions
Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes.
Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions.
Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice.
Snapshot read-only transactions do not need to call [Commit][google.spanner.v1.Spanner.Commit] or [Rollback][google.spanner.v1.Spanner.Rollback] (and in fact are not permitted to do so).
To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp.
The types of timestamp bound are:
- Strong (the default). - Bounded staleness. - Exact staleness.
If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica.
Each type of timestamp bound is discussed in detail below.
### Strong
Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction.
Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp.
See [TransactionOptions.ReadOnly.strong][google.spanner.v1.TransactionOptions.ReadOnly.strong].
### Exact Staleness
These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished.
The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time.
These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results.
See [TransactionOptions.ReadOnly.read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.read_timestamp] and [TransactionOptions.ReadOnly.exact_staleness][google.spanner.v1.TransactionOptions.ReadOnly.exact_staleness].
### Bounded Staleness
Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking.
All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results.
Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp.
As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica.
Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions.
See [TransactionOptions.ReadOnly.max_staleness][google.spanner.v1.TransactionOptions.ReadOnly.max_staleness] and [TransactionOptions.ReadOnly.min_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.min_read_timestamp].
### Old Read Timestamps and Garbage Collection
Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`.
type TransactionOptions struct {
// Required. The type of transaction.
//
// Types that are valid to be assigned to Mode:
// *TransactionOptions_ReadWrite_
// *TransactionOptions_ReadOnly_
Mode isTransactionOptions_Mode `protobuf_oneof:"mode"`
}
func (*TransactionOptions) Descriptor ¶
func (*TransactionOptions) Descriptor() ([]byte, []int)
func (*TransactionOptions) GetMode ¶
func (m *TransactionOptions) GetMode() isTransactionOptions_Mode
func (*TransactionOptions) GetReadOnly ¶
func (m *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly
func (*TransactionOptions) GetReadWrite ¶
func (m *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite
func (*TransactionOptions) ProtoMessage ¶
func (*TransactionOptions) ProtoMessage()
func (*TransactionOptions) Reset ¶
func (m *TransactionOptions) Reset()
func (*TransactionOptions) String ¶
func (m *TransactionOptions) String() string
func (*TransactionOptions) XXX_OneofFuncs ¶
func (*TransactionOptions) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type TransactionOptions_ReadOnly ¶
Options for read-only transactions.
type TransactionOptions_ReadOnly struct {
// How to choose the timestamp for the read-only transaction.
//
// Types that are valid to be assigned to TimestampBound:
// *TransactionOptions_ReadOnly_Strong
// *TransactionOptions_ReadOnly_MinReadTimestamp
// *TransactionOptions_ReadOnly_MaxStaleness
// *TransactionOptions_ReadOnly_ReadTimestamp
// *TransactionOptions_ReadOnly_ExactStaleness
TimestampBound isTransactionOptions_ReadOnly_TimestampBound `protobuf_oneof:"timestamp_bound"`
// If true, the Cloud Spanner-selected read timestamp is included in
// the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
ReturnReadTimestamp bool `protobuf:"varint,6,opt,name=return_read_timestamp,json=returnReadTimestamp" json:"return_read_timestamp,omitempty"`
}
func (*TransactionOptions_ReadOnly) Descriptor ¶
func (*TransactionOptions_ReadOnly) Descriptor() ([]byte, []int)
func (*TransactionOptions_ReadOnly) GetExactStaleness ¶
func (m *TransactionOptions_ReadOnly) GetExactStaleness() *google_protobuf2.Duration
func (*TransactionOptions_ReadOnly) GetMaxStaleness ¶
func (m *TransactionOptions_ReadOnly) GetMaxStaleness() *google_protobuf2.Duration
func (*TransactionOptions_ReadOnly) GetMinReadTimestamp ¶
func (m *TransactionOptions_ReadOnly) GetMinReadTimestamp() *google_protobuf3.Timestamp
func (*TransactionOptions_ReadOnly) GetReadTimestamp ¶
func (m *TransactionOptions_ReadOnly) GetReadTimestamp() *google_protobuf3.Timestamp
func (*TransactionOptions_ReadOnly) GetReturnReadTimestamp ¶
func (m *TransactionOptions_ReadOnly) GetReturnReadTimestamp() bool
func (*TransactionOptions_ReadOnly) GetStrong ¶
func (m *TransactionOptions_ReadOnly) GetStrong() bool
func (*TransactionOptions_ReadOnly) GetTimestampBound ¶
func (m *TransactionOptions_ReadOnly) GetTimestampBound() isTransactionOptions_ReadOnly_TimestampBound
func (*TransactionOptions_ReadOnly) ProtoMessage ¶
func (*TransactionOptions_ReadOnly) ProtoMessage()
func (*TransactionOptions_ReadOnly) Reset ¶
func (m *TransactionOptions_ReadOnly) Reset()
func (*TransactionOptions_ReadOnly) String ¶
func (m *TransactionOptions_ReadOnly) String() string
func (*TransactionOptions_ReadOnly) XXX_OneofFuncs ¶
func (*TransactionOptions_ReadOnly) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type TransactionOptions_ReadOnly_ ¶
type TransactionOptions_ReadOnly_ struct {
ReadOnly *TransactionOptions_ReadOnly `protobuf:"bytes,2,opt,name=read_only,json=readOnly,oneof"`
}
type TransactionOptions_ReadOnly_ExactStaleness ¶
type TransactionOptions_ReadOnly_ExactStaleness struct {
ExactStaleness *google_protobuf2.Duration `protobuf:"bytes,5,opt,name=exact_staleness,json=exactStaleness,oneof"`
}
type TransactionOptions_ReadOnly_MaxStaleness ¶
type TransactionOptions_ReadOnly_MaxStaleness struct {
MaxStaleness *google_protobuf2.Duration `protobuf:"bytes,3,opt,name=max_staleness,json=maxStaleness,oneof"`
}
type TransactionOptions_ReadOnly_MinReadTimestamp ¶
type TransactionOptions_ReadOnly_MinReadTimestamp struct {
MinReadTimestamp *google_protobuf3.Timestamp `protobuf:"bytes,2,opt,name=min_read_timestamp,json=minReadTimestamp,oneof"`
}
type TransactionOptions_ReadOnly_ReadTimestamp ¶
type TransactionOptions_ReadOnly_ReadTimestamp struct {
ReadTimestamp *google_protobuf3.Timestamp `protobuf:"bytes,4,opt,name=read_timestamp,json=readTimestamp,oneof"`
}
type TransactionOptions_ReadOnly_Strong ¶
type TransactionOptions_ReadOnly_Strong struct {
Strong bool `protobuf:"varint,1,opt,name=strong,oneof"`
}
type TransactionOptions_ReadWrite ¶
Options for read-write transactions.
type TransactionOptions_ReadWrite struct {
}
func (*TransactionOptions_ReadWrite) Descriptor ¶
func (*TransactionOptions_ReadWrite) Descriptor() ([]byte, []int)
func (*TransactionOptions_ReadWrite) ProtoMessage ¶
func (*TransactionOptions_ReadWrite) ProtoMessage()
func (*TransactionOptions_ReadWrite) Reset ¶
func (m *TransactionOptions_ReadWrite) Reset()
func (*TransactionOptions_ReadWrite) String ¶
func (m *TransactionOptions_ReadWrite) String() string
type TransactionOptions_ReadWrite_ ¶
type TransactionOptions_ReadWrite_ struct {
ReadWrite *TransactionOptions_ReadWrite `protobuf:"bytes,1,opt,name=read_write,json=readWrite,oneof"`
}
type TransactionSelector ¶
This message is used to select the transaction in which a [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] call runs.
See [TransactionOptions][google.spanner.v1.TransactionOptions] for more information about transactions.
type TransactionSelector struct {
// If no fields are set, the default is a single use transaction
// with strong concurrency.
//
// Types that are valid to be assigned to Selector:
// *TransactionSelector_SingleUse
// *TransactionSelector_Id
// *TransactionSelector_Begin
Selector isTransactionSelector_Selector `protobuf_oneof:"selector"`
}
func (*TransactionSelector) Descriptor ¶
func (*TransactionSelector) Descriptor() ([]byte, []int)
func (*TransactionSelector) GetBegin ¶
func (m *TransactionSelector) GetBegin() *TransactionOptions
func (*TransactionSelector) GetId ¶
func (m *TransactionSelector) GetId() []byte
func (*TransactionSelector) GetSelector ¶
func (m *TransactionSelector) GetSelector() isTransactionSelector_Selector
func (*TransactionSelector) GetSingleUse ¶
func (m *TransactionSelector) GetSingleUse() *TransactionOptions
func (*TransactionSelector) ProtoMessage ¶
func (*TransactionSelector) ProtoMessage()
func (*TransactionSelector) Reset ¶
func (m *TransactionSelector) Reset()
func (*TransactionSelector) String ¶
func (m *TransactionSelector) String() string
func (*TransactionSelector) XXX_OneofFuncs ¶
func (*TransactionSelector) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type TransactionSelector_Begin ¶
type TransactionSelector_Begin struct {
Begin *TransactionOptions `protobuf:"bytes,3,opt,name=begin,oneof"`
}
type TransactionSelector_Id ¶
type TransactionSelector_Id struct {
Id []byte `protobuf:"bytes,2,opt,name=id,proto3,oneof"`
}
type TransactionSelector_SingleUse ¶
type TransactionSelector_SingleUse struct {
SingleUse *TransactionOptions `protobuf:"bytes,1,opt,name=single_use,json=singleUse,oneof"`
}
type Type ¶
`Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
type Type struct {
// Required. The [TypeCode][google.spanner.v1.TypeCode] for this type.
Code TypeCode `protobuf:"varint,1,opt,name=code,enum=google.spanner.v1.TypeCode" json:"code,omitempty"`
// If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then `array_element_type`
// is the type of the array elements.
ArrayElementType *Type `protobuf:"bytes,2,opt,name=array_element_type,json=arrayElementType" json:"array_element_type,omitempty"`
// If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then `struct_type`
// provides type information for the struct's fields.
StructType *StructType `protobuf:"bytes,3,opt,name=struct_type,json=structType" json:"struct_type,omitempty"`
}
func (*Type) Descriptor ¶
func (*Type) Descriptor() ([]byte, []int)
func (*Type) GetArrayElementType ¶
func (m *Type) GetArrayElementType() *Type
func (*Type) GetCode ¶
func (m *Type) GetCode() TypeCode
func (*Type) GetStructType ¶
func (m *Type) GetStructType() *StructType
func (*Type) ProtoMessage ¶
func (*Type) ProtoMessage()
func (*Type) Reset ¶
func (m *Type) Reset()
func (*Type) String ¶
func (m *Type) String() string
type TypeCode ¶
`TypeCode` is used as part of [Type][google.spanner.v1.Type] to indicate the type of a Cloud Spanner value.
Each legal value of a type can be encoded to or decoded from a JSON value, using the encodings described below. All Cloud Spanner values can be `null`, regardless of type; `null`s are always encoded as a JSON `null`.
type TypeCode int32
const (
// Not specified.
TypeCode_TYPE_CODE_UNSPECIFIED TypeCode = 0
// Encoded as JSON `true` or `false`.
TypeCode_BOOL TypeCode = 1
// Encoded as `string`, in decimal format.
TypeCode_INT64 TypeCode = 2
// Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
// `"-Infinity"`.
TypeCode_FLOAT64 TypeCode = 3
// Encoded as `string` in RFC 3339 timestamp format. The time zone
// must be present, and must be `"Z"`.
TypeCode_TIMESTAMP TypeCode = 4
// Encoded as `string` in RFC 3339 date format.
TypeCode_DATE TypeCode = 5
// Encoded as `string`.
TypeCode_STRING TypeCode = 6
// Encoded as a base64-encoded `string`, as described in RFC 4648,
// section 4.
TypeCode_BYTES TypeCode = 7
// Encoded as `list`, where the list elements are represented
// according to [array_element_type][google.spanner.v1.Type.array_element_type].
TypeCode_ARRAY TypeCode = 8
// Encoded as `list`, where list element `i` is represented according
// to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
TypeCode_STRUCT TypeCode = 9
)
func (TypeCode) EnumDescriptor ¶
func (TypeCode) EnumDescriptor() ([]byte, []int)
func (TypeCode) String ¶
func (x TypeCode) String() string