materialized_views

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

Overview

Name	materialized_views
Type	Resource
Id	google.bigtableadmin.materialized_views

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The unique name of the materialized view. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view} Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
clusterStates	object	Output only. Map from cluster ID to per-cluster materialized view state. If it could not be determined whether or not the materialized view has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with STATE_NOT_KNOWN state. Views: REPLICATION_VIEW, FULL.
deletionProtection	boolean	Set to true to make the MaterializedView protected against deletion. Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
etag	string	Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
query	string	Required. Immutable. The materialized view's select query. Views: SCHEMA_VIEW, FULL.

list

Name	Datatype	Description
name	string	Identifier. The unique name of the materialized view. Format: projects/{project}/instances/{instance}/materializedViews/{materialized_view} Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
clusterStates	object	Output only. Map from cluster ID to per-cluster materialized view state. If it could not be determined whether or not the materialized view has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with STATE_NOT_KNOWN state. Views: REPLICATION_VIEW, FULL.
deletionProtection	boolean	Set to true to make the MaterializedView protected against deletion. Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
etag	string	Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: SCHEMA_VIEW, REPLICATION_VIEW, FULL.
query	string	Required. Immutable. The materialized view's select query. Views: SCHEMA_VIEW, FULL.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, instancesId, materializedViewsId	view	Gets information about a materialized view.
list	select	projectsId, instancesId	pageToken, pageSize, view	Lists information about materialized views in an instance.
create	insert	projectsId, instancesId	materializedViewId	Creates a materialized view within an instance.
patch	update	projectsId, instancesId, materializedViewsId	updateMask	Updates a materialized view within an instance.
delete	delete	projectsId, instancesId, materializedViewsId	etag	Deletes a materialized view from an instance.

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
materializedViewsId	string
projectsId	string
etag	string
materializedViewId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets information about a materialized view.

SELECT
name,
clusterStates,
deletionProtection,
etag,
query
FROM google.bigtableadmin.materialized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND materializedViewsId = '{{ materializedViewsId }}' -- required
AND view = '{{ view }}'
;

list

Lists information about materialized views in an instance.

SELECT
name,
clusterStates,
deletionProtection,
etag,
query
FROM google.bigtableadmin.materialized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND view = '{{ view }}'
;

INSERT examples

create

Creates a materialized view within an instance.

INSERT INTO google.bigtableadmin.materialized_views (
data__etag,
data__query,
data__name,
data__deletionProtection,
projectsId,
instancesId,
materializedViewId
)
SELECT 
'{{ etag }}',
'{{ query }}',
'{{ name }}',
{{ deletionProtection }},
'{{ projectsId }}',
'{{ instancesId }}',
'{{ materializedViewId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: materialized_views
  props:
    - name: projectsId
      value: string
      description: Required parameter for the materialized_views resource.
    - name: instancesId
      value: string
      description: Required parameter for the materialized_views resource.
    - name: etag
      value: string
      description: >
        Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
        
    - name: query
      value: string
      description: >
        Required. Immutable. The materialized view's select query. Views: `SCHEMA_VIEW`, `FULL`.
        
    - name: name
      value: string
      description: >
        Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
        
    - name: deletionProtection
      value: boolean
      description: >
        Set to true to make the MaterializedView protected against deletion. Views: `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`.
        
    - name: materializedViewId
      value: string

UPDATE examples

patch

Updates a materialized view within an instance.

UPDATE google.bigtableadmin.materialized_views
SET 
data__etag = '{{ etag }}',
data__query = '{{ query }}',
data__name = '{{ name }}',
data__deletionProtection = {{ deletionProtection }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND materializedViewsId = '{{ materializedViewsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a materialized view from an instance.

DELETE FROM google.bigtableadmin.materialized_views
WHERE projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND materializedViewsId = '{{ materializedViewsId }}' --required
AND etag = '{{ etag }}'
;