Show / Hide Table of Contents

Namespace Oci.MysqlService.Models

Classes

AddHeatWaveClusterDetails

Details required to add a HeatWave cluster.

AnonymousTransactionsHandling

Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.

AnonymousTransactionsHandlingModelConverter

AssignManualUuidHandling

Enables assignment of IDs on the target to anonymous transactions coming from the source. A manually defined UUID is added as a prefix to the ID.

AssignTargetUuidHandling

Enables assignment of IDs on the target to anonymous transactions coming from the source. The target server UUID is added as a prefix to the ID.

Backup

A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

BackupPolicy

The Backup policy for the DB System.

BackupSummary

Details of Backups such as OCID, description, backupType, and so on.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

CaCertificate

The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.

CaCertificateModelConverter

ChangeBackupCompartmentDetails

OCID of the target compartment for DB System Backup change compartment request.

Channel

A Channel connecting a DB System to an external entity.

ChannelFilter

Replication filter rule for a channel.

ChannelSource

Parameters detailing how to provision the source for the given Channel.

ChannelSourceModelConverter

ChannelSourceMysql

Core properties of a Mysql Channel source.

ChannelSummary

Summary of a Channel.

ChannelTarget

Details about the Channel target.

ChannelTargetDbSystem

Core properties of a DB System Channel target.

ChannelTargetModelConverter

Configuration

The set of MySQL variables to be used when deploying a MySQL Database Service DB System.

ConfigurationSummary

The general details of a Configuration such as its id, displayName, type, and shape association.

ConfigurationVariables

User-defined service variables.

CopyBackupDetails

Details required to copy a DB system backup from its source region to a destination region.

CopyPolicy

A policy of a DB system to schedule cross-region DB system backup copy.

CreateBackupDetails

Complete information for a Backup.

CreateBackupPolicyDetails

Backup policy as optionally used for DB System Creation.

CreateChannelDetails

Details required to create a Channel.

CreateChannelSourceDetails

Parameters detailing how to provision the source for the given Channel.

CreateChannelSourceDetailsModelConverter

CreateChannelSourceFromMysqlDetails

Parameters detailing how to provision the source endpoint that is a MySQL Server. Typically a MySQL Server that is not managed by the MySQL Database Service.

CreateChannelTargetDetails

Parameters detailing how to provision the target for the given Channel.

CreateChannelTargetDetailsModelConverter

CreateChannelTargetFromDbSystemDetails

Parameters detailing how to provision the target endpoint that is a DB System.

CreateConfigurationDetails

The details required to create a new Configuration.

CreateDbSystemDetails

Details required to create a DB System.

CreateDbSystemSourceDetails

Parameters detailing how to provision the initial data of the system.

CreateDbSystemSourceDetailsModelConverter

CreateDbSystemSourceFromBackupDetails

Use the backupId to specify from which backup the new DB System will be created.

CreateDbSystemSourceFromNoneDetails

Creation of a DbSystem from no particular source.

CreateDbSystemSourceFromPitrDetails

DB System OCID to perform a point in time recovery to the current point in time.
DB System OCID and recovery point to perform a point in time recovery to the specified recovery point.

CreateDbSystemSourceImportFromUrlDetails

An Object Storage PAR from which to import the DB System initial data.

CreateDeletionPolicyDetails

Policy for how the DB System and related resources should be handled at the time of its deletion.

CreateMaintenanceDetails

The Maintenance Policy for the DB System or Read Replica that this model is included in.

CreateReadEndpointDetails

Details required to create a Read Endpoint.

CreateReplicaDetails

Details required to create a read replica.

CreateRestDetails

Details required to configure REST while creating a DB System.

CustomerContact

Customer contact information that will be used by Oracle to provide notifications needed by DB System administrators.

DataStorage

Data Storage information.

DataStorageDetails

Data Storage configuration properties.

DbSystem

A DB System is the core logical unit of MySQL Database Service.

DbSystemEndpoint

A particular functional endpoint for access to a DB System, and the properties that apply to it.

DbSystemPlacement

The availability domain and fault domain a DB System is placed in.

DbSystemSnapshot

Snapshot of the DbSystem details at the time of the backup

DbSystemSnapshotSummary

A summary of snapshot of the DB system details at the time of the backup.

DbSystemSource

Parameters detailing how to provision the initial data of the DB System.

DbSystemSourceFromBackup

From which backup this DB System was created.

DbSystemSourceFromNone

A DB System created from no particular external source.

DbSystemSourceFromPitr

DB System OCID to perform a point in time recovery to the current point in time.
DB System OCID and recovery point to perform a point in time recovery to the specified recovery point.

DbSystemSourceImportFromUrl

An Object Storage PAR from which to import the DB System initial data.

DbSystemSourceModelConverter

DbSystemSummary

A summary of a DB System.

DeletionPolicyDetails

The Deletion policy for the DB System.

ErrorOnAnonymousHandling

Disables assignment of IDs to anonymous transactions coming from the source. Use this policy when the transaction identifiers are enabled in the source of the replication channel.

HeatWaveCluster

A HeatWave cluster is a database accelerator for a DB System.

HeatWaveClusterMemoryEstimate

HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size. For each MySQL user table the estimated memory footprint when the table is loaded to the HeatWave cluster memory is returned.

HeatWaveClusterSchemaMemoryEstimate

Schema with estimated memory footprints for each MySQL user table of the schema when loaded to HeatWave cluster memory.

HeatWaveClusterSummary

A summary of a HeatWave cluster.

HeatWaveClusterTableMemoryEstimate

Estimated memory footprint for a MySQL user table when loaded to the HeatWave cluster memory.

HeatWaveNode

A HeatWave node is a compute host that is part of a HeatWave cluster.

InitializationVariables

User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.

MaintenanceDetails

The Maintenance Policy for the DB System or Read Replica that this model is included in.

PemCaCertificate

The CA certificate in PEM format.

PitrPolicy

The PITR policy for the DB System.

PointInTimeRecoveryDetails

Point-in-time Recovery details like earliest and latest recovery time point for the DB System.

ReadEndpointDetails

The read endpoint of a DB System.

Replica

A DB System read replica.

ReplicaOverrides

By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.

ReplicaSummary

Summary of the read replica.

RestDetails

REST configuration details.

RestartDbSystemDetails

DB System restart parameters.

SecureConnectionDetails

Secure connection configuration details.

ShapeSummary

The shape of the DB System. The shape determines resources to allocate to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For a description of shapes, see DB System Shape Options.

StopDbSystemDetails

DB System shutdown parameters.

UpdateBackupDetails

The Backup metadata which can be updated.

UpdateBackupPolicyDetails

Backup Policy as optionally used for DB System update.

UpdateChannelDetails

Details required to update a Channel

UpdateChannelSourceDetails

Parameters detailing how to provision the source for the given Channel.

UpdateChannelSourceDetailsModelConverter

UpdateChannelSourceFromMysqlDetails

Parameters detailing how to provision the source endpoint that is a MySQL Server. Typically a MySQL Server that is not managed by the MySQL Database Service.

UpdateChannelTargetDetails

Parameters detailing how to provision the target for the given Channel.

UpdateChannelTargetDetailsModelConverter

UpdateChannelTargetFromDbSystemDetails

Parameters detailing how to provision the target endpoint that is a DB System.

UpdateConfigurationDetails

The details required to update a Configuration.

UpdateDbSystemDetails

Details required to update a DB System.

UpdateDeletionPolicyDetails

Policy for how the DB System and related resources should be handled at the time of its deletion.

UpdateHeatWaveClusterDetails

Details about the HeatWave cluster properties to be updated.

UpdateMaintenanceDetails

The Maintenance Policy for the DB System or Read Replica that this model is included in.

UpdateReadEndpointDetails

Read Endpoint details.

UpdateReplicaDetails

Details required to update a read replica.

UpdateRestDetails

Details required to configure REST while updating a DB System.

Version

A supported MySQL Version.

VersionSummary

A summary of the supported MySQL Versions families, and a list of their supported minor versions.

WorkRequest

The status of an asynchronous task in the system.

WorkRequestError

An error encountered while executing a work request.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

The status of an asynchronous task in the system.

Enums

AnonymousTransactionsHandling.PolicyEnum

Backup.BackupTypeEnum

Backup.CreationTypeEnum

Backup.LifecycleStateEnum

CaCertificate.CertificateTypeEnum

CertificateGenerationType

Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).

Channel.LifecycleStateEnum

ChannelFilter.TypeEnum

ChannelSource.SourceTypeEnum

ChannelSourceMysql.SslModeEnum

ChannelTarget.TargetTypeEnum

ChannelTargetDbSystem.TablesWithoutPrimaryKeyHandlingEnum

Configuration.LifecycleStateEnum

Configuration.TypeEnum

ConfigurationVariables.BinlogRowMetadataEnum

ConfigurationVariables.CharacterSetServerEnum

ConfigurationVariables.CollationServerEnum

ConfigurationVariables.CompletionTypeEnum

ConfigurationVariables.DefaultAuthenticationPluginEnum

ConfigurationVariables.ExplainFormatEnum

ConfigurationVariables.GroupReplicationConsistencyEnum

ConfigurationVariables.InnodbChangeBufferingEnum

ConfigurationVariables.TransactionIsolationEnum

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.

CreateBackupDetails.BackupTypeEnum

CreateDbSystemSourceDetails.SourceTypeEnum

CreateDeletionPolicyDetails.AutomaticBackupRetentionEnum

CreateDeletionPolicyDetails.FinalBackupEnum

DatabaseManagementStatus

Whether to enable monitoring via the Database Management service.

DbSystem.AccessModeEnum

DbSystem.DatabaseModeEnum

DbSystem.LifecycleStateEnum

DbSystemEndpoint.ModesEnum

DbSystemEndpoint.ResourceTypeEnum

DbSystemEndpoint.StatusEnum

DbSystemSource.SourceTypeEnum

DeletionPolicyDetails.AutomaticBackupRetentionEnum

DeletionPolicyDetails.FinalBackupEnum

HeatWaveCluster.LifecycleStateEnum

HeatWaveClusterMemoryEstimateStatus

Possible operation status.

HeatWaveNode.LifecycleStateEnum

InitializationVariables.LowerCaseTableNamesEnum

InnoDbShutdownMode

The InnoDB shutdown mode. If the value is "SLOW", InnoDB does a slow shutdown, a full purge and a change buffer merge before shutting down. If the value is "FAST", InnoDB skips these operations at shutdown, a process known as a fast shutdown. If the value is "IMMEDIATE", InnoDB flushes its logs and shuts down cold, as if MySQL had crashed; no committed transactions are lost, but the crash recovery operation makes the next startup take longer.
The slow shutdown can take minutes, or even hours in extreme cases where substantial amounts of data are still buffered. Use the slow shutdown technique before upgrading or downgrading between MySQL major releases, so that all data files are fully prepared in case the upgrade process updates the file format.

Replica.LifecycleStateEnum

ReplicaSummary.LifecycleStateEnum

RestConfigurationType

Select how REST is configured across the DB System instances.

ShapeSummary.IsSupportedForEnum

SoftDelete

Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.
If soft delete is enabled, then it retains the backup in DELETE SCHEDULED state for 7 days before permanently deleting it.
If soft delete is disabled, then it permanently deletes the backup immediately.

UpdateDeletionPolicyDetails.AutomaticBackupRetentionEnum

UpdateDeletionPolicyDetails.FinalBackupEnum

WorkRequestOperationStatus

Possible operation status.

WorkRequestOperationType

Possible operation types.

WorkRequestResourceActionType

Possible action types.

In this article
Back to top