config

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

Overview

Name	config
Type	Resource
Id	google.dataform.config

Fields

The following fields are returned by SELECT queries:

get_config

Successful response

Name	Datatype	Description
name	string	Identifier. The config name.
defaultKmsKeyName	string	Optional. The default KMS key that is used if no encryption key is provided when a repository is created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_config	select	projectsId, locationsId		Get default config for a given project and location.
update_config	update	projectsId, locationsId	updateMask	Update default config for a given project and location. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

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
locationsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_config

Get default config for a given project and location.

SELECT
name,
defaultKmsKeyName
FROM google.dataform.config
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

update_config

Update default config for a given project and location. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

UPDATE google.dataform.config
SET 
data__name = '{{ name }}',
data__defaultKmsKeyName = '{{ defaultKmsKeyName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
defaultKmsKeyName;