GCP.OracleDatabase reference

AutonomousDatabase

Source: src/GCP/OracleDatabase/AutonomousDatabase.ts

An Oracle Autonomous Database on Google Cloud.

Changing autonomousDatabaseId, location, database, network, cidr, odbNetwork, odbSubnet, sourceConfig, licenseType, dbWorkload, dbEdition, or dbVersion replaces the database. Labels, compute, storage, and auto-scaling patch in place.

Provisioning typically takes tens of minutes and requires an Oracle Database@Google Cloud entitlement.

AutonomousDatabase: Creating an Autonomous Database

Generated name on a VPC

const db = yield* GCP.OracleDatabase.AutonomousDatabase("AppDb", {
  network: "default",
  cidr: "10.10.0.0/24",
  adminPassword: "AlchemyTest1!",
  licenseType: "LICENSE_INCLUDED",
  dbWorkload: "OLTP",
  cpuCoreCount: 2,
  dataStorageSizeGb: 20,
});

Explicit id, ODB subnet, and labels

const db = yield* GCP.OracleDatabase.AutonomousDatabase("AppDb", {
  autonomousDatabaseId: "app-db",
  odbSubnet: subnet.name,
  adminPassword: "AlchemyTest1!",
  displayName: "app-db",
  labels: { env: "prod" },
  properties: {
    licenseType: "LICENSE_INCLUDED",
    dbWorkload: "OLTP",
    computeCount: 2,
    dataStorageSizeGb: 20,
  },
});

CloudExadataInfrastructure

Source: src/GCP/OracleDatabase/CloudExadataInfrastructure.ts

An Oracle Exadata Infrastructure on Google Cloud.

Changing cloudExadataInfrastructureId, location, gcpOracleZone, or shape replaces the infrastructure. There is no patch API in the distilled SDK, so labels and counts are applied at create.

Provisioning typically takes tens of minutes and requires an Oracle Database@Google Cloud entitlement. Delete sends force=true so child VM clusters do not block teardown.

CloudExadataInfrastructure: Creating Exadata Infrastructure

const infra = yield* GCP.OracleDatabase.CloudExadataInfrastructure("Exa", {
  displayName: "exa",
  shape: "Exadata.X9M",
  computeCount: 2,
  storageCount: 3,
});

CloudVmCluster

Source: src/GCP/OracleDatabase/CloudVmCluster.ts

An Oracle Exadata VM Cluster on Google Cloud.

Changing cloudVmClusterId, location, exadataInfrastructure, network identity (network/cidr/odbSubnet), or license type replaces the cluster. There is no patch API in the distilled SDK, so labels are applied at create.

Delete sends force=true so child resources do not block teardown.

CloudVmCluster: Creating a VM Cluster

const cluster = yield* GCP.OracleDatabase.CloudVmCluster("Vms", {
  exadataInfrastructure: infra.name,
  network: "default",
  cidr: "10.10.0.0/24",
  backupSubnetCidr: "10.10.1.0/24",
  licenseType: "LICENSE_INCLUDED",
  cpuCoreCount: 4,
  giVersion: "19.0.0.0",
  hostnamePrefix: "exa",
  sshPublicKeys: [publicKey],
});

DbSystem

Source: src/GCP/OracleDatabase/DbSystem.ts

An Oracle BaseDB system on Google Cloud.

Changing dbSystemId, location, odbSubnet, odbNetwork, shape, or gcpOracleZone replaces the system. There is no patch API in the distilled SDK, so labels are applied at create.

DbSystem: Creating a DbSystem

const db = yield* GCP.OracleDatabase.DbSystem("BaseDb", {
  displayName: "basedb",
  odbSubnet: subnet.name,
  shape: "VM.Standard.E4.Flex",
  sshPublicKeys: [publicKey],
  computeCount: 2,
  initialDataStorageSizeGb: 256,
  licenseModel: "LICENSE_INCLUDED",
  databaseEdition: "ENTERPRISE_EDITION",
});

ExadbVmCluster

Source: src/GCP/OracleDatabase/ExadbVmCluster.ts

An Oracle Exascale VM Cluster on Google Cloud.

Changing exadbVmClusterId, location, ODB identity, gridImageId, or exascaleDbStorageVault replaces the cluster. Labels and nodeCount patch in place (adding VMs). Removing VMs uses a separate API and is not modeled here.

ExadbVmCluster: Creating an Exadb VM Cluster

const cluster = yield* GCP.OracleDatabase.ExadbVmCluster("ExaVm", {
  displayName: "exavm",
  odbSubnet: subnet.name,
  backupOdbSubnet: backupSubnet.name,
  gridImageId: "19.0.0.0",
  hostnamePrefix: "exavm",
  sshPublicKeys: [publicKey],
  exascaleDbStorageVault: vault.name,
  enabledEcpuCountPerNode: 8,
  nodeCount: 2,
  properties: {
    vmFileSystemStorage: { sizeInGbsPerNode: 180 },
    shapeAttribute: "SMART_STORAGE",
  },
});

ExascaleDbStorageVault

Source: src/GCP/OracleDatabase/ExascaleDbStorageVault.ts

An Oracle Exascale DB storage vault on Google Cloud.

Changing exascaleDbStorageVaultId, location, exadataInfrastructure, or gcpOracleZone replaces the vault. There is no patch API in the distilled SDK, so labels are applied at create.

ExascaleDbStorageVault: Creating a storage vault

const vault = yield* GCP.OracleDatabase.ExascaleDbStorageVault("Vault", {
  displayName: "vault",
  totalSizeGbs: 300,
});

GenerateWallet

Source: src/GCP/OracleDatabase/GenerateWallet.ts

Runtime binding for Oracle Database autonomousDatabases.generateWallet.

Grants roles/oracledatabase.autonomousDatabaseAdmin on the project because autonomousDatabases.generateWallet is only in the admin roles and Oracle Database@Google Cloud has no per-resource IAM.

GenerateWallet: Downloading a wallet

const generateWallet = yield* GCP.OracleDatabase.GenerateWallet(db);
const wallet = yield* generateWallet({
  body: { password: "AlchemyTest1!", type: "SINGLE" },
});

GenerateWalletHttp

Source: src/GCP/OracleDatabase/GenerateWalletHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GenerateWallet

HTTP implementation of GenerateWallet.

GetAutonomousDatabase

Source: src/GCP/OracleDatabase/GetAutonomousDatabase.ts

Runtime binding for Oracle Database autonomousDatabases.get.

GetAutonomousDatabase: Observing Autonomous Databases

const get = yield* GCP.OracleDatabase.GetAutonomousDatabase(db);
const live = yield* get();

GetAutonomousDatabaseHttp

Source: src/GCP/OracleDatabase/GetAutonomousDatabaseHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetAutonomousDatabase

HTTP implementation of GetAutonomousDatabase.

GetCloudExadataInfrastructure

Source: src/GCP/OracleDatabase/GetCloudExadataInfrastructure.ts

Runtime binding for Oracle Database cloudExadataInfrastructures.get.

GetCloudExadataInfrastructure: Observing Exadata Infrastructure

const get = yield* GCP.OracleDatabase.GetCloudExadataInfrastructure(infra);
const live = yield* get();

GetCloudExadataInfrastructureHttp

Source: src/GCP/OracleDatabase/GetCloudExadataInfrastructureHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetCloudExadataInfrastructure

HTTP implementation of GetCloudExadataInfrastructure.

GetCloudVmCluster

Source: src/GCP/OracleDatabase/GetCloudVmCluster.ts

Runtime binding for Oracle Database cloudVmClusters.get.

GetCloudVmCluster: Observing VM Clusters

const get = yield* GCP.OracleDatabase.GetCloudVmCluster(cluster);
const live = yield* get();

GetCloudVmClusterHttp

Source: src/GCP/OracleDatabase/GetCloudVmClusterHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetCloudVmCluster

HTTP implementation of GetCloudVmCluster.

GetDbSystem

Source: src/GCP/OracleDatabase/GetDbSystem.ts

Runtime binding for Oracle Database dbSystems.get.

GetDbSystem: Observing DbSystems

const get = yield* GCP.OracleDatabase.GetDbSystem(system);
const live = yield* get();

GetDbSystemHttp

Source: src/GCP/OracleDatabase/GetDbSystemHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetDbSystem

HTTP implementation of GetDbSystem.

GetExadbVmCluster

Source: src/GCP/OracleDatabase/GetExadbVmCluster.ts

Runtime binding for Oracle Database exadbVmClusters.get.

GetExadbVmCluster: Observing Exadb VM Clusters

const get = yield* GCP.OracleDatabase.GetExadbVmCluster(cluster);
const live = yield* get();

GetExadbVmClusterHttp

Source: src/GCP/OracleDatabase/GetExadbVmClusterHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetExadbVmCluster

HTTP implementation of GetExadbVmCluster.

GetExascaleDbStorageVault

Source: src/GCP/OracleDatabase/GetExascaleDbStorageVault.ts

Runtime binding for Oracle Database exascaleDbStorageVaults.get.

GetExascaleDbStorageVault: Observing storage vaults

const get = yield* GCP.OracleDatabase.GetExascaleDbStorageVault(vault);
const live = yield* get();

GetExascaleDbStorageVaultHttp

Source: src/GCP/OracleDatabase/GetExascaleDbStorageVaultHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetExascaleDbStorageVault

HTTP implementation of GetExascaleDbStorageVault.

GetGoldengateConnection

Source: src/GCP/OracleDatabase/GetGoldengateConnection.ts

Runtime binding for Oracle Database goldengateConnections.get.

GetGoldengateConnection: Observing GoldenGate connections

const get = yield* GCP.OracleDatabase.GetGoldengateConnection(conn);
const live = yield* get();

GetGoldengateConnectionAssignment

Source: src/GCP/OracleDatabase/GetGoldengateConnectionAssignment.ts

Runtime binding for Oracle Database goldengateConnectionAssignments.get.

GetGoldengateConnectionAssignment: Observing assignments

const get = yield* GCP.OracleDatabase.GetGoldengateConnectionAssignment(a);
const live = yield* get();

GetGoldengateConnectionAssignmentHttp

Source: src/GCP/OracleDatabase/GetGoldengateConnectionAssignmentHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetGoldengateConnectionAssignment

HTTP implementation of GetGoldengateConnectionAssignment.

GetGoldengateConnectionHttp

Source: src/GCP/OracleDatabase/GetGoldengateConnectionHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetGoldengateConnection

HTTP implementation of GetGoldengateConnection.

GetGoldengateDeployment

Source: src/GCP/OracleDatabase/GetGoldengateDeployment.ts

Runtime binding for Oracle Database goldengateDeployments.get.

GetGoldengateDeployment: Observing a GoldenGate Deployment

const get = yield* GCP.OracleDatabase.GetGoldengateDeployment(gg);
const live = yield* get();

GetGoldengateDeploymentHttp

Source: src/GCP/OracleDatabase/GetGoldengateDeploymentHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetGoldengateDeployment

HTTP implementation of GetGoldengateDeployment.

GetOdbNetwork

Source: src/GCP/OracleDatabase/GetOdbNetwork.ts

Runtime binding for Oracle Database odbNetworks.get.

GetOdbNetwork: Observing an ODB Network

const get = yield* GCP.OracleDatabase.GetOdbNetwork(net);
const live = yield* get();

GetOdbNetworkHttp

Source: src/GCP/OracleDatabase/GetOdbNetworkHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetOdbNetwork

HTTP implementation of GetOdbNetwork.

GetOdbNetworksOdbSubnet

Source: src/GCP/OracleDatabase/GetOdbNetworksOdbSubnet.ts

Runtime binding for Oracle Database odbSubnets.get.

GetOdbNetworksOdbSubnet: Observing an ODB Subnet

const get = yield* GCP.OracleDatabase.GetOdbNetworksOdbSubnet(subnet);
const live = yield* get();

GetOdbNetworksOdbSubnetHttp

Source: src/GCP/OracleDatabase/GetOdbNetworksOdbSubnetHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.GetOdbNetworksOdbSubnet

HTTP implementation of GetOdbNetworksOdbSubnet.

GoldengateConnection

Source: src/GCP/OracleDatabase/GoldengateConnection.ts

An Oracle GoldenGate connection on Google Cloud.

Changing goldengateConnectionId, location, connectionType, or ODB identity replaces the connection. There is no patch API in the distilled SDK, so labels are applied at create.

GoldengateConnection: Creating a GoldenGate connection

const conn = yield* GCP.OracleDatabase.GoldengateConnection("Src", {
  connectionType: "GENERIC",
  displayName: "src",
  properties: {
    genericConnectionProperties: {
      host: "db.example.com",
      technologyType: "GENERIC",
    },
  },
});

GoldengateConnectionAssignment

Source: src/GCP/OracleDatabase/GoldengateConnectionAssignment.ts

An Oracle GoldenGate connection assignment on Google Cloud.

Changing goldengateConnectionAssignmentId, location, the connection, or the deployment replaces the assignment. There is no patch API in the distilled SDK, so labels are applied at create.

GoldengateConnectionAssignment: Creating an assignment

const assignment = yield* GCP.OracleDatabase.GoldengateConnectionAssignment(
  "Assign",
  {
    goldengateConnection: connection.name,
    goldengateDeployment: deployment.name,
    displayName: "assign",
  },
);

GoldengateDeployment

Source: src/GCP/OracleDatabase/GoldengateDeployment.ts

An Oracle Database@Google Cloud GoldenGate deployment.

Changing goldengateDeploymentId, location, odbNetwork, odbSubnet, gcpOracleZone, deploymentType, or oggData.deployment replaces the deployment. Labels and most properties are set at create; the API has no update. Requires an Oracle Database@Google Cloud entitlement and a client ODB Subnet.

GoldengateDeployment: Creating a GoldenGate Deployment

Oracle GoldenGate on an ODB Subnet

const gg = yield* GCP.OracleDatabase.GoldengateDeployment("Replicat", {
  odbSubnet: subnet.name,
  odbNetwork: net.name,
  displayName: "app-gg",
  deploymentType: "DATABASE_ORACLE",
  oggData: {
    adminUsername: "oggadmin",
    deployment: "oggdeploy",
    adminPassword: "change-me",
  },
});

Explicit id and labels

const gg = yield* GCP.OracleDatabase.GoldengateDeployment("Replicat", {
  goldengateDeploymentId: "app-gg",
  odbSubnet: subnet.name,
  deploymentType: "DATABASE_ORACLE",
  oggData: {
    adminUsername: "oggadmin",
    deployment: "oggdeploy",
    adminPasswordSecretVersion: secret.latestVersionName,
  },
  labels: { env: "prod" },
});

OdbNetwork

Source: src/GCP/OracleDatabase/OdbNetwork.ts

An Oracle Database@Google Cloud ODB Network — the private network that connects a VPC to Oracle Database resources in a region.

Changing odbNetworkId, location, network, or gcpOracleZone replaces the network. Labels are set at create; the API has no update. Requires an Oracle Database@Google Cloud marketplace entitlement.

OdbNetwork: Creating an ODB Network

Generated name on the default VPC

const net = yield* GCP.OracleDatabase.OdbNetwork("OracleNet", {});

Explicit id, labels, and network

const net = yield* GCP.OracleDatabase.OdbNetwork("OracleNet", {
  odbNetworkId: "app-odb",
  location: "us-central1",
  network: "default",
  labels: { env: "prod" },
});

OdbNetworksOdbSubnet

Source: src/GCP/OracleDatabase/OdbNetworksOdbSubnet.ts

An Oracle Database@Google Cloud ODB Subnet inside an ODB Network.

Changing odbNetwork, odbSubnetId, location, cidrRange, or purpose replaces the subnet. Labels are set at create; the API has no update. Requires an Oracle Database@Google Cloud entitlement and a parent ODB Network.

OdbNetworksOdbSubnet: Creating an ODB Subnet

Client subnet under an ODB Network

const subnet = yield* GCP.OracleDatabase.OdbNetworksOdbSubnet("Client", {
  odbNetwork: net.name,
  cidrRange: "10.250.0.0/27",
  purpose: "CLIENT_SUBNET",
});

Backup subnet with labels

const subnet = yield* GCP.OracleDatabase.OdbNetworksOdbSubnet("Backup", {
  odbNetwork: net.name,
  cidrRange: "10.250.0.32/27",
  purpose: "BACKUP_SUBNET",
  labels: { env: "prod" },
});

RestartAutonomousDatabase

Source: src/GCP/OracleDatabase/RestartAutonomousDatabase.ts

Runtime binding for Oracle Database autonomousDatabases.restart.

Grants roles/oracledatabase.autonomousDatabaseAdmin on the project because autonomousDatabases.restart is only in the admin roles and Oracle Database@Google Cloud has no per-resource IAM.

RestartAutonomousDatabase: Restarting a database

const restart = yield* GCP.OracleDatabase.RestartAutonomousDatabase(db);
yield* restart();

RestartAutonomousDatabaseHttp

Source: src/GCP/OracleDatabase/RestartAutonomousDatabaseHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.RestartAutonomousDatabase

HTTP implementation of RestartAutonomousDatabase.

StartAutonomousDatabase

Source: src/GCP/OracleDatabase/StartAutonomousDatabase.ts

Runtime binding for Oracle Database autonomousDatabases.start.

Grants roles/oracledatabase.autonomousDatabaseAdmin on the project because autonomousDatabases.start is only in the admin roles and Oracle Database@Google Cloud has no per-resource IAM.

StartAutonomousDatabase: Starting a database

const start = yield* GCP.OracleDatabase.StartAutonomousDatabase(db);
yield* start();

StartAutonomousDatabaseHttp

Source: src/GCP/OracleDatabase/StartAutonomousDatabaseHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.StartAutonomousDatabase

HTTP implementation of StartAutonomousDatabase.

StopAutonomousDatabase

Source: src/GCP/OracleDatabase/StopAutonomousDatabase.ts

Runtime binding for Oracle Database autonomousDatabases.stop.

Grants roles/oracledatabase.autonomousDatabaseAdmin on the project because autonomousDatabases.stop is only in the admin roles and Oracle Database@Google Cloud has no per-resource IAM.

StopAutonomousDatabase: Stopping a database

const stop = yield* GCP.OracleDatabase.StopAutonomousDatabase(db);
yield* stop();

StopAutonomousDatabaseHttp

Source: src/GCP/OracleDatabase/StopAutonomousDatabaseHttp.ts Kind: Layer · Provides: GCP.OracleDatabase.StopAutonomousDatabase

HTTP implementation of StopAutonomousDatabase.