Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SqlTuningClient

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

  • SqlTuningClient

Constructors

constructor

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

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

targetService

targetService: string = "SqlTuning"

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

cloneSqlTuningTask

close

  • close(): void

createSqlTuningSet

  • Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.

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

    Parameters

    Returns Promise<CreateSqlTuningSetResponse>

    CreateSqlTuningSetResponse

dropSqlTuningSet

  • Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.

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

    Parameters

    Returns Promise<DropSqlTuningSetResponse>

    DropSqlTuningSetResponse

dropSqlTuningTask

dropSqlsInSqlTuningSet

  • Deletes the Sqls in the specified Sql tuning set that matches the filter criteria provided in the basicFilter. If basicFilter criteria is not provided, then entire Sqls in the Sql tuning set is deleted.

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

    Parameters

    Returns Promise<DropSqlsInSqlTuningSetResponse>

    DropSqlsInSqlTuningSetResponse

fetchSqlTuningSet

  • Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters.

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

    Parameters

    Returns Promise<FetchSqlTuningSetResponse>

    FetchSqlTuningSetResponse

getExecutionPlanStatsComparision

  • Retrieves a comparison of the existing SQL execution plan and a new plan. A SQL tuning task may suggest a new execution plan for a SQL, and this API retrieves the comparison report of the statistics of the two plans.

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

    Parameters

    Returns Promise<GetExecutionPlanStatsComparisionResponse>

    GetExecutionPlanStatsComparisionResponse

getSqlExecutionPlan

getSqlTuningAdvisorTaskSummaryReport

listSqlTuningAdvisorTaskFindings

listSqlTuningAdvisorTaskRecommendations

listSqlTuningAdvisorTasks

listSqlTuningSets

loadSqlTuningSet

  • Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId.

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

    Parameters

    Returns Promise<LoadSqlTuningSetResponse>

    LoadSqlTuningSetResponse

saveSqlTuningSetAs

  • Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set'.

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

    Parameters

    Returns Promise<SaveSqlTuningSetAsResponse>

    SaveSqlTuningSetAsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startSqlTuningTask

validateBasicFilter

  • Executes a SQL query to check whether user entered basic filter criteria is valid or not.

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

    Parameters

    Returns Promise<ValidateBasicFilterResponse>

    ValidateBasicFilterResponse