db_systems

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

Overview

Name	db_systems
Type	Resource
Id	google.oracledatabase.db_systems

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
createTime	string (google-datetime)	Output only. The date and time that the DbSystem was created.
displayName	string	Required. The display name for the System db. The name does not have to be unique within your project.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the DbSystem
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the DbSystem.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
odbSubnet	string	Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
properties	object	Optional. The properties of the DbSystem. (id: DbSystemProperties)

list

Name	Datatype	Description
name	string	Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
createTime	string (google-datetime)	Output only. The date and time that the DbSystem was created.
displayName	string	Required. The display name for the System db. The name does not have to be unique within your project.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the DbSystem
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the DbSystem.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
odbSubnet	string	Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
properties	object	Optional. The properties of the DbSystem. (id: DbSystemProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, dbSystemsId		Gets details of a single DbSystem.
list	select	projectsId, locationsId	pageToken, pageSize, orderBy, filter	Lists all the DbSystems for the given project and location.
create	insert	projectsId, locationsId	dbSystemId, requestId	Creates a new DbSystem in a given project and location.
delete	delete	projectsId, locationsId, dbSystemsId	requestId	Deletes a single 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
dbSystemsId	string
locationsId	string
projectsId	string
dbSystemId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single DbSystem.

SELECT
name,
createTime,
displayName,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.db_systems
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dbSystemsId = '{{ dbSystemsId }}' -- required
;

list

Lists all the DbSystems for the given project and location.

SELECT
name,
createTime,
displayName,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.db_systems
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
;

INSERT examples

create

Creates a new DbSystem in a given project and location.

INSERT INTO google.oracledatabase.db_systems (
data__properties,
data__displayName,
data__odbSubnet,
data__odbNetwork,
data__name,
data__gcpOracleZone,
data__labels,
projectsId,
locationsId,
dbSystemId,
requestId
)
SELECT 
'{{ properties }}',
'{{ displayName }}',
'{{ odbSubnet }}',
'{{ odbNetwork }}',
'{{ name }}',
'{{ gcpOracleZone }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dbSystemId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: db_systems
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the db_systems resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the db_systems resource.
  - name: properties
    description: |
      Optional. The properties of the DbSystem.
    value:
      initialDataStorageSizeGb: {{ initialDataStorageSizeGb }}
      dataStorageSizeGb: {{ dataStorageSizeGb }}
      computeModel: "{{ computeModel }}"
      memorySizeGb: {{ memorySizeGb }}
      timeZone:
        id: "{{ id }}"
        version: "{{ version }}"
      sshPublicKeys:
        - "{{ sshPublicKeys }}"
      licenseModel: "{{ licenseModel }}"
      hostname: "{{ hostname }}"
      dbHome:
        dbVersion: "{{ dbVersion }}"
        database:
          createTime: "{{ createTime }}"
          pluggableDatabaseId: "{{ pluggableDatabaseId }}"
          ncharacterSet: "{{ ncharacterSet }}"
          tdeWalletPasswordSecretVersion: "{{ tdeWalletPasswordSecretVersion }}"
          ociUrl: "{{ ociUrl }}"
          opsInsightsStatus: "{{ opsInsightsStatus }}"
          name: "{{ name }}"
          dbUniqueName: "{{ dbUniqueName }}"
          adminPassword: "{{ adminPassword }}"
          pluggableDatabaseName: "{{ pluggableDatabaseName }}"
          properties:
            dbVersion: "{{ dbVersion }}"
            dbBackupConfig:
              autoBackupEnabled: {{ autoBackupEnabled }}
              autoIncrementalBackupWindow: "{{ autoIncrementalBackupWindow }}"
              autoFullBackupDay: "{{ autoFullBackupDay }}"
              autoFullBackupWindow: "{{ autoFullBackupWindow }}"
              backupDestinationDetails: "{{ backupDestinationDetails }}"
              retentionPeriodDays: {{ retentionPeriodDays }}
              backupDeletionPolicy: "{{ backupDeletionPolicy }}"
            databaseManagementConfig:
              managementState: "{{ managementState }}"
              managementType: "{{ managementType }}"
            state: "{{ state }}"
          characterSet: "{{ characterSet }}"
          databaseId: "{{ databaseId }}"
          tdeWalletPassword: "{{ tdeWalletPassword }}"
          dbName: "{{ dbName }}"
          dbHomeName: "{{ dbHomeName }}"
          adminPasswordSecretVersion: "{{ adminPasswordSecretVersion }}"
          gcpOracleZone: "{{ gcpOracleZone }}"
        isUnifiedAuditingEnabled: {{ isUnifiedAuditingEnabled }}
        displayName: "{{ displayName }}"
      privateIp: "{{ privateIp }}"
      dataCollectionOptions:
        isDiagnosticsEventsEnabled: {{ isDiagnosticsEventsEnabled }}
        isIncidentLogsEnabled: {{ isIncidentLogsEnabled }}
      hostnamePrefix: "{{ hostnamePrefix }}"
      domain: "{{ domain }}"
      shape: "{{ shape }}"
      nodeCount: {{ nodeCount }}
      dbSystemOptions:
        storageManagement: "{{ storageManagement }}"
      ocid: "{{ ocid }}"
      computeCount: {{ computeCount }}
      recoStorageSizeGb: {{ recoStorageSizeGb }}
      lifecycleState: "{{ lifecycleState }}"
      databaseEdition: "{{ databaseEdition }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name for the System db. The name does not have to be unique within your project.
  - name: odbSubnet
    value: "{{ odbSubnet }}"
    description: |
      Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: odbNetwork
    value: "{{ odbNetwork }}"
    description: |
      Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
  - name: gcpOracleZone
    value: "{{ gcpOracleZone }}"
    description: |
      Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels or tags associated with the DbSystem.
  - name: dbSystemId
    value: "{{ dbSystemId }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a single DbSystem.

DELETE FROM google.oracledatabase.db_systems
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dbSystemsId = '{{ dbSystemsId }}' --required
AND requestId = '{{ requestId }}'
;