@swamp/gcp/spanner
v2026.04.23.1
Google Cloud spanner infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudspannercloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/spanner@swamp/gcp/spanner/instanceconfigsv2026.04.23.1instanceconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| instanceConfig? | object | A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. |
| instanceConfigId? | string | Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations. |
| validateOnly? | boolean | An option to validate, but not actually execute, a request, and provide the same response. |
| updateMask? | string | Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instanceConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instanceConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instanceConfigs |
updateUpdate instanceConfigs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instanceConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instanceConfigs |
syncSync instanceConfigs state from GCP
Resources
state(infinite)— A possible configuration for a Cloud Spanner instance. Configurations define ...
@swamp/gcp/spanner/instancesv2026.04.23.1instances.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| instance? | object | An isolated set of Cloud Spanner resources on which databases can be hosted. |
| instanceId? | string | Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. |
| fieldMask? | string | Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
updateUpdate instances attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
syncSync instances state from GCP
movemove
| Argument | Type | Description |
|---|---|---|
| targetConfig? | any | |
| targetDatabaseMoveConfigs? | any |
Resources
state(infinite)— An isolated set of Cloud Spanner resources on which databases can be hosted.
@swamp/gcp/spanner/instances-backupsv2026.04.23.1instances_backups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| database? | string | Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. |
| encryptionInfo? | object | Encryption information for a Cloud Spanner database or backup. |
| expireTime? | string | Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. |
| versionTime? | string | The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. |
| backupId? | string | Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`. |
| encryptionConfig_encryptionType? | string | Required. The encryption type of the backup. |
| encryptionConfig_kmsKeyName? | string | Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encry |
| encryptionConfig_kmsKeyNames? | string | Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup'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 m |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a backups
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
updateUpdate backups attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
syncSync backups state from GCP
copycopy
| Argument | Type | Description |
|---|---|---|
| backupId? | any | |
| encryptionConfig? | any | |
| expireTime? | any | |
| sourceBackup? | any |
Resources
state(infinite)— A backup of a Cloud Spanner database.
@swamp/gcp/spanner/instances-databasesv2026.04.23.1instances_databases.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| createStatement? | string | Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``). |
| databaseDialect? | enum | Output only. The dialect of the Cloud Spanner Database. |
| encryptionConfig? | object | Encryption configuration for a Cloud Spanner database. |
| extraStatements? | array | Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. |
| protoDescriptors? | string | Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ` $protoc --proto_path=/app_path --p |
| createTime? | string | Output only. If exists, the time at which the database creation started. |
| defaultLeader? | string | Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. |
| earliestVersionTime? | string | Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. |
| enableDropProtection? | boolean | Optional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). |
| encryptionInfo? | array | Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status` field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in thi |
| name? | string | Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. |
| quorumInfo? | object | Information about the dual-region quorum. |
| reconciling? | boolean | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. |
| restoreInfo? | object | Information about the database restore. |
| state? | enum | Output only. The current database state. |
| versionRetentionPeriod? | string | Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a databases
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a databases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databases |
updateUpdate databases attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync databases state from GCP
add_split_pointsadd split points
| Argument | Type | Description |
|---|---|---|
| initiator? | any | |
| splitPoints? | any |
changequorumchangequorum
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| name? | any | |
| quorumType? | any |
drop_databasedrop database
get_ddlget ddl
get_scansget scans
restorerestore
| Argument | Type | Description |
|---|---|---|
| backup? | any | |
| databaseId? | any | |
| encryptionConfig? | any |
update_ddlupdate ddl
| Argument | Type | Description |
|---|---|---|
| operationId? | any | |
| protoDescriptors? | any | |
| statements? | any |
Resources
state(infinite)— A Cloud Spanner database.
@swamp/gcp/spanner/instances-databases-backupschedulesv2026.04.23.1instances_databases_backupschedules.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| encryptionConfig? | object | Encryption configuration for the backup to create. |
| fullBackupSpec? | object | The specification for full backups. A full backup stores the entire contents of the database at a given version time. |
| incrementalBackupSpec? | object | The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. |
| retentionDuration? | string | Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. |
| spec? | object | Defines specifications of the backup schedule. |
| backupScheduleId? | string | Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a backupSchedules
getGet a backupSchedules
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupSchedules |
updateUpdate backupSchedules attributes
deleteDelete the backupSchedules
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupSchedules |
syncSync backupSchedules state from GCP
Resources
state(infinite)— BackupSchedule expresses the automated backup creation specification for a Sp...
@swamp/gcp/spanner/instances-databases-databaserolesv2026.04.23.1instances_databases_databaseroles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a databaseRoles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databaseRoles |
syncSync databaseRoles state from GCP
Resources
state(infinite)— A Cloud Spanner database role.
@swamp/gcp/spanner/instances-databases-sessionsv2026.04.23.1instances_databases_sessions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| session? | object | A session in the Cloud Spanner API. |
| database | string | Required. The database in which the new session is created. |
createCreate a sessions
getGet a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
deleteDelete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
syncSync sessions state from GCP
adapteradapter
| Argument | Type | Description |
|---|---|---|
| name? | any |
adapt_messageadapt message
| Argument | Type | Description |
|---|---|---|
| attachments? | any | |
| payload? | any | |
| protocol? | any |
batch_createbatch create
| Argument | Type | Description |
|---|---|---|
| sessionCount? | any | |
| sessionTemplate? | any |
batch_writebatch write
| Argument | Type | Description |
|---|---|---|
| excludeTxnFromChangeStreams? | any | |
| mutationGroups? | any | |
| requestOptions? | any |
begin_transactionbegin transaction
| Argument | Type | Description |
|---|---|---|
| mutationKey? | any | |
| options? | any | |
| requestOptions? | any |
commitcommit
| Argument | Type | Description |
|---|---|---|
| maxCommitDelay? | any | |
| mutations? | any | |
| precommitToken? | any | |
| requestOptions? | any | |
| returnCommitStats? | any | |
| singleUseTransaction? | any | |
| transactionId? | any |
execute_batch_dmlexecute batch dml
| Argument | Type | Description |
|---|---|---|
| lastStatements? | any | |
| requestOptions? | any | |
| seqno? | any | |
| statements? | any | |
| transaction? | any |
execute_sqlexecute sql
| Argument | Type | Description |
|---|---|---|
| dataBoostEnabled? | any | |
| directedReadOptions? | any | |
| lastStatement? | any | |
| paramTypes? | any | |
| params? | any | |
| partitionToken? | any | |
| queryMode? | any | |
| queryOptions? | any | |
| requestOptions? | any | |
| resumeToken? | any | |
| seqno? | any | |
| sql? | any | |
| transaction? | any |
execute_streaming_sqlexecute streaming sql
| Argument | Type | Description |
|---|---|---|
| dataBoostEnabled? | any | |
| directedReadOptions? | any | |
| lastStatement? | any | |
| paramTypes? | any | |
| params? | any | |
| partitionToken? | any | |
| queryMode? | any | |
| queryOptions? | any | |
| requestOptions? | any | |
| resumeToken? | any | |
| seqno? | any | |
| sql? | any | |
| transaction? | any |
partition_querypartition query
| Argument | Type | Description |
|---|---|---|
| paramTypes? | any | |
| params? | any | |
| partitionOptions? | any | |
| sql? | any | |
| transaction? | any |
partition_readpartition read
| Argument | Type | Description |
|---|---|---|
| columns? | any | |
| index? | any | |
| keySet? | any | |
| partitionOptions? | any | |
| table? | any | |
| transaction? | any |
readread
| Argument | Type | Description |
|---|---|---|
| columns? | any | |
| index? | any | |
| keySet? | any | |
| partitionOptions? | any | |
| table? | any | |
| transaction? | any |
rollbackrollback
| Argument | Type | Description |
|---|---|---|
| transactionId? | any |
streaming_readstreaming read
| Argument | Type | Description |
|---|---|---|
| columns? | any | |
| dataBoostEnabled? | any | |
| directedReadOptions? | any | |
| index? | any | |
| keySet? | any | |
| limit? | any | |
| lockHint? | any | |
| orderBy? | any | |
| partitionToken? | any | |
| requestOptions? | any | |
| resumeToken? | any | |
| table? | any | |
| transaction? | any |
Resources
state(infinite)— A session in the Cloud Spanner API.
@swamp/gcp/spanner/instances-instancepartitionsv2026.04.23.1instances_instancepartitions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| instancePartition? | object | An isolated set of Cloud Spanner resources that databases can define placements on. |
| instancePartitionId? | string | Required. The ID of the instance partition to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. |
| fieldMask? | string | Required. A mask specifying which fields in InstancePartition should be updated. The field mask must always be specified; this prevents any future fields in InstancePartition from being erased accidentally by clients that do not know about them. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instancePartitions
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instancePartitions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instancePartitions |
updateUpdate instancePartitions attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instancePartitions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instancePartitions |
syncSync instancePartitions state from GCP
Resources
state(infinite)— An isolated set of Cloud Spanner resources that databases can define placemen...
@swamp/gcp/spanner/scansv2026.04.23.1scans.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
getGet a scans
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the scans |
syncSync scans state from GCP
Resources
state(infinite)— Scan is a structure which describes Cloud Key Visualizer scan information.
2026.04.04.185.1 KBApr 4, 2026
Google Cloud spanner infrastructure models
Release Notes
- Updated: instances, instances_databases, instances_instancepartitions, scans
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudspannercloudinfrastructure
2026.04.03.384.9 KBApr 3, 2026
Google Cloud spanner infrastructure models
Release Notes
- Updated: instanceconfigs, instances, instances_backups, instances_databases, instances_databases_backupschedules, instances_databases_databaseroles, instances_databases_sessions, instances_instancepartitions, scans
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudspannercloudinfrastructure
2026.04.03.184.1 KBApr 3, 2026
Google Cloud spanner infrastructure models
Release Notes
- Updated: instanceconfigs, instances, instances_backups, instances_databases, instances_databases_backupschedules, instances_databases_databaseroles, instances_databases_sessions, instances_instancepartitions, scans
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudspannercloudinfrastructure
2026.04.02.283.9 KBApr 2, 2026
Google Cloud spanner infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudspannercloudinfrastructure
2026.03.27.182.2 KBMar 27, 2026
Google Cloud spanner infrastructure models
Release Notes
- Added: instanceconfigs, instances, instances_backups, instances_databases, instances_databases_backupschedules, instances_databases_databaseroles, instances_databases_sessions, instances_instancepartitions, scans
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudspannercloudinfrastructure