schema_bundles

Creates, updates, deletes, gets or lists a schema_bundles resource.

Overview

Name	schema_bundles
Type	Resource
Id	google.bigtableadmin.schema_bundles

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The unique name identifying this schema bundle. Values are of the form projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}
etag	string	Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
protoSchema	object	Schema for Protobufs. (id: ProtoSchema)

list

Successful response

Name	Datatype	Description
name	string	Identifier. The unique name identifying this schema bundle. Values are of the form projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}
etag	string	Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
protoSchema	object	Schema for Protobufs. (id: ProtoSchema)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, instancesId, tablesId, schemaBundlesId		Gets metadata information about the specified schema bundle.
list	select	projectsId, instancesId, tablesId	pageSize, pageToken, view	Lists all schema bundles associated with the specified table.
create	insert	projectsId, instancesId, tablesId	schemaBundleId	Creates a new schema bundle in the specified table.
patch	update	projectsId, instancesId, tablesId, schemaBundlesId	updateMask, ignoreWarnings	Updates a schema bundle in the specified table.
delete	delete	projectsId, instancesId, tablesId, schemaBundlesId	etag	Deletes a schema bundle in the specified table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancesId	string
projectsId	string
schemaBundlesId	string
tablesId	string
etag	string
ignoreWarnings	boolean
pageSize	integer (int32)
pageToken	string
schemaBundleId	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets metadata information about the specified schema bundle.

SELECT
name,
etag,
protoSchema
FROM google.bigtableadmin.schema_bundles
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND tablesId = '{{ tablesId }}' -- required
AND schemaBundlesId = '{{ schemaBundlesId }}' -- required;

list

Lists all schema bundles associated with the specified table.

SELECT
name,
etag,
protoSchema
FROM google.bigtableadmin.schema_bundles
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND tablesId = '{{ tablesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}';

INSERT examples

create

Creates a new schema bundle in the specified table.

INSERT INTO google.bigtableadmin.schema_bundles (
data__name,
data__protoSchema,
data__etag,
projectsId,
instancesId,
tablesId,
schemaBundleId
)
SELECT 
'{{ name }}',
'{{ protoSchema }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ instancesId }}',
'{{ tablesId }}',
'{{ schemaBundleId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: schema_bundles
  props:
    - name: projectsId
      value: string
      description: Required parameter for the schema_bundles resource.
    - name: instancesId
      value: string
      description: Required parameter for the schema_bundles resource.
    - name: tablesId
      value: string
      description: Required parameter for the schema_bundles resource.
    - name: name
      value: string
      description: >
        Identifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`
        
    - name: protoSchema
      value: object
      description: >
        Schema for Protobufs.
        
    - name: etag
      value: string
      description: >
        Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.
        
    - name: schemaBundleId
      value: string

UPDATE examples

patch

Updates a schema bundle in the specified table.

UPDATE google.bigtableadmin.schema_bundles
SET 
data__name = '{{ name }}',
data__protoSchema = '{{ protoSchema }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND tablesId = '{{ tablesId }}' --required
AND schemaBundlesId = '{{ schemaBundlesId }}' --required
AND updateMask = '{{ updateMask}}'
AND ignoreWarnings = {{ ignoreWarnings}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a schema bundle in the specified table.

DELETE FROM google.bigtableadmin.schema_bundles
WHERE projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND tablesId = '{{ tablesId }}' --required
AND schemaBundlesId = '{{ schemaBundlesId }}' --required
AND etag = '{{ etag }}';