Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DbSystemClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DbSystemClient

Constructors

constructor

  • new DbSystemClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DbSystemClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DbSystemWaiter

targetService

targetService: string = "DbSystem"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://mysql.{region}.ocp.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

addHeatWaveCluster

  • Adds a HeatWave cluster to the DB System.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddHeatWaveCluster API.

    Parameters

    Returns Promise<AddHeatWaveClusterResponse>

    AddHeatWaveClusterResponse

close

  • close(): void

createDbSystem

  • Creates and launches a DB System.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDbSystem API.

    Parameters

    Returns Promise<CreateDbSystemResponse>

    CreateDbSystemResponse

createWaiters

  • Creates a new DbSystemWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DbSystemWaiter

    The service waiters.

deleteDbSystem

  • Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDbSystem API.

    Parameters

    Returns Promise<DeleteDbSystemResponse>

    DeleteDbSystemResponse

deleteHeatWaveCluster

  • Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteHeatWaveCluster API.

    Parameters

    Returns Promise<DeleteHeatWaveClusterResponse>

    DeleteHeatWaveClusterResponse

generateHeatWaveClusterMemoryEstimate

getDbSystem

  • Get information about the specified DB System. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDbSystem API.

    Parameters

    Returns Promise<GetDbSystemResponse>

    GetDbSystemResponse

getHeatWaveCluster

  • Gets information about the HeatWave cluster. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHeatWaveCluster API.

    Parameters

    Returns Promise<GetHeatWaveClusterResponse>

    GetHeatWaveClusterResponse

getHeatWaveClusterMemoryEstimate

  • Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHeatWaveClusterMemoryEstimate API.

    Parameters

    Returns Promise<GetHeatWaveClusterMemoryEstimateResponse>

    GetHeatWaveClusterMemoryEstimateResponse

getWaiters

listAllDbSystems

  • NOTE: This function is deprecated in favor of listDbSystemsRecordIterator function. Creates a new async iterator which will iterate over the models.DbSystemSummary objects contained in responses from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemSummary>

listAllDbSystemsResponses

  • NOTE: This function is deprecated in favor of listDbSystemsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbSystemsResponse>

listDbSystems

  • Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbSystems API.

    Parameters

    Returns Promise<ListDbSystemsResponse>

    ListDbSystemsResponse

listDbSystemsRecordIterator

  • Creates a new async iterator which will iterate over the models.DbSystemSummary objects contained in responses from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemSummary>

listDbSystemsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbSystemsResponse>

restartDbSystem

  • Restarts the specified DB System. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RestartDbSystem API.

    Parameters

    Returns Promise<RestartDbSystemResponse>

    RestartDbSystemResponse

restartHeatWaveCluster

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startDbSystem

  • Start the specified DB System. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StartDbSystem API.

    Parameters

    Returns Promise<StartDbSystemResponse>

    StartDbSystemResponse

startHeatWaveCluster

stopDbSystem

  • Stops the specified DB System.

    A stopped DB System is not billed.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopDbSystem API.

    Parameters

    Returns Promise<StopDbSystemResponse>

    StopDbSystemResponse

stopHeatWaveCluster

  • Stops the HeatWave cluster. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopHeatWaveCluster API.

    Parameters

    Returns Promise<StopHeatWaveClusterResponse>

    StopHeatWaveClusterResponse

updateDbSystem

  • Update the configuration of a DB System.

    Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDbSystem API.

    Parameters

    Returns Promise<UpdateDbSystemResponse>

    UpdateDbSystemResponse

updateHeatWaveCluster