import * as mod from "https://googleapis.deno.dev/v1/spanner:v1.ts";
GoogleAuth | |
Spanner | Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. |
AutoscalingConfig | Autoscaling config for an instance. |
AutoscalingLimits | The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. |
AutoscalingTargets | The autoscaling targets for an instance. |
Backup | A backup of a Cloud Spanner database. |
BackupInfo | Information about a backup. |
BatchCreateSessionsRequest | The request for BatchCreateSessions. |
BatchCreateSessionsResponse | The response for BatchCreateSessions. |
BatchWriteRequest | The request for BatchWrite. |
BatchWriteResponse | The result of applying a batch of mutations. |
BeginTransactionRequest | The request for BeginTransaction. |
Binding | Associates |
ChildLink | Metadata associated with a parent-child relationship appearing in a PlanNode. |
CommitRequest | The request for Commit. |
CommitResponse | The response for Commit. |
CommitStats | Additional statistics about a commit. |
ContextValue | A message representing context for a KeyRangeInfo, including a label, value, unit, and severity. |
CopyBackupEncryptionConfig | Encryption configuration for the copied backup. |
CopyBackupMetadata | Metadata type for the operation returned by CopyBackup. |
CopyBackupRequest | The request for CopyBackup. |
CreateBackupMetadata | Metadata type for the operation returned by CreateBackup. |
CreateDatabaseMetadata | Metadata type for the operation returned by CreateDatabase. |
CreateDatabaseRequest | The request for CreateDatabase. |
CreateInstanceConfigMetadata | Metadata type for the operation returned by CreateInstanceConfig. |
CreateInstanceConfigRequest | The request for CreateInstanceConfigRequest. |
CreateInstanceMetadata | Metadata type for the operation returned by CreateInstance. |
CreateInstancePartitionMetadata | Metadata type for the operation returned by CreateInstancePartition. |
CreateInstancePartitionRequest | The request for CreateInstancePartition. |
CreateInstanceRequest | The request for CreateInstance. |
CreateSessionRequest | The request for CreateSession. |
CredentialsClient | Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface. |
Database | A Cloud Spanner database. |
DatabaseRole | A Cloud Spanner database role. |
DdlStatementActionInfo | Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl. |
Delete | Arguments to delete operations. |
DerivedMetric | A message representing a derived metric. |
DiagnosticMessage | A message representing the key visualizer diagnostic messages. |
DirectedReadOptions | The DirectedReadOptions can be used to indicate which replicas or regions
should be used for non-transactional reads or queries. DirectedReadOptions
may only be specified for a read-only transaction, otherwise the API will
return an |
Empty | A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
EncryptionConfig | Encryption configuration for a Cloud Spanner database. |
EncryptionInfo | Encryption information for a Cloud Spanner database or backup. |
ExcludeReplicas | An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests. |
ExecuteBatchDmlRequest | The request for ExecuteBatchDml. |
ExecuteBatchDmlResponse | The response for ExecuteBatchDml. Contains a list of ResultSet messages, one
for each DML statement that has successfully executed, in the same order as
the statements in the request. If a statement fails, the status in the
response body identifies the cause of the failure. To check for DML
statements that failed, use the following approach: 1. Check the status in
the response message. The google.rpc.Code enum value |
ExecuteSqlRequest | The request for ExecuteSql and ExecuteStreamingSql. |
Expr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. |
Field | Message representing a single field of a struct. |
FreeInstanceMetadata | Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. |
GetDatabaseDdlResponse | The response for GetDatabaseDdl. |
GetIamPolicyRequest | Request message for |
GetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
IncludeReplicas | An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered. |
IndexAdvice | Recommendation to add new indexes to run queries more efficiently. |
IndexedHotKey | A message representing a (sparse) collection of hot keys for specific key buckets. |
IndexedKeyRangeInfos | A message representing a (sparse) collection of KeyRangeInfos for specific key buckets. |
Instance | An isolated set of Cloud Spanner resources on which databases can be hosted. |
InstanceConfig | A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. |
InstanceOperationProgress | Encapsulates progress related information for a Cloud Spanner long running instance operations. |
InstancePartition | An isolated set of Cloud Spanner resources that databases can define placements on. |
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. 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" Since the
|
KeyRangeInfo | A message representing information for a key range (possibly one key). |
KeyRangeInfos | A message representing a list of specific information for multiple key ranges. |
KeySet |
|
ListBackupOperationsResponse | The response for ListBackupOperations. |
ListBackupsResponse | The response for ListBackups. |
ListDatabaseOperationsResponse | The response for ListDatabaseOperations. |
ListDatabaseRolesResponse | The response for ListDatabaseRoles. |
ListDatabasesResponse | The response for ListDatabases. |
ListInstanceConfigOperationsResponse | The response for ListInstanceConfigOperations. |
ListInstanceConfigsResponse | The response for ListInstanceConfigs. |
ListInstancePartitionOperationsResponse | The response for ListInstancePartitionOperations. |
ListInstancePartitionsResponse | The response for ListInstancePartitions. |
ListInstancesResponse | The response for ListInstances. |
ListOperationsResponse | The response message for Operations.ListOperations. |
ListScansResponse | Response method from the ListScans method. |
ListSessionsResponse | The response for ListSessions. |
LocalizedString | A message representing a user-facing string whose value may need to be translated before being displayed. |
Metric | A message representing the actual monitoring data, values for each key bucket over time, of a metric. |
MetricMatrix | A message representing a matrix of floats. |
MetricMatrixRow | A message representing a row of a matrix of floats. |
MoveInstanceRequest | The request for MoveInstance. |
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 call. |
MutationGroup | A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related. |
Operation | This resource represents a long-running operation that is the result of a network API call. |
OperationProgress | Encapsulates progress related information for a Cloud Spanner long running operation. |
OptimizeRestoredDatabaseMetadata | Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled. |
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. |
Partition | Information returned for each partition returned in a PartitionResponse. |
PartitionedDml | Message type to initiate a Partitioned DML transaction. |
PartitionOptions | Options for a PartitionQueryRequest and PartitionReadRequest. |
PartitionQueryRequest | The request for PartitionQuery |
PartitionReadRequest | The request for PartitionRead |
PartitionResponse | The response for PartitionQuery or PartitionRead |
PlanNode | Node information for nodes appearing in a QueryPlan.plan_nodes. |
Policy | An Identity and Access Management (IAM) policy, which specifies access
controls for Google Cloud resources. A
|
PrefixNode | A message representing a key prefix node in the key prefix hierarchy. for eg. Bigtable keyspaces are lexicographically ordered mappings of keys to values. Keys often have a shared prefix structure where users use the keys to organize data. Eg ///employee In this case Keysight will possibly use one node for a company and reuse it for all employees that fall under the company. Doing so improves legibility in the UI. |
ProjectsInstanceConfigOperationsListOptions | Additional options for Spanner#projectsInstanceConfigOperationsList. |
ProjectsInstanceConfigsDeleteOptions | Additional options for Spanner#projectsInstanceConfigsDelete. |
ProjectsInstanceConfigsListOptions | Additional options for Spanner#projectsInstanceConfigsList. |
ProjectsInstanceConfigsOperationsListOptions | Additional options for Spanner#projectsInstanceConfigsOperationsList. |
ProjectsInstanceConfigsSsdCachesOperationsListOptions | Additional options for Spanner#projectsInstanceConfigsSsdCachesOperationsList. |
ProjectsInstancesBackupOperationsListOptions | Additional options for Spanner#projectsInstancesBackupOperationsList. |
ProjectsInstancesBackupsCreateOptions | Additional options for Spanner#projectsInstancesBackupsCreate. |
ProjectsInstancesBackupsListOptions | Additional options for Spanner#projectsInstancesBackupsList. |
ProjectsInstancesBackupsOperationsListOptions | Additional options for Spanner#projectsInstancesBackupsOperationsList. |
ProjectsInstancesBackupsPatchOptions | Additional options for Spanner#projectsInstancesBackupsPatch. |
ProjectsInstancesDatabaseOperationsListOptions | Additional options for Spanner#projectsInstancesDatabaseOperationsList. |
ProjectsInstancesDatabasesDatabaseRolesListOptions | Additional options for Spanner#projectsInstancesDatabasesDatabaseRolesList. |
ProjectsInstancesDatabasesGetScansOptions | Additional options for Spanner#projectsInstancesDatabasesGetScans. |
ProjectsInstancesDatabasesListOptions | Additional options for Spanner#projectsInstancesDatabasesList. |
ProjectsInstancesDatabasesOperationsListOptions | Additional options for Spanner#projectsInstancesDatabasesOperationsList. |
ProjectsInstancesDatabasesPatchOptions | Additional options for Spanner#projectsInstancesDatabasesPatch. |
ProjectsInstancesDatabasesSessionsListOptions | Additional options for Spanner#projectsInstancesDatabasesSessionsList. |
ProjectsInstancesGetOptions | Additional options for Spanner#projectsInstancesGet. |
ProjectsInstancesInstancePartitionOperationsListOptions | Additional options for Spanner#projectsInstancesInstancePartitionOperationsList. |
ProjectsInstancesInstancePartitionsDeleteOptions | Additional options for Spanner#projectsInstancesInstancePartitionsDelete. |
ProjectsInstancesInstancePartitionsListOptions | Additional options for Spanner#projectsInstancesInstancePartitionsList. |
ProjectsInstancesInstancePartitionsOperationsListOptions | Additional options for Spanner#projectsInstancesInstancePartitionsOperationsList. |
ProjectsInstancesListOptions | Additional options for Spanner#projectsInstancesList. |
ProjectsInstancesOperationsListOptions | Additional options for Spanner#projectsInstancesOperationsList. |
QueryAdvisorResult | Output of query advisor analysis. |
QueryOptions | Query optimizer configuration. |
QueryPlan | Contains an ordered list of nodes appearing in the query plan. |
ReadOnly | Message type to initiate a read-only transaction. |
ReadRequest | The request for Read and StreamingRead. |
ReadWrite | Message type to initiate a read-write transaction. Currently this transaction type has no options. |
ReplicaInfo | |
ReplicaSelection | The directed read replica selector. Callers must provide one or more of the
following fields for replica selection: * |
RequestOptions | Common request options for various APIs. |
RestoreDatabaseEncryptionConfig | Encryption configuration for the restored database. |
RestoreDatabaseMetadata | Metadata type for the long-running operation returned by RestoreDatabase. |
RestoreDatabaseRequest | The request for RestoreDatabase. |
RestoreInfo | Information about the database restore. |
ResultSet | Results from Read or ExecuteSql. |
ResultSetMetadata | Metadata about a ResultSet or PartialResultSet. |
ResultSetStats | Additional statistics about a ResultSet or PartialResultSet. |
RollbackRequest | The request for Rollback. |
Scan | Scan is a structure which describes Cloud Key Visualizer scan information. |
ScanData | ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization. |
ScansListOptions | Additional options for Spanner#scansList. |
Session | A session in the Cloud Spanner API. |
SetIamPolicyRequest | Request message for |
ShortRepresentation | Condensed representation of a node and its subtree. Only present for
|
Statement | A single DML statement. |
Status | The |
StructType |
|
TestIamPermissionsRequest | Request message for |
TestIamPermissionsResponse | Response message for |
Transaction | A transaction. |
TransactionOptions | Transactions: Each session can have at most one active transaction at a time
(note that standalone reads and queries use a transaction internally and do
count towards the one transaction limit). 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 three 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. Snapshot read-only transactions provide
guaranteed consistency across several reads, but do not allow writes.
Snapshot read-only transactions can be configured to read at timestamps in
the past, or configured to perform a strong read (where Spanner will select a
timestamp such that the read is guaranteed to see the effects of all
transactions that have committed before the start of the read). Snapshot
read-only transactions do not need to be committed. Queries on change streams
must be performed with the snapshot read-only transaction mode, specifying a
strong read. Please see TransactionOptions.ReadOnly.strong for more details.
3. Partitioned DML. This type of transaction is used to execute a single
Partitioned DML statement. Partitioned DML partitions the key space and runs
the DML statement over each partition in parallel using separate, internal
transactions that commit independently. Partitioned DML 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
or Rollback. Long periods of inactivity at the client may cause Cloud Spanner
to release a transaction's locks and abort it. Conceptually, a read-write
transaction consists of zero or more reads or SQL statements followed by
Commit. At any time before Commit, the client can send a 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 |
TransactionSelector | This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. |
Type |
|
UpdateDatabaseDdlMetadata | Metadata type for the operation returned by UpdateDatabaseDdl. |
UpdateDatabaseDdlRequest | Enqueues the given DDL statements to be applied, in order but not
necessarily all at once, to the database schema at some point (or points) in
the future. The server checks that the statements are executable
(syntactically valid, name tables that exist, etc.) before enqueueing them,
but they may still fail upon later execution (e.g., if a statement from
another batch of statements is applied first and it conflicts in some way, or
if there is some data-related problem like a |
UpdateDatabaseMetadata | Metadata type for the operation returned by UpdateDatabase. |
UpdateDatabaseRequest | The request for UpdateDatabase. |
UpdateInstanceConfigMetadata | Metadata type for the operation returned by UpdateInstanceConfig. |
UpdateInstanceConfigRequest | The request for UpdateInstanceConfigRequest. |
UpdateInstanceMetadata | Metadata type for the operation returned by UpdateInstance. |
UpdateInstancePartitionMetadata | Metadata type for the operation returned by UpdateInstancePartition. |
UpdateInstancePartitionRequest | The request for UpdateInstancePartition. |
UpdateInstanceRequest | The request for UpdateInstance. |
VisualizationData | |
Write | Arguments to insert, update, insert_or_update, and replace operations. |