Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PostgresqlClient

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

  • PostgresqlClient

Constructors

constructor

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

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 = "Postgresql"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://postgresql.{region}.oci.{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

changeBackupCompartment

  • Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource. 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 ChangeBackupCompartment API.

    Parameters

    Returns Promise<ChangeBackupCompartmentResponse>

    ChangeBackupCompartmentResponse

changeConfigurationCompartment

  • Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource. 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 ChangeConfigurationCompartment API.

    Parameters

    Returns Promise<ChangeConfigurationCompartmentResponse>

    ChangeConfigurationCompartmentResponse

changeDbSystemCompartment

  • Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource. 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 ChangeDbSystemCompartment API.

    Parameters

    Returns Promise<ChangeDbSystemCompartmentResponse>

    ChangeDbSystemCompartmentResponse

close

  • close(): void

createBackup

  • Creates a new backup.

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

    Parameters

    Returns Promise<CreateBackupResponse>

    CreateBackupResponse

createConfiguration

  • Creates a new configuration.

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

    Parameters

    Returns Promise<CreateConfigurationResponse>

    CreateConfigurationResponse

createDbSystem

  • Creates a new database 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 PostgresqlWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns PostgresqlWaiter

    The service waiters.

deleteBackup

  • Deletes a backup by identifier. 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 DeleteBackup API.

    Parameters

    Returns Promise<DeleteBackupResponse>

    DeleteBackupResponse

deleteConfiguration

  • Deletes a configuration by identifier. 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 DeleteConfiguration API.

    Parameters

    Returns Promise<DeleteConfigurationResponse>

    DeleteConfigurationResponse

deleteDbSystem

  • Deletes a database system by identifier. 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

failoverDbSystem

  • Runs a failover operation. Optionally, specify the desired AD for regions with three ADs. 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 FailoverDbSystem API.

    Parameters

    Returns Promise<FailoverDbSystemResponse>

    FailoverDbSystemResponse

getBackup

  • Gets a backup by identifier. 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 GetBackup API.

    Parameters

    Returns Promise<GetBackupResponse>

    GetBackupResponse

getConfiguration

  • Gets a configuration by identifier. 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 GetConfiguration API.

    Parameters

    Returns Promise<GetConfigurationResponse>

    GetConfigurationResponse

getConnectionDetails

  • Gets the database system connection details. 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 GetConnectionDetails API.

    Parameters

    Returns Promise<GetConnectionDetailsResponse>

    GetConnectionDetailsResponse

getDbSystem

  • Gets a database system by identifier. 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

getDefaultConfiguration

  • Gets a default configuration by identifier. 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 GetDefaultConfiguration API.

    Parameters

    Returns Promise<GetDefaultConfigurationResponse>

    GetDefaultConfigurationResponse

getPrimaryDbInstance

  • Gets the primary database instance node details. 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 GetPrimaryDbInstance API.

    Parameters

    Returns Promise<GetPrimaryDbInstanceResponse>

    GetPrimaryDbInstanceResponse

getWaiters

getWorkRequest

  • Gets details of the work request with the given ID. 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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listBackups

  • Returns a list of backups.

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

    Parameters

    Returns Promise<ListBackupsResponse>

    ListBackupsResponse

listConfigurations

  • Returns a list of configurations.

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

    Parameters

    Returns Promise<ListConfigurationsResponse>

    ListConfigurationsResponse

listDbSystems

  • Returns a list of database systems.

    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

listDefaultConfigurations

listShapes

  • Returns the list of shapes allowed in the region. 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 ListShapes API.

    Parameters

    Returns Promise<ListShapesResponse>

    ListShapesResponse

listWorkRequestErrors

  • Returns a (paginated) list of errors for the work request with the given ID.

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

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Returns a (paginated) list of logs for the work request with the given ID.

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

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

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

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

patchDbSystem

  • Modifies the database system by adding or removing database instance nodes. 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 PatchDbSystem API.

    Parameters

    Returns Promise<PatchDbSystemResponse>

    PatchDbSystemResponse

resetMasterUserPassword

  • Resets the database system's master password. 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 ResetMasterUserPassword API.

    Parameters

    Returns Promise<ResetMasterUserPasswordResponse>

    ResetMasterUserPasswordResponse

restartDbInstanceInDbSystem

restoreDbSystem

  • Restore the database 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 RestoreDbSystem API.

    Parameters

    Returns Promise<RestoreDbSystemResponse>

    RestoreDbSystemResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateBackup

  • Updates the backup. 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 UpdateBackup API.

    Parameters

    Returns Promise<UpdateBackupResponse>

    UpdateBackupResponse

updateConfiguration

  • Updates a display name or description of the configuration.

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

    Parameters

    Returns Promise<UpdateConfigurationResponse>

    UpdateConfigurationResponse

updateDbSystem

  • Updates the database 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 UpdateDbSystem API.

    Parameters

    Returns Promise<UpdateDbSystemResponse>

    UpdateDbSystemResponse

updateDbSystemDbInstance