databases

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

Overview

Name	databases
Type	Resource
Id	google.oracledatabase.databases

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
adminPassword	string	Optional. The password for the default ADMIN user. Note: Only one of admin_password_secret_version or admin_password can be populated.
adminPasswordSecretVersion	string	Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of admin_password_secret_version or admin_password can be populated.
characterSet	string	Optional. The character set for the database. The default is AL32UTF8.
createTime	string (google-datetime)	Output only. The date and time that the Database was created.
databaseId	string	Optional. The database ID of the Database.
dbHomeName	string	Optional. The name of the DbHome resource associated with the Database.
dbName	string	Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
dbUniqueName	string	Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
gcpOracleZone	string	Output only. The GCP Oracle zone where the Database is created.
ncharacterSet	string	Optional. The national character set for the database. The default is AL16UTF16.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
opsInsightsStatus	string	Output only. The Status of Operations Insights for this Database. (OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED, ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING)
pluggableDatabaseId	string	Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.
pluggableDatabaseName	string	Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.
properties	object	Optional. The properties of the Database. (id: DatabaseProperties)
tdeWalletPassword	string	Optional. The TDE wallet password for the database. Note: Only one of tde_wallet_password_secret_version or tde_wallet_password can be populated.
tdeWalletPasswordSecretVersion	string	Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of tde_wallet_password_secret_version or tde_wallet_password can be populated.

list

Name	Datatype	Description
name	string	Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
adminPassword	string	Optional. The password for the default ADMIN user. Note: Only one of admin_password_secret_version or admin_password can be populated.
adminPasswordSecretVersion	string	Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of admin_password_secret_version or admin_password can be populated.
characterSet	string	Optional. The character set for the database. The default is AL32UTF8.
createTime	string (google-datetime)	Output only. The date and time that the Database was created.
databaseId	string	Optional. The database ID of the Database.
dbHomeName	string	Optional. The name of the DbHome resource associated with the Database.
dbName	string	Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
dbUniqueName	string	Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
gcpOracleZone	string	Output only. The GCP Oracle zone where the Database is created.
ncharacterSet	string	Optional. The national character set for the database. The default is AL16UTF16.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
opsInsightsStatus	string	Output only. The Status of Operations Insights for this Database. (OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED, ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING)
pluggableDatabaseId	string	Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.
pluggableDatabaseName	string	Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.
properties	object	Optional. The properties of the Database. (id: DatabaseProperties)
tdeWalletPassword	string	Optional. The TDE wallet password for the database. Note: Only one of tde_wallet_password_secret_version or tde_wallet_password can be populated.
tdeWalletPasswordSecretVersion	string	Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of tde_wallet_password_secret_version or tde_wallet_password can be populated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, databasesId		Gets details of a single Database.
list	select	projectsId, locationsId	pageToken, filter, pageSize	Lists all the Databases for the given project, location and DbSystem.

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

SELECT examples

get

Gets details of a single Database.

SELECT
name,
adminPassword,
adminPasswordSecretVersion,
characterSet,
createTime,
databaseId,
dbHomeName,
dbName,
dbUniqueName,
gcpOracleZone,
ncharacterSet,
ociUrl,
opsInsightsStatus,
pluggableDatabaseId,
pluggableDatabaseName,
properties,
tdeWalletPassword,
tdeWalletPasswordSecretVersion
FROM google.oracledatabase.databases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND databasesId = '{{ databasesId }}' -- required
;

list

Lists all the Databases for the given project, location and DbSystem.

SELECT
name,
adminPassword,
adminPasswordSecretVersion,
characterSet,
createTime,
databaseId,
dbHomeName,
dbName,
dbUniqueName,
gcpOracleZone,
ncharacterSet,
ociUrl,
opsInsightsStatus,
pluggableDatabaseId,
pluggableDatabaseName,
properties,
tdeWalletPassword,
tdeWalletPasswordSecretVersion
FROM google.oracledatabase.databases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;