Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DbSystemSummary

A summary of a DB System.

Properties

accessMode

accessMode: string

The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges):

  • UNRESTRICTED: the access to the database is not restricted;
  • RESTRICTED: the access is allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

Optional backupPolicy

backupPolicy: model.BackupPolicy

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment the DB System belongs in.

Optional crashRecovery

crashRecovery: model.CrashRecoveryStatus

Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Optional currentPlacement

currentPlacement: model.DbSystemPlacement

Optional databaseManagement

databaseManagement: model.DatabaseManagementStatus

Whether to enable monitoring via the Database Management service.

databaseMode

databaseMode: string

The database mode indicating the types of statements that are allowed to run in the DB system. This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode.

  • READ_WRITE: allow running read and write statements on the DB system;
  • READ_ONLY: only allow running read statements on the DB system.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional deletionPolicy

deletionPolicy: model.DeletionPolicyDetails

Optional description

description: undefined | string

User-provided data about the DB System.

displayName

displayName: string

The user-friendly name for the DB System. It does not have to be unique.

Optional endpoints

The network endpoints available for this DB System.

Optional faultDomain

faultDomain: undefined | string

The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the fault domain in which the DB System is placed.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional heatWaveCluster

heatWaveCluster: model.HeatWaveClusterSummary

id

id: string

The OCID of the DB System.

Optional isHeatWaveClusterAttached

isHeatWaveClusterAttached: undefined | false | true

If the DB System has a HeatWave Cluster attached.

Optional isHighlyAvailable

isHighlyAvailable: undefined | false | true

Specifies if the DB System is highly available.

lifecycleState

lifecycleState: string

The current state of the DB System.

mysqlVersion

mysqlVersion: string

Name of the MySQL Version in use for the DB System.

Optional readEndpoint

readEndpoint: model.ReadEndpointDetails

Optional rest

rest: model.RestDetails

Optional shapeName

shapeName: undefined | string

The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the {@link #listShapes(ListShapesRequest) listShapes} operation.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The date and time the DB System was created.

timeUpdated

timeUpdated: Date

The time the DB System was last updated.

Functions

getDeserializedJsonObj

getJsonObj