catalogs

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

Overview

Name	catalogs
Type	Resource
Id	google.biglake.catalogs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
createTime	string (google-datetime)	Output only. The creation time of the catalog.
deleteTime	string (google-datetime)	Output only. The deletion time of the catalog. Only set after the catalog is deleted.
expireTime	string (google-datetime)	Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
updateTime	string (google-datetime)	Output only. The last modification time of the catalog.

list

Name	Datatype	Description
name	string	Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
createTime	string (google-datetime)	Output only. The creation time of the catalog.
deleteTime	string (google-datetime)	Output only. The deletion time of the catalog. Only set after the catalog is deleted.
expireTime	string (google-datetime)	Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.
updateTime	string (google-datetime)	Output only. The last modification time of the catalog.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, catalogsId		Gets the catalog specified by the resource name.
list	select	projectsId, locationsId	pageSize, pageToken	List all catalogs in a specified project.
create	insert	projectsId, locationsId	catalogId	Creates a new catalog.
delete	delete	projectsId, locationsId, catalogsId		Deletes an existing catalog specified by the catalog ID.

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
catalogsId	string
locationsId	string
projectsId	string
catalogId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets the catalog specified by the resource name.

SELECT
name,
createTime,
deleteTime,
expireTime,
updateTime
FROM google.biglake.catalogs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND catalogsId = '{{ catalogsId }}' -- required
;

list

List all catalogs in a specified project.

SELECT
name,
createTime,
deleteTime,
expireTime,
updateTime
FROM google.biglake.catalogs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new catalog.

INSERT INTO google.biglake.catalogs (
projectsId,
locationsId,
catalogId
)
SELECT 
'{{ projectsId }}',
'{{ locationsId }}',
'{{ catalogId }}'
RETURNING
name,
createTime,
deleteTime,
expireTime,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: catalogs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the catalogs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the catalogs resource.
  - name: catalogId
    value: "{{ catalogId }}"

DELETE examples

delete

Deletes an existing catalog specified by the catalog ID.

DELETE FROM google.biglake.catalogs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
;