Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShardedDatabaseServiceClient

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

  • ShardedDatabaseServiceClient

Constructors

constructor

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

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

targetService

targetService: string = "ShardedDatabaseService"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://globaldb.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

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

logger

region

  • set region(region: Region): 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

changePrivateEndpointCompartment

changeShardedDatabaseCompartment

close

  • close(): void

configureShardedDatabaseGsms

  • Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database. Specify the names of old GSM instances that need to be replaced via parameter oldGsmNames in the request payload. Also specify whether rotated GSM instances shall be provisioned with latest image of GSM software or the image used by existing GSM instances shall be used.

    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 ConfigureShardedDatabaseGsms API.

    Parameters

    Returns Promise<ConfigureShardedDatabaseGsmsResponse>

    ConfigureShardedDatabaseGsmsResponse

configureSharding

  • Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database. Note that this 'ConfigureSharding' API also needs to be invoked after successfully adding a new shard to the sharded database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the sharded database.

    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 ConfigureSharding API.

    Parameters

    Returns Promise<ConfigureShardingResponse>

    ConfigureShardingResponse

createPrivateEndpoint

createShardedDatabase

createWaiters

deletePrivateEndpoint

deleteShardedDatabase

downloadGsmCertificateSigningRequest

  • Generate the common certificate signing request for GSMs. Download the .csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use 'uploadSignedCertificateAndGenerateWallet' API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the sharded database.

    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 DownloadGsmCertificateSigningRequest API.

    Parameters

    Returns Promise<DownloadGsmCertificateSigningRequestResponse>

    DownloadGsmCertificateSigningRequestResponse

fetchConnectionString

fetchShardableCloudAutonomousVmClusters

generateGsmCertificateSigningRequest

  • Generate the certificate signing request for GSM instances of the sharded database. Once certificate signing request is generated, then customers can download the certificate signing request using 'downloadGsmCertificateSigningRequest' api call.

    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 GenerateGsmCertificateSigningRequest API.

    Parameters

    Returns Promise<GenerateGsmCertificateSigningRequestResponse>

    GenerateGsmCertificateSigningRequestResponse

generateWallet

getPrivateEndpoint

getShardedDatabase

getWaiters

getWorkRequest

listPrivateEndpoints

listShardedDatabases

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

patchShardedDatabase

  • Patch operation to add, remove or update shards to the sharded database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.

    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 PatchShardedDatabase API.

    Parameters

    Returns Promise<PatchShardedDatabaseResponse>

    PatchShardedDatabaseResponse

prevalidateShardedDatabase

reinstateProxyInstance

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startShardedDatabase

stopShardedDatabase

updatePrivateEndpoint

updateShardedDatabase

uploadSignedCertificateAndGenerateWallet

  • Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database. Customer shall provide the CA signed certificate key details by adding the certificate in request body.

    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 UploadSignedCertificateAndGenerateWallet API.

    Parameters

    Returns Promise<UploadSignedCertificateAndGenerateWalletResponse>

    UploadSignedCertificateAndGenerateWalletResponse

validateNetwork