release_configs

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

Overview

Name	release_configs
Type	Resource
Id	google.dataform.release_configs

Fields

Name	Datatype	Description
name	string	Identifier. The release config's name.
codeCompilationConfig	object	Configures various aspects of Dataform code compilation.
cronSchedule	string	Optional. Optional schedule (in cron format) for automatic creation of compilation results.
disabled	boolean	Optional. Disables automatic creation of compilation results.
gitCommitish	string	Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: 12ade345 - a tag: tag1 - a branch name: branch1
recentScheduledReleaseRecords	array	Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of release_time. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
releaseCompilationResult	string	Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
timeZone	string	Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, releaseConfigsId, repositoriesId	Fetches a single ReleaseConfig.
list	SELECT	locationsId, projectsId, repositoriesId	Lists ReleaseConfigs in a given Repository.
create	INSERT	locationsId, projectsId, repositoriesId	Creates a new ReleaseConfig in a given Repository.
delete	DELETE	locationsId, projectsId, releaseConfigsId, repositoriesId	Deletes a single ReleaseConfig.
patch	UPDATE	locationsId, projectsId, releaseConfigsId, repositoriesId	Updates a single ReleaseConfig.

SELECT examples

Lists ReleaseConfigs in a given Repository.

SELECT
name,
codeCompilationConfig,
cronSchedule,
disabled,
gitCommitish,
recentScheduledReleaseRecords,
releaseCompilationResult,
timeZone
FROM google.dataform.release_configs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND repositoriesId = '{{ repositoriesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new release_configs resource.

All Properties

/*+ create */
INSERT INTO google.dataform.release_configs (
locationsId,
projectsId,
repositoriesId,
name,
gitCommitish,
codeCompilationConfig,
cronSchedule,
timeZone,
releaseCompilationResult,
disabled
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ repositoriesId }}',
'{{ name }}',
'{{ gitCommitish }}',
'{{ codeCompilationConfig }}',
'{{ cronSchedule }}',
'{{ timeZone }}',
'{{ releaseCompilationResult }}',
{{ disabled }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: gitCommitish
      value: string
    - name: codeCompilationConfig
      value:
        - name: defaultDatabase
          value: string
        - name: defaultSchema
          value: string
        - name: defaultLocation
          value: string
        - name: assertionSchema
          value: string
        - name: vars
          value: object
        - name: databaseSuffix
          value: string
        - name: schemaSuffix
          value: string
        - name: tablePrefix
          value: string
        - name: defaultNotebookRuntimeOptions
          value:
            - name: gcsOutputBucket
              value: string
    - name: cronSchedule
      value: string
    - name: timeZone
      value: string
    - name: recentScheduledReleaseRecords
      value:
        - - name: compilationResult
            value: string
          - name: errorStatus
            value:
              - name: code
                value: integer
              - name: message
                value: string
              - name: details
                value:
                  - object
          - name: releaseTime
            value: string
    - name: releaseCompilationResult
      value: string
    - name: disabled
      value: boolean

UPDATE example

Updates a release_configs resource.

/*+ update */
UPDATE google.dataform.release_configs
SET 
name = '{{ name }}',
gitCommitish = '{{ gitCommitish }}',
codeCompilationConfig = '{{ codeCompilationConfig }}',
cronSchedule = '{{ cronSchedule }}',
timeZone = '{{ timeZone }}',
releaseCompilationResult = '{{ releaseCompilationResult }}',
disabled = true|false
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND releaseConfigsId = '{{ releaseConfigsId }}'
AND repositoriesId = '{{ repositoriesId }}';

DELETE example

Deletes the specified release_configs resource.

/*+ delete */
DELETE FROM google.dataform.release_configs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND releaseConfigsId = '{{ releaseConfigsId }}'
AND repositoriesId = '{{ repositoriesId }}';