Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DbManagementClient

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

  • DbManagementClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://dbmgmt.{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

addDataFiles

addManagedDatabaseToManagedDatabaseGroup

addmTasks

  • Lists the metadata for each ADDM task who's end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddmTasks API.

    Parameters

    Returns Promise<AddmTasksResponse>

    AddmTasksResponse

changeDatabaseParameters

  • Changes database parameter values. There are two kinds of database parameters:

    - Dynamic parameters: They can be changed for the current Oracle Database instance. The changes take effect immediately. - Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect.

    *Note:** If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDatabaseParameters API.

    Parameters

    Returns Promise<ChangeDatabaseParametersResponse>

    ChangeDatabaseParametersResponse

changeDbManagementPrivateEndpointCompartment

changeExternalDbSystemCompartment

changeExternalExadataInfrastructureCompartment

changeJobCompartment

changeManagedDatabaseGroupCompartment

changeNamedCredentialCompartment

changePlanRetention

  • Changes the retention period of unused plans. The period can range between 5 and 523 weeks.

    The database purges plans that have not been used for longer than the plan retention period.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangePlanRetention API.

    Parameters

    Returns Promise<ChangePlanRetentionResponse>

    ChangePlanRetentionResponse

changeSpaceBudget

  • Changes the disk space limit for the SQL Management Base. The allowable range for this limit is between 1% and 50%.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeSpaceBudget API.

    Parameters

    Returns Promise<ChangeSpaceBudgetResponse>

    ChangeSpaceBudgetResponse

changeSqlPlanBaselinesAttributes

checkExternalDbSystemConnectorConnectionStatus

checkExternalExadataStorageConnector

close

  • close(): void

configureAutomaticCaptureFilters

configureAutomaticSpmEvolveAdvisorTask

createDbManagementPrivateEndpoint

createExternalDbSystem

createExternalDbSystemConnector

createExternalDbSystemDiscovery

createExternalExadataInfrastructure

  • Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure. The following resource/subresources are created: Infrastructure Storage server connectors Storage servers Storage grids

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

    Parameters

    Returns Promise<CreateExternalExadataInfrastructureResponse>

    CreateExternalExadataInfrastructureResponse

createExternalExadataStorageConnector

createJob

  • Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateJob API.

    Parameters

    Returns Promise<CreateJobResponse>

    CreateJobResponse

createManagedDatabaseGroup

createNamedCredential

createTablespace

createWaiters

deleteDbManagementPrivateEndpoint

deleteExternalDbSystem

deleteExternalDbSystemConnector

deleteExternalDbSystemDiscovery

deleteExternalExadataInfrastructure

deleteExternalExadataStorageConnector

deleteJob

deleteManagedDatabaseGroup

deleteNamedCredential

deletePreferredCredential

disableAutomaticInitialPlanCapture

disableAutomaticSpmEvolveAdvisorTask

disableDatabaseManagementFeature

disableExternalContainerDatabaseManagementFeature

disableExternalDbSystemDatabaseManagement

disableExternalDbSystemStackMonitoring

disableExternalExadataInfrastructureManagement

  • Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

    - Exadata infrastructure - Exadata storage grid - Exadata storage server

    Note that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.

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

    Parameters

    Returns Promise<DisableExternalExadataInfrastructureManagementResponse>

    DisableExternalExadataInfrastructureManagementResponse

disableExternalNonContainerDatabaseManagementFeature

disableExternalPluggableDatabaseManagementFeature

disableHighFrequencyAutomaticSpmEvolveAdvisorTask

disablePluggableDatabaseManagementFeature

disableSqlPlanBaselinesUsage

discoverExternalExadataInfrastructure

  • Completes the Exadata system prechecking on the following:

    - Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code. - Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code. - Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with INVALID_AGENT error code. - Verifies if it is an Exadata system or return 400 status code with INVALID_EXADATA_SYSTEM error code.

    Starts the discovery process for the Exadata system infrastructure. The following resources/components are discovered

    - Exadata storage servers from each DB systems - Exadata storage grid for all Exadata storage servers - Exadata infrastructure

    The same API covers both new discovery and rediscovery cases. For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden. For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones should be removed based on the unique key defined for each resource/sub-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 DiscoverExternalExadataInfrastructure API.

    Parameters

    Returns Promise<DiscoverExternalExadataInfrastructureResponse>

    DiscoverExternalExadataInfrastructureResponse

dropSqlPlanBaselines

dropTablespace

  • Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DropTablespace API.

    Parameters

    Returns Promise<DropTablespaceResponse>

    DropTablespaceResponse

enableAutomaticInitialPlanCapture

  • Enables automatic initial plan capture. When enabled, the database checks whether executed SQL statements are eligible for automatic capture. It creates initial plan baselines for eligible statements.

    By default, the database creates a SQL plan baseline for every eligible repeatable statement, including all recursive SQL and monitoring SQL. Thus, automatic capture may result in the creation of an extremely large number of plan baselines. To limit the statements that are eligible for plan baselines, configure filters.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableAutomaticInitialPlanCapture API.

    Parameters

    Returns Promise<EnableAutomaticInitialPlanCaptureResponse>

    EnableAutomaticInitialPlanCaptureResponse

enableAutomaticSpmEvolveAdvisorTask

  • Enables the Automatic SPM Evolve Advisor task. By default, the automatic task SYS_AUTO_SPM_EVOLVE_TASK runs every day in the scheduled maintenance window.

    The SPM Evolve Advisor performs the following tasks:

    - Checks AWR for top SQL - Looks for alternative plans in all available sources - Adds unaccepted plans to the plan history - Tests the execution of as many plans as possible during the maintenance window - Adds the alternative plan to the baseline if it performs better than the current plan

    One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableAutomaticSpmEvolveAdvisorTask API.

    Parameters

    Returns Promise<EnableAutomaticSpmEvolveAdvisorTaskResponse>

    EnableAutomaticSpmEvolveAdvisorTaskResponse

enableDatabaseManagementFeature

enableExternalContainerDatabaseManagementFeature

enableExternalDbSystemDatabaseManagement

enableExternalDbSystemStackMonitoring

enableExternalExadataInfrastructureManagement

  • Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

    - Exadata infrastructure - Exadata storage grid - Exadata storage server

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

    Parameters

    Returns Promise<EnableExternalExadataInfrastructureManagementResponse>

    EnableExternalExadataInfrastructureManagementResponse

enableExternalNonContainerDatabaseManagementFeature

enableExternalPluggableDatabaseManagementFeature

enableHighFrequencyAutomaticSpmEvolveAdvisorTask

  • Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency task runs every hour and runs for no longer than 30 minutes. These settings are not configurable.

    The high-frequency task complements the standard Automatic SPM Evolve Advisor task. They are independent and are scheduled through two different frameworks.

    It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableHighFrequencyAutomaticSpmEvolveAdvisorTask API.

    Parameters

    Returns Promise<EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskResponse>

    EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskResponse

enablePluggableDatabaseManagementFeature

enableSqlPlanBaselinesUsage

  • Enables the use of SQL plan baselines stored in SQL Management Base.

    When enabled, the optimizer uses SQL plan baselines to select plans to avoid potential performance regressions.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableSqlPlanBaselinesUsage API.

    Parameters

    Returns Promise<EnableSqlPlanBaselinesUsageResponse>

    EnableSqlPlanBaselinesUsageResponse

generateAwrSnapshot

getAwrDbReport

getAwrDbSqlReport

getClusterCacheMetric

  • Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetClusterCacheMetric API.

    Parameters

    Returns Promise<GetClusterCacheMetricResponse>

    GetClusterCacheMetricResponse

getDatabaseFleetHealthMetrics

  • Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDatabaseFleetHealthMetrics API.

    Parameters

    Returns Promise<GetDatabaseFleetHealthMetricsResponse>

    GetDatabaseFleetHealthMetricsResponse

getDatabaseHomeMetrics

  • Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDatabaseHomeMetrics API.

    Parameters

    Returns Promise<GetDatabaseHomeMetricsResponse>

    GetDatabaseHomeMetricsResponse

getDbManagementPrivateEndpoint

getExternalAsm

  • Gets the details for the external ASM specified by externalAsmId.

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

    Parameters

    Returns Promise<GetExternalAsmResponse>

    GetExternalAsmResponse

getExternalAsmConfiguration

getExternalAsmInstance

getExternalCluster

getExternalClusterInstance

getExternalDbHome

  • Gets the details for the external DB home specified by externalDbHomeId.

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

    Parameters

    Returns Promise<GetExternalDbHomeResponse>

    GetExternalDbHomeResponse

getExternalDbNode

  • Gets the details for the external DB node specified by externalDbNodeId.

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

    Parameters

    Returns Promise<GetExternalDbNodeResponse>

    GetExternalDbNodeResponse

getExternalDbSystem

getExternalDbSystemConnector

getExternalDbSystemDiscovery

getExternalExadataInfrastructure

  • Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the Exadata infrastructure.

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

    Parameters

    Returns Promise<GetExternalExadataInfrastructureResponse>

    GetExternalExadataInfrastructureResponse

getExternalExadataStorageConnector

getExternalExadataStorageGrid

getExternalExadataStorageServer

getExternalListener

getIormPlan

  • Get the IORM plan from the specific Exadata storage server.

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

    Parameters

    Returns Promise<GetIormPlanResponse>

    GetIormPlanResponse

getJob

getJobExecution

getJobRun

getManagedDatabase

getManagedDatabaseGroup

getNamedCredential

getOpenAlertHistory

getOptimizerStatisticsAdvisorExecution

getOptimizerStatisticsAdvisorExecutionScript

getOptimizerStatisticsCollectionOperation

getPdbMetrics

  • Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPdbMetrics API.

    Parameters

    Returns Promise<GetPdbMetricsResponse>

    GetPdbMetricsResponse

getPreferredCredential

getSqlPlanBaseline

getSqlPlanBaselineConfiguration

  • Gets the configuration details of SQL plan baselines for the specified Managed Database. The details include the settings for the capture and use of SQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.

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

    Parameters

    Returns Promise<GetSqlPlanBaselineConfigurationResponse>

    GetSqlPlanBaselineConfigurationResponse

getTablespace

  • Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTablespace API.

    Parameters

    Returns Promise<GetTablespaceResponse>

    GetTablespaceResponse

getTopSqlCpuActivity

getUser

  • Gets the details of the user specified by managedDatabaseId and userName.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUser API.

    Parameters

    Returns Promise<GetUserResponse>

    GetUserResponse

getWaiters

getWorkRequest

implementOptimizerStatisticsAdvisorRecommendations

listAsmProperties

listAssociatedDatabases

listAwrDbSnapshots

listAwrDbs

  • Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrDbs API.

    Parameters

    Returns Promise<ListAwrDbsResponse>

    ListAwrDbsResponse

listConsumerGroupPrivileges

listCursorCacheStatements

listDataAccessContainers

listDatabaseParameters

  • Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseParameters API.

    Parameters

    Returns Promise<ListDatabaseParametersResponse>

    ListDatabaseParametersResponse

listDbManagementPrivateEndpoints

listExternalAsmDiskGroups

listExternalAsmInstances

listExternalAsmUsers

listExternalAsms

listExternalClusterInstances

listExternalClusters

listExternalDatabases

listExternalDbHomes

listExternalDbNodes

listExternalDbSystemConnectors

listExternalDbSystemDiscoveries

listExternalDbSystems

listExternalExadataInfrastructures

listExternalExadataStorageConnectors

listExternalExadataStorageServers

listExternalListenerServices

listExternalListeners

listJobExecutions

  • Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobExecutions API.

    Parameters

    Returns Promise<ListJobExecutionsResponse>

    ListJobExecutionsResponse

listJobRuns

  • Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobRuns API.

    Parameters

    Returns Promise<ListJobRunsResponse>

    ListJobRunsResponse

listJobs

  • Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobs API.

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listManagedDatabaseGroups

  • Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListManagedDatabaseGroups API.

    Parameters

    Returns Promise<ListManagedDatabaseGroupsResponse>

    ListManagedDatabaseGroupsResponse

listManagedDatabases

  • Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment are listed. Managed Databases can also be filtered based on the deployment type and management option. If the deployment type is not specified or if it is ONPREMISE, then the management option is not considered and Managed Databases with ADVANCED management option are listed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListManagedDatabases API.

    Parameters

    Returns Promise<ListManagedDatabasesResponse>

    ListManagedDatabasesResponse

listNamedCredentials

listObjectPrivileges

listOptimizerStatisticsAdvisorExecutions

  • Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any. Optionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range. If the date-time range is not specified, then the executions in the last seven days are listed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOptimizerStatisticsAdvisorExecutions API.

    Parameters

    Returns Promise<ListOptimizerStatisticsAdvisorExecutionsResponse>

    ListOptimizerStatisticsAdvisorExecutionsResponse

listOptimizerStatisticsCollectionAggregations

  • Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database. You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status. Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. You can further filter the results by providing the optional type of TaskTypeQueryParam. If the task type not provided, then both Auto and Manual tasks are considered for aggregation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOptimizerStatisticsCollectionAggregations API.

    Parameters

    Returns Promise<ListOptimizerStatisticsCollectionAggregationsResponse>

    ListOptimizerStatisticsCollectionAggregationsResponse

listOptimizerStatisticsCollectionOperations

  • Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database. The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on. Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page. If you use the same header value in a consecutive request, the next page records are returned. To obtain the required results, you can apply the different types of filters supported by this API.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOptimizerStatisticsCollectionOperations API.

    Parameters

    Returns Promise<ListOptimizerStatisticsCollectionOperationsResponse>

    ListOptimizerStatisticsCollectionOperationsResponse

listPreferredCredentials

listProxiedForUsers

listProxyUsers

listRoles

listSqlPlanBaselineJobs

listSqlPlanBaselines

listSystemPrivileges

listTableStatistics

  • Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats. This also includes the percentage of each status.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTableStatistics API.

    Parameters

    Returns Promise<ListTableStatisticsResponse>

    ListTableStatisticsResponse

listTablespaces

listUsers

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

loadSqlPlanBaselinesFromAwr

  • Loads plans from Automatic Workload Repository (AWR) snapshots. You must specify the beginning and ending of the snapshot range. Optionally, you can apply a filter to load only plans that meet specified criteria. By default, the optimizer uses the loaded plans the next time that the database executes the SQL statements.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LoadSqlPlanBaselinesFromAwr API.

    Parameters

    Returns Promise<LoadSqlPlanBaselinesFromAwrResponse>

    LoadSqlPlanBaselinesFromAwrResponse

loadSqlPlanBaselinesFromCursorCache

  • Loads plans for statements directly from the shared SQL area, also called the cursor cache. By applying a filter on the module name, the schema, or the SQL ID you identify the SQL statement or set of SQL statements to load.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LoadSqlPlanBaselinesFromCursorCache API.

    Parameters

    Returns Promise<LoadSqlPlanBaselinesFromCursorCacheResponse>

    LoadSqlPlanBaselinesFromCursorCacheResponse

modifyDatabaseManagementFeature

modifyPluggableDatabaseManagementFeature

patchExternalDbSystemDiscovery

removeDataFile

removeManagedDatabaseFromManagedDatabaseGroup

  • Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveManagedDatabaseFromManagedDatabaseGroup API.

    Parameters

    Returns Promise<RemoveManagedDatabaseFromManagedDatabaseGroupResponse>

    RemoveManagedDatabaseFromManagedDatabaseGroupResponse

resetDatabaseParameters

resizeDataFile

runHistoricAddm

  • Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RunHistoricAddm API.

    Parameters

    Returns Promise<RunHistoricAddmResponse>

    RunHistoricAddmResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

summarizeAwrDbCpuUsages

summarizeAwrDbMetrics

  • Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDbMetrics API.

    Parameters

    Returns Promise<SummarizeAwrDbMetricsResponse>

    SummarizeAwrDbMetricsResponse

summarizeAwrDbParameterChanges

  • Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDbParameterChanges API.

    Parameters

    Returns Promise<SummarizeAwrDbParameterChangesResponse>

    SummarizeAwrDbParameterChangesResponse

summarizeAwrDbParameters

  • Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:

    - Each parameter whose value was changed during the time range: (valueChanged =\"Y\") - Each parameter whose value was unchanged during the time range: (valueChanged =\"N\") - Each parameter whose value was changed at the system level during the time range: (valueChanged =\"Y\" and valueModified = \"SYSTEM_MOD\") - Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged =\"N\" and valueDefault = \"FALSE\")

    Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDbParameters API.

    Parameters

    Returns Promise<SummarizeAwrDbParametersResponse>

    SummarizeAwrDbParametersResponse

summarizeAwrDbSnapshotRanges

summarizeAwrDbSysstats

  • Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDbSysstats API.

    Parameters

    Returns Promise<SummarizeAwrDbSysstatsResponse>

    SummarizeAwrDbSysstatsResponse

summarizeAwrDbTopWaitEvents

summarizeAwrDbWaitEventBuckets

summarizeAwrDbWaitEvents

  • Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDbWaitEvents API.

    Parameters

    Returns Promise<SummarizeAwrDbWaitEventsResponse>

    SummarizeAwrDbWaitEventsResponse

summarizeExternalAsmMetrics

summarizeExternalClusterMetrics

summarizeExternalDbNodeMetrics

summarizeExternalDbSystemAvailabilityMetrics

summarizeExternalListenerMetrics

summarizeJobExecutionsStatuses

  • Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeJobExecutionsStatuses API.

    Parameters

    Returns Promise<SummarizeJobExecutionsStatusesResponse>

    SummarizeJobExecutionsStatusesResponse

summarizeManagedDatabaseAvailabilityMetrics

summarizeSqlPlanBaselines

summarizeSqlPlanBaselinesByLastExecution

testNamedCredential

testPreferredCredential

updateDbManagementPrivateEndpoint

updateExternalAsm

updateExternalAsmInstance

updateExternalCluster

updateExternalClusterInstance

updateExternalDbHome

updateExternalDbNode

updateExternalDbSystem

updateExternalDbSystemConnector

updateExternalDbSystemDiscovery

updateExternalExadataInfrastructure

updateExternalExadataStorageConnector

updateExternalExadataStorageGrid

updateExternalExadataStorageServer

updateExternalListener

updateJob

  • Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateJob API.

    Parameters

    Returns Promise<UpdateJobResponse>

    UpdateJobResponse

updateManagedDatabase

updateManagedDatabaseGroup

updateNamedCredential

updatePreferredCredential

updateTablespace

  • Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTablespace API.

    Parameters

    Returns Promise<UpdateTablespaceResponse>

    UpdateTablespaceResponse