databases

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

Overview

Name	databases
Type	Resource
Id	google.biglake.databases

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
createTime	string (google-datetime)	Output only. The creation time of the database.
deleteTime	string (google-datetime)	Output only. The deletion time of the database. Only set after the database is deleted.
expireTime	string (google-datetime)	Output only. The time when this database is considered expired. Only set after the database is deleted.
hiveOptions	object	Options of a Hive database. (id: HiveDatabaseOptions)
type	string	The database type.
updateTime	string (google-datetime)	Output only. The last modification time of the database.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
createTime	string (google-datetime)	Output only. The creation time of the database.
deleteTime	string (google-datetime)	Output only. The deletion time of the database. Only set after the database is deleted.
expireTime	string (google-datetime)	Output only. The time when this database is considered expired. Only set after the database is deleted.
hiveOptions	object	Options of a Hive database. (id: HiveDatabaseOptions)
type	string	The database type.
updateTime	string (google-datetime)	Output only. The last modification time of the database.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, catalogsId, databasesId		Gets the database specified by the resource name.
list	select	projectsId, locationsId, catalogsId	pageSize, pageToken	List all databases in a specified catalog.
create	insert	projectsId, locationsId, catalogsId	databaseId	Creates a new database.
patch	update	projectsId, locationsId, catalogsId, databasesId	updateMask	Updates an existing database specified by the database ID.
delete	delete	projectsId, locationsId, catalogsId, databasesId		Deletes an existing database specified by the database 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
databasesId	string
locationsId	string
projectsId	string
databaseId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the database specified by the resource name.

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

list

List all databases in a specified catalog.

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

INSERT examples

create

Creates a new database.

INSERT INTO google.biglake.databases (
data__hiveOptions,
data__type,
projectsId,
locationsId,
catalogsId,
databaseId
)
SELECT 
'{{ hiveOptions }}',
'{{ type }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ catalogsId }}',
'{{ databaseId }}'
RETURNING
name,
createTime,
deleteTime,
expireTime,
hiveOptions,
type,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: databases
  props:
    - name: projectsId
      value: string
      description: Required parameter for the databases resource.
    - name: locationsId
      value: string
      description: Required parameter for the databases resource.
    - name: catalogsId
      value: string
      description: Required parameter for the databases resource.
    - name: hiveOptions
      value: object
      description: >
        Options of a Hive database.
        
    - name: type
      value: string
      description: >
        The database type.
        
      valid_values: ['TYPE_UNSPECIFIED', 'HIVE']
    - name: databaseId
      value: string

UPDATE examples

patch

Updates an existing database specified by the database ID.

UPDATE google.biglake.databases
SET 
data__hiveOptions = '{{ hiveOptions }}',
data__type = '{{ type }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
AND databasesId = '{{ databasesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
deleteTime,
expireTime,
hiveOptions,
type,
updateTime;

DELETE examples

delete

Deletes an existing database specified by the database ID.

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