NAME
Google::Spanner::V1::Spanner::CreateSessionRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::CreateSessionRequest->new(
database => $value,
);
FIELDS
database
Type: String
session
Type: Message (.google.spanner.v1.Session)
NAME
Google::Spanner::V1::Spanner::BatchCreateSessionsRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::BatchCreateSessionsRequest->new(
database => $value,
);
FIELDS
database
Type: String
session_template
Type: Message (.google.spanner.v1.Session)
session_count
Type: Int32
NAME
Google::Spanner::V1::Spanner::BatchCreateSessionsResponse - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::BatchCreateSessionsResponse->new(
session => $value,
);
FIELDS
session
Type: Message (.google.spanner.v1.Session)
NAME
Google::Spanner::V1::Spanner::Session - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::Session->new(
name => $value,
);
FIELDS
name
Type: String
labels
Type: Message (.google.spanner.v1.Session.LabelsEntry)
create_time
Type: Message (.google.protobuf.Timestamp)
approximate_last_use_time
Type: Message (.google.protobuf.Timestamp)
creator_role
Type: String
multiplexed
Type: Bool
NAME
Google::Spanner::V1::Spanner::GetSessionRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::GetSessionRequest->new(
name => $value,
);
FIELDS
name
Type: String
NAME
Google::Spanner::V1::Spanner::ListSessionsRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ListSessionsRequest->new(
database => $value,
);
FIELDS
database
Type: String
page_size
Type: Int32
page_token
Type: String
filter
Type: String
NAME
Google::Spanner::V1::Spanner::ListSessionsResponse - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ListSessionsResponse->new(
sessions => $value,
);
FIELDS
sessions
Type: Message (.google.spanner.v1.Session)
next_page_token
Type: String
NAME
Google::Spanner::V1::Spanner::DeleteSessionRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::DeleteSessionRequest->new(
name => $value,
);
FIELDS
name
Type: String
NAME
Google::Spanner::V1::Spanner::RequestOptions - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::RequestOptions->new(
priority => $value,
);
FIELDS
priority
Type: Enum (.google.spanner.v1.RequestOptions.Priority)
request_tag
Type: String
transaction_tag
Type: String
client_context
Type: Message (.google.spanner.v1.RequestOptions.ClientContext)
Enum: RequestOptions::Priority
Values:
PRIORITY_UNSPECIFIED=> 0PRIORITY_LOW=> 1PRIORITY_MEDIUM=> 2PRIORITY_HIGH=> 3
NAME
Google::Spanner::V1::Spanner::DirectedReadOptions - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::DirectedReadOptions->new(
include_replicas => $value,
);
FIELDS
include_replicas
Type: Message (.google.spanner.v1.DirectedReadOptions.IncludeReplicas)
exclude_replicas
Type: Message (.google.spanner.v1.DirectedReadOptions.ExcludeReplicas)
NAME
Google::Spanner::V1::Spanner::ExecuteSqlRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ExecuteSqlRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction
Type: Message (.google.spanner.v1.TransactionSelector)
sql
Type: String
params
Type: Message (.google.protobuf.Struct)
param_types
Type: Message (.google.spanner.v1.ExecuteSqlRequest.ParamTypesEntry)
resume_token
Type: Bytes
query_mode
Type: Enum (.google.spanner.v1.ExecuteSqlRequest.QueryMode)
partition_token
Type: Bytes
seqno
Type: Int64
query_options
Type: Message (.google.spanner.v1.ExecuteSqlRequest.QueryOptions)
request_options
Type: Message (.google.spanner.v1.RequestOptions)
directed_read_options
Type: Message (.google.spanner.v1.DirectedReadOptions)
data_boost_enabled
Type: Bool
last_statement
Type: Bool
routing_hint
Type: Message (.google.spanner.v1.RoutingHint)
Enum: ExecuteSqlRequest::QueryMode
Values:
NORMAL=> 0PLAN=> 1PROFILE=> 2WITH_STATS=> 3WITH_PLAN_AND_STATS=> 4
NAME
Google::Spanner::V1::Spanner::ExecuteBatchDmlRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ExecuteBatchDmlRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction
Type: Message (.google.spanner.v1.TransactionSelector)
statements
Type: Message (.google.spanner.v1.ExecuteBatchDmlRequest.Statement)
seqno
Type: Int64
request_options
Type: Message (.google.spanner.v1.RequestOptions)
last_statements
Type: Bool
NAME
Google::Spanner::V1::Spanner::ExecuteBatchDmlResponse - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ExecuteBatchDmlResponse->new(
result_sets => $value,
);
FIELDS
result_sets
Type: Message (.google.spanner.v1.ResultSet)
status
Type: Message (.google.rpc.Status)
precommit_token
Type: Message (.google.spanner.v1.MultiplexedSessionPrecommitToken)
NAME
Google::Spanner::V1::Spanner::PartitionOptions - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::PartitionOptions->new(
partition_size_bytes => $value,
);
FIELDS
partition_size_bytes
Type: Int64
max_partitions
Type: Int64
NAME
Google::Spanner::V1::Spanner::PartitionQueryRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::PartitionQueryRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction
Type: Message (.google.spanner.v1.TransactionSelector)
sql
Type: String
params
Type: Message (.google.protobuf.Struct)
param_types
Type: Message (.google.spanner.v1.PartitionQueryRequest.ParamTypesEntry)
partition_options
Type: Message (.google.spanner.v1.PartitionOptions)
NAME
Google::Spanner::V1::Spanner::PartitionReadRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::PartitionReadRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction
Type: Message (.google.spanner.v1.TransactionSelector)
table
Type: String
index
Type: String
columns
Type: String
key_set
Type: Message (.google.spanner.v1.KeySet)
partition_options
Type: Message (.google.spanner.v1.PartitionOptions)
NAME
Google::Spanner::V1::Spanner::Partition - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::Partition->new(
partition_token => $value,
);
FIELDS
partition_token
Type: Bytes
NAME
Google::Spanner::V1::Spanner::PartitionResponse - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::PartitionResponse->new(
partitions => $value,
);
FIELDS
partitions
Type: Message (.google.spanner.v1.Partition)
transaction
Type: Message (.google.spanner.v1.Transaction)
NAME
Google::Spanner::V1::Spanner::ReadRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::ReadRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction
Type: Message (.google.spanner.v1.TransactionSelector)
table
Type: String
index
Type: String
columns
Type: String
key_set
Type: Message (.google.spanner.v1.KeySet)
limit
Type: Int64
resume_token
Type: Bytes
partition_token
Type: Bytes
request_options
Type: Message (.google.spanner.v1.RequestOptions)
directed_read_options
Type: Message (.google.spanner.v1.DirectedReadOptions)
data_boost_enabled
Type: Bool
order_by
Type: Enum (.google.spanner.v1.ReadRequest.OrderBy)
lock_hint
Type: Enum (.google.spanner.v1.ReadRequest.LockHint)
routing_hint
Type: Message (.google.spanner.v1.RoutingHint)
Enum: ReadRequest::OrderBy
Values:
ORDER_BY_UNSPECIFIED=> 0ORDER_BY_PRIMARY_KEY=> 1ORDER_BY_NO_ORDER=> 2
Enum: ReadRequest::LockHint
Values:
LOCK_HINT_UNSPECIFIED=> 0LOCK_HINT_SHARED=> 1LOCK_HINT_EXCLUSIVE=> 2
NAME
Google::Spanner::V1::Spanner::BeginTransactionRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::BeginTransactionRequest->new(
session => $value,
);
FIELDS
session
Type: String
options
Type: Message (.google.spanner.v1.TransactionOptions)
request_options
Type: Message (.google.spanner.v1.RequestOptions)
mutation_key
Type: Message (.google.spanner.v1.Mutation)
routing_hint
Type: Message (.google.spanner.v1.RoutingHint)
NAME
Google::Spanner::V1::Spanner::CommitRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::CommitRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction_id
Type: Bytes
single_use_transaction
Type: Message (.google.spanner.v1.TransactionOptions)
mutations
Type: Message (.google.spanner.v1.Mutation)
return_commit_stats
Type: Bool
max_commit_delay
Type: Message (.google.protobuf.Duration)
request_options
Type: Message (.google.spanner.v1.RequestOptions)
precommit_token
Type: Message (.google.spanner.v1.MultiplexedSessionPrecommitToken)
routing_hint
Type: Message (.google.spanner.v1.RoutingHint)
NAME
Google::Spanner::V1::Spanner::RollbackRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::RollbackRequest->new(
session => $value,
);
FIELDS
session
Type: String
transaction_id
Type: Bytes
NAME
Google::Spanner::V1::Spanner::BatchWriteRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::BatchWriteRequest->new(
session => $value,
);
FIELDS
session
Type: String
request_options
Type: Message (.google.spanner.v1.RequestOptions)
mutation_groups
Type: Message (.google.spanner.v1.BatchWriteRequest.MutationGroup)
exclude_txn_from_change_streams
Type: Bool
NAME
Google::Spanner::V1::Spanner::BatchWriteResponse - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::BatchWriteResponse->new(
indexes => $value,
);
FIELDS
indexes
Type: Int32
status
Type: Message (.google.rpc.Status)
commit_timestamp
Type: Message (.google.protobuf.Timestamp)
NAME
Google::Spanner::V1::Spanner::FetchCacheUpdateRequest - Compiled Protocol Buffers message class
SYNOPSIS
use Google::Spanner::V1::Spanner;
my $msg = Google::Spanner::V1::Spanner::FetchCacheUpdateRequest->new(
database => $value,
);
FIELDS
database
Type: String
max_recipe_count
Type: Int32
max_range_count
Type: Int32
NAME
Google::Spanner::V1::Spanner::SpannerClient - Client stub representing the remote Spanner service
DESCRIPTION
This class acts as a local client stub for the remote gRPC service. It delegates call dispatching to an underlying Google::gRPC::Client instance, ensuring type-safe request parsing and response mapping.
CONFIGURATION AND ENVIRONMENT
target
The endpoint target address. Defaults to spanner.googleapis.com:443.
credentials
The authentication credentials provider. Defaults to application default credentials via Google::Auth.
NAME
Google::Spanner::V1::Spanner - Protocol Buffers schema definition
DESCRIPTION
Auto-generated Protocol Buffers schema definition class.
LICENSE AND COPYRIGHT
Copyright (C) 2026 Google LLC
This program is released under the Apache 2.0 license.