google-api-python-client 2.169.0__py3-none-any.whl → 2.171.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/spanner.v1.json

@@ -59,11 +59,6 @@
 },
 {
 "description": "Regional Endpoint",
-"endpointUrl": "https://spanner.us-east7.rep.googleapis.com/",
-"location": "us-east7"
-},
-{
-"description": "Regional Endpoint",
 "endpointUrl": "https://spanner.us-south1.rep.googleapis.com/",
 "location": "us-south1"
 },
@@ -91,6 +86,11 @@
 "description": "Regional Endpoint",
 "endpointUrl": "https://spanner.us-west8.rep.googleapis.com/",
 "location": "us-west8"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://spanner.us-east7.rep.googleapis.com/",
+"location": "us-east7"
 }
 ],
 "fullyEncodeReservedExpansion": true,
@@ -1462,7 +1462,7 @@
 "databases": {
 "methods": {
 "addSplitPoints": {
-"description": "Adds split points to specified tables, indexes of a database.",
+"description": "Adds split points to specified tables and indexes of a database.",
 "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:addSplitPoints",
 "httpMethod": "POST",
 "id": "spanner.projects.instances.databases.addSplitPoints",
@@ -1471,7 +1471,7 @@
 ],
 "parameters": {
 "database": {
-"description": "Required. The database on whose tables/indexes split points are to be added. Values are of the form `projects//instances//databases/`.",
+"description": "Required. The database on whose tables or indexes the split points are to be added. Values are of the form `projects//instances//databases/`.",
 "location": "path",
 "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
 "required": true,
@@ -3406,7 +3406,7 @@
 }
 }
 },
-"revision": "20250304",
+"revision": "20250523",
 "rootUrl": "https://spanner.googleapis.com/",
 "schemas": {
 "AdaptMessageRequest": {
@@ -3467,7 +3467,7 @@
 "id": "AddSplitPointsRequest",
 "properties": {
 "initiator": {
-"description": "Optional. A user-supplied tag associated with the split points. For example, \"initial_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.",
+"description": "Optional. A user-supplied tag associated with the split points. For example, \"initial_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters, or else it is trimmed. Only valid UTF8 characters are allowed.",
 "type": "string"
 },
 "splitPoints": {
@@ -4553,6 +4553,21 @@
 },
 "type": "object"
 },
+"DatabaseMoveConfig": {
+"description": "The configuration for each database in the target instance configuration.",
+"id": "DatabaseMoveConfig",
+"properties": {
+"databaseId": {
+"description": "Required. The unique identifier of the database resource in the Instance. For example if the database uri is projects/foo/instances/bar/databases/baz, the id to supply here is baz.",
+"type": "string"
+},
+"encryptionConfig": {
+"$ref": "InstanceEncryptionConfig",
+"description": "Optional. Encryption configuration to be used for the database in target configuration. Should be specified for every database which currently uses CMEK encryption. If a database currently uses GOOGLE_MANAGED encryption and a target encryption config is not specified, it defaults to GOOGLE_MANAGED. If a database currently uses Google-managed encryption and a target encryption config is specified, the request is rejected. If a database currently uses CMEK encryption, a target encryption config must be specified. You cannot move a CMEK database to a Google-managed encryption database by MoveInstance."
+}
+},
+"type": "object"
+},
 "DatabaseRole": {
 "description": "A Cloud Spanner database role.",
 "id": "DatabaseRole",
@@ -5334,6 +5349,24 @@
 },
 "type": "object"
 },
+"InstanceEncryptionConfig": {
+"description": "Encryption configuration for a Cloud Spanner database.",
+"id": "InstanceEncryptionConfig",
+"properties": {
+"kmsKeyName": {
+"description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance\u2019s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.",
+"type": "string"
+},
+"kmsKeyNames": {
+"description": "Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "InstanceOperationProgress": {
 "description": "Encapsulates progress related information for a Cloud Spanner long running instance operations.",
 "id": "InstanceOperationProgress",
@@ -5994,6 +6027,13 @@
 "targetConfig": {
 "description": "Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`.",
 "type": "string"
+},
+"targetDatabaseMoveConfigs": {
+"description": "Optional. The configuration for each database in the target instance configuration.",
+"items": {
+"$ref": "DatabaseMoveConfig"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -6519,7 +6559,7 @@
 "type": "string"
 },
 "readTimestamp": {
-"description": "Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`.",
+"description": "Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read is blocked until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`.",
 "format": "google-datetime",
 "type": "string"
 },
@@ -7093,7 +7133,7 @@
 "type": "object"
 },
 "SplitPoints": {
-"description": "The split points of a table/index.",
+"description": "The split points of a table or an index.",
 "id": "SplitPoints",
 "properties": {
 "expireTime": {
@@ -7106,7 +7146,7 @@
 "type": "string"
 },
 "keys": {
-"description": "Required. The list of split keys, i.e., the split boundaries.",
+"description": "Required. The list of split keys. In essence, the split boundaries.",
 "items": {
 "$ref": "Key"
 },
@@ -7225,7 +7265,7 @@
 },
 "precommitToken": {
 "$ref": "MultiplexedSessionPrecommitToken",
-"description": "A precommit token will be included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction."
+"description": "A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction."
 },
 "readTimestamp": {
 "description": "For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`.",
@@ -7236,11 +7276,11 @@
 "type": "object"
 },
 "TransactionOptions": {
-"description": "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. 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 `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. Note that the lock priority is preserved per session (not per transaction). Lock priority is set by the first read or write in the first attempt of a read-write transaction. If the application starts a new session to retry the whole transaction, the transaction loses its original lock priority. Moreover, the lock priority is only preserved if the transaction fails with an `ABORTED` error. Under some circumstances (for example, 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 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. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `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 or 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 transactions, 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. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See 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 less than or equal to 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 and 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 and 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`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement is applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.",
+"description": "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 selects 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. 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 `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. Note that the lock priority is preserved per session (not per transaction). Lock priority is set by the first read or write in the first attempt of a read-write transaction. If the application starts a new session to retry the whole transaction, the transaction loses its original lock priority. Moreover, the lock priority is only preserved if the transaction fails with an `ABORTED` error. Under some circumstances (for example, 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 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. If an idle transaction is aborted, the commit fails with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `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 or 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 transactions, 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. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See 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 less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They block until all conflicting transactions that can 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 and 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 are read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and 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 can't 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`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 is returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement is applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that can't be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.",
 "id": "TransactionOptions",
 "properties": {
 "excludeTxnFromChangeStreams": {
-"description": "When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error.",
+"description": "When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams. * If the DDL option `allow_txn_exclusion` is set to `true`, then the updates made within this transaction aren't recorded in the change stream. * If you don't set the DDL option `allow_txn_exclusion` or if it's set to `false`, then the updates made within this transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The `exclude_txn_from_change_streams` option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an `INVALID_ARGUMENT` error.",
 "type": "boolean"
 },
 "isolationLevel": {
@@ -7253,7 +7293,7 @@
 "enumDescriptions": [
 "Default value. If the value is not specified, the `SERIALIZABLE` isolation level is used.",
 "All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For further details, please refer to https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability.",
-"All reads performed during the transaction observe a consistent snapshot of the database, and the transaction will only successfully commit in the absence of conflicts between its updates and any concurrent updates that have occurred since that snapshot. Consequently, in contrast to `SERIALIZABLE` transactions, only write-write conflicts are detected in snapshot transactions. This isolation level does not support Read-only and Partitioned DML transactions. When `REPEATABLE_READ` is specified on a read-write transaction, the locking semantics default to `OPTIMISTIC`."
+"All reads performed during the transaction observe a consistent snapshot of the database, and the transaction is only successfully committed in the absence of conflicts between its updates and any concurrent updates that have occurred since that snapshot. Consequently, in contrast to `SERIALIZABLE` transactions, only write-write conflicts are detected in snapshot transactions. This isolation level does not support Read-only and Partitioned DML transactions. When `REPEATABLE_READ` is specified on a read-write transaction, the locking semantics default to `OPTIMISTIC`."
 ],
 "type": "string"
 },
@@ -7263,7 +7303,7 @@
 },
 "readOnly": {
 "$ref": "ReadOnly",
-"description": "Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource."
+"description": "Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource."
 },
 "readWrite": {
 "$ref": "ReadWrite",

googleapiclient/discovery_cache/documents/sqladmin.v1.json

@@ -1381,6 +1381,35 @@
 "https://www.googleapis.com/auth/sqlservice.admin"
 ]
 },
+"pointInTimeRestore": {
+"description": "Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.",
+"flatPath": "v1/projects/{projectsId}:pointInTimeRestore",
+"httpMethod": "POST",
+"id": "sql.instances.pointInTimeRestore",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource where you created this instance. Format: projects/{project}",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:pointInTimeRestore",
+"request": {
+"$ref": "PointInTimeRestoreContext"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/sqlservice.admin"
+]
+},
 "promoteReplica": {
 "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.",
 "flatPath": "v1/projects/{project}/instances/{instance}/promoteReplica",
@@ -2565,7 +2594,7 @@
 }
 }
 },
-"revision": "20250412",
+"revision": "20250526",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2681,7 +2710,7 @@
 "type": "object"
 },
 "Backup": {
-"description": "A backup resource.",
+"description": "A backup resource. Next ID: 30",
 "id": "Backup",
 "properties": {
 "backupInterval": {
@@ -2990,6 +3019,29 @@ false
 "$ref": "BackupRetentionSettings",
 "description": "Backup retention settings."
 },
+"backupTier": {
+"description": "Output only. Backup tier that manages the backups for the instance.",
+"enum": [
+"BACKUP_TIER_UNSPECIFIED",
+"STANDARD",
+"ADVANCED",
+"ENHANCED"
+],
+"enumDeprecated": [
+false,
+false,
+true,
+false
+],
+"enumDescriptions": [
+"Unspecified.",
+"Instance is managed by Cloud SQL.",
+"Deprecated: ADVANCED is deprecated. Please use ENHANCED instead.",
+"Instance is managed by Google Cloud Backup and DR Service."
+],
+"readOnly": true,
+"type": "string"
+},
 "binaryLogEnabled": {
 "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.",
 "type": "boolean"
@@ -3768,7 +3820,7 @@ false
 "type": "boolean"
 },
 "flags": {
-"description": "Optional. List of connection pool configuration flags",
+"description": "Optional. List of connection pool configuration flags.",
 "items": {
 "$ref": "ConnectionPoolFlags"
 },
@@ -3894,6 +3946,10 @@ false
 ],
 "type": "string"
 },
+"clearNetwork": {
+"description": "Clears private network settings when the instance is restored.",
+"type": "boolean"
+},
 "connectionName": {
 "description": "Connection name of the Cloud SQL instance used in connection strings.",
 "type": "string"
@@ -4184,6 +4240,10 @@ false
 "$ref": "SqlOutOfDiskReport",
 "description": "This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job"
 },
+"pitrFields": {
+"$ref": "PITRFields",
+"description": "Input only. PITR related fields added for Instance Independent PITR."
+},
 "primaryDnsName": {
 "deprecated": true,
 "description": "Output only. DEPRECATED: please use write_endpoint instead.",
@@ -5312,7 +5372,7 @@ false
 "type": "integer"
 },
 "queryStringLength": {
-"description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.",
+"description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.",
 "format": "int32",
 "type": "integer"
 },
@@ -5521,6 +5581,10 @@ false
 "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.",
 "type": "string"
 },
+"backupdrBackup": {
+"description": "The name of the backup that's used to restore a Cloud SQL instance: Format: \"projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}\". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.",
+"type": "string"
+},
 "restoreBackupContext": {
 "$ref": "RestoreBackupContext",
 "description": "Parameters required to perform the restore backup operation."
@@ -6016,7 +6080,8 @@ false
 "MANAGE_BACKUP",
 "ENHANCED_BACKUP",
 "REPAIR_READ_POOL",
-"CREATE_READ_POOL"
+"CREATE_READ_POOL",
+"PRE_CHECK_MAJOR_VERSION_UPGRADE"
 ],
 "enumDeprecated": [
 false,
@@ -6070,6 +6135,7 @@ true,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -6124,7 +6190,8 @@ false
 "Changes the BackupTier of a Cloud SQL instance.",
 "Creates a backup for an Enhanced BackupTier Cloud SQL instance.",
 "Repairs entire read pool or specified read pool nodes in the read pool.",
-"Creates a Cloud SQL read pool instance."
+"Creates a Cloud SQL read pool instance.",
+"Pre-checks the major version upgrade operation."
 ],
 "type": "string"
 },
@@ -6278,6 +6345,30 @@ false
 },
 "type": "object"
 },
+"PITRFields": {
+"description": "PITR related fields include enablement settings, archiving settings, and the bucket name.",
+"id": "PITRFields",
+"properties": {
+"enableBinLog": {
+"description": "The enablement setting for PITR for MySQL.",
+"type": "boolean"
+},
+"replicationLogArchivingEnabled": {
+"description": "The enablement setting for PITR for PostgreSQL.",
+"type": "boolean"
+},
+"sqlserverPitrEnabled": {
+"description": "The enablement setting for PITR for SQL Server.",
+"type": "boolean"
+},
+"transactionLogRetentionDays": {
+"description": "The number of transaction log days to retain for PITR",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "PasswordStatus": {
 "description": "Read-only password status.",
 "id": "PasswordStatus",
@@ -6353,6 +6444,42 @@ false
 },
 "type": "object"
 },
+"PointInTimeRestoreContext": {
+"description": "The context to perform a point-in-time recovery of an instance managed by Google Cloud Backup and Disaster Recovery.",
+"id": "PointInTimeRestoreContext",
+"properties": {
+"allocatedIpRange": {
+"description": "Optional. The name of the allocated IP range for the internal IP Cloud SQL instance. For example: \"google-managed-services-default\". If you set this, then Cloud SQL creates the IP address for the cloned instance in the allocated range. This range must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use. http://go/speckle-subnet-picker-clone",
+"type": "string"
+},
+"datasource": {
+"description": "The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}.",
+"type": "string"
+},
+"pointInTime": {
+"description": "Required. The date and time to which you want to restore the instance.",
+"format": "google-datetime",
+"type": "string"
+},
+"preferredSecondaryZone": {
+"description": "Optional. Point-in-time recovery of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field.",
+"type": "string"
+},
+"preferredZone": {
+"description": "Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance.",
+"type": "string"
+},
+"privateNetwork": {
+"description": "Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`.",
+"type": "string"
+},
+"targetInstance": {
+"description": "Target instance name.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "PoolNodeConfig": {
 "description": "Details of a single read pool node of a read pool.",
 "id": "PoolNodeConfig",
@@ -6434,7 +6561,7 @@ false
 "id": "PscAutoConnectionConfig",
 "properties": {
 "consumerNetwork": {
-"description": "The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.",
+"description": "Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.",
 "type": "string"
 },
 "consumerNetworkStatus": {
@@ -6442,7 +6569,7 @@ false
 "type": "string"
 },
 "consumerProject": {
-"description": "This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.",
+"description": "Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.",
 "type": "string"
 },
 "ipAddress": {
@@ -6467,6 +6594,10 @@ false
 },
 "type": "array"
 },
+"networkAttachmentUri": {
+"description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID",
+"type": "string"
+},
 "pscAutoConnections": {
 "description": "Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.",
 "items": {
@@ -6973,7 +7104,8 @@ false
 "USERS_NOT_CREATED_IN_REPLICA",
 "UNSUPPORTED_SYSTEM_OBJECTS",
 "UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY",
-"SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE"
+"SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE",
+"PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI"
 ],
 "enumDescriptions": [
 "",
@@ -7029,7 +7161,8 @@ false
 "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.",
 "The selected objects include system objects that aren't supported for migration.",
 "The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration.",
-"The selected objects don't exist on the source instance."
+"The selected objects don't exist on the source instance.",
+"PSC only destination instance does not have a network attachment URI."
 ],
 "type": "string"
 }
@@ -7635,20 +7768,6 @@ false
 "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.",
 "type": "string"
 },
-"iamStatus": {
-"description": "Indicates if user is active for IAM Authentication.",
-"enum": [
-"IAM_STATUS_UNSPECIFIED",
-"INACTIVE",
-"ACTIVE"
-],
-"enumDescriptions": [
-"The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive/active. Will not display any value in UI.",
-"User is not available for IAM Authentication.",
-"User is available for IAM Authentication."
-],
-"type": "string"
-},
 "instance": {
 "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.",
 "type": "string"