Skip to main content

@swamp/gcp/metastore

v2026.04.23.1

Google Cloud metastore infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudmetastorecloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

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/metastore

@swamp/gcp/metastore/federationsv2026.04.23.1federations.ts

Global Arguments

ArgumentTypeDescription
backendMetastores?recordA map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
labels?recordUser-defined labels for the metastore federation.
name?stringImmutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
version?stringImmutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
federationId?stringRequired. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
requestId?stringOptional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Univ
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a federations
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a federations
ArgumentTypeDescription
identifierstringThe name of the federations
updateUpdate federations attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the federations
ArgumentTypeDescription
identifierstringThe name of the federations
syncSync federations state from GCP

Resources

state(infinite)— Represents a federation of multiple backend metastores.
@swamp/gcp/metastore/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/metastore/servicesv2026.04.23.1services.ts

Global Arguments

ArgumentTypeDescription
databaseType?enumImmutable. The database type that the Metastore service stores its data.
deletionProtection?booleanOptional. Indicates if the dataproc metastore should be protected against accidental deletions.
encryptionConfig?objectEncryption settings for the service.
hiveMetastoreConfig?objectSpecifies configuration information specific to running Hive metastore software as the metastore service.
labels?recordUser-defined labels for the metastore service.
maintenanceWindow?objectMaintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.
metadataIntegration?objectSpecifies how metastore metadata should be integrated with external services.
metadataManagementActivity?objectThe metadata management activities of the metastore service.
name?stringImmutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
network?stringImmutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
networkConfig?objectNetwork configuration for the Dataproc Metastore service.
port?numberOptional. The TCP port at which the metastore service is reached. Default: 9083.
releaseChannel?enumImmutable. The release channel of the service. If unspecified, defaults to STABLE.
scalingConfig?objectRepresents the scaling configuration of a metastore service.
scheduledBackup?objectThis specifies the configuration of scheduled backup.
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
telemetryConfig?objectTelemetry Configuration for the Dataproc Metastore service.
tier?enumOptional. The tier of the service.
requestId?stringOptional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Univ
serviceId?stringRequired. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a services
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a services
ArgumentTypeDescription
identifierstringThe name of the services
updateUpdate services attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the services
ArgumentTypeDescription
identifierstringThe name of the services
syncSync services state from GCP
alter_locationalter location
ArgumentTypeDescription
locationUri?any
resourceName?any
alter_table_propertiesalter table properties
ArgumentTypeDescription
properties?any
tableName?any
updateMask?any
cancel_migrationcancel migration
complete_migrationcomplete migration
export_metadataexport metadata
ArgumentTypeDescription
databaseDumpType?any
destinationGcsFolder?any
requestId?any
move_table_to_databasemove table to database
ArgumentTypeDescription
dbName?any
destinationDbName?any
tableName?any
query_metadataquery metadata
ArgumentTypeDescription
query?any
restorerestore
ArgumentTypeDescription
backup?any
backupLocation?any
requestId?any
restoreType?any
start_migrationstart migration
ArgumentTypeDescription
migrationExecution?any
requestId?any

Resources

state(infinite)— A managed metastore service that serves metadata queries.
@swamp/gcp/metastore/services-backupsv2026.04.23.1services_backups.ts

Global Arguments

ArgumentTypeDescription
description?stringOptional. The description of the backup.
name?stringImmutable. Identifier. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}
serviceRevision?objectA managed metastore service that serves metadata queries.
backupId?stringRequired. The ID of the backup, which is used as the final component of the backup's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
requestId?stringOptional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Univ
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backups
ArgumentTypeDescription
identifierstringThe name of the backups
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP

Resources

state(infinite)— The details of a backup resource.
@swamp/gcp/metastore/services-metadataimportsv2026.04.23.1services_metadataimports.ts

Global Arguments

ArgumentTypeDescription
databaseDump?objectA specification of the location of and metadata about a database dump from a relational database management system.
description?stringOptional. The description of the metadata import.
name?stringImmutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.
metadataImportId?stringRequired. The ID of the metadata import, which is used as the final component of the metadata import's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
requestId?stringOptional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Univ
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a metadataImports
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a metadataImports
ArgumentTypeDescription
identifierstringThe name of the metadataImports
updateUpdate metadataImports attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync metadataImports state from GCP

Resources

state(infinite)— A metastore resource that imports metadata.
@swamp/gcp/metastore/services-migrationexecutionsv2026.04.23.1services_migrationexecutions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a migrationExecutions
ArgumentTypeDescription
identifierstringThe name of the migrationExecutions
deleteDelete the migrationExecutions
ArgumentTypeDescription
identifierstringThe name of the migrationExecutions
syncSync migrationExecutions state from GCP

Resources

state(infinite)— The details of a migration execution resource.