Class SqlTuningClient
Service client instance for SqlTuning.
Implements
Inherited Members
Namespace: Oci.DatabasemanagementService
Assembly: OCI.DotNetSDK.Databasemanagement.dll
Syntax
public class SqlTuningClient : RegionalClientBase, IDisposable
Constructors
SqlTuningClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public SqlTuningClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public SqlTuningPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
SqlTuningPaginators |
Methods
CloneSqlTuningTask(CloneSqlTuningTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Clones and runs a SQL tuning task in the database.
Declaration
public Task<CloneSqlTuningTaskResponse> CloneSqlTuningTask(CloneSqlTuningTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CloneSqlTuningTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CloneSqlTuningTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CloneSqlTuningTask API.
CreateSqlTuningSet(CreateSqlTuningSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an empty Sql tuning set within the Managed Database specified by managedDatabaseId.
Declaration
public Task<CreateSqlTuningSetResponse> CreateSqlTuningSet(CreateSqlTuningSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSqlTuningSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSqlTuningSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSqlTuningSet API.
DropSqlTuningSet(DropSqlTuningSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Drops the Sql tuning set specified by sqlTuningSet within the Managed Database specified by managedDatabaseId.
Declaration
public Task<DropSqlTuningSetResponse> DropSqlTuningSet(DropSqlTuningSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DropSqlTuningSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DropSqlTuningSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DropSqlTuningSet API.
DropSqlTuningTask(DropSqlTuningTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Drops a SQL tuning task and its related results from the database.
Declaration
public Task<DropSqlTuningTaskResponse> DropSqlTuningTask(DropSqlTuningTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DropSqlTuningTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DropSqlTuningTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DropSqlTuningTask API.
DropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DropSqlsInSqlTuningSetResponse> DropSqlsInSqlTuningSet(DropSqlsInSqlTuningSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DropSqlsInSqlTuningSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DropSqlsInSqlTuningSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DropSqlsInSqlTuningSet API.
FetchSqlTuningSet(FetchSqlTuningSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Fetch the details of Sql statements in the Sql tuning set specified by name, owner and optional filter parameters.
Declaration
public Task<FetchSqlTuningSetResponse> FetchSqlTuningSet(FetchSqlTuningSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
FetchSqlTuningSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<FetchSqlTuningSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use FetchSqlTuningSet API.
GetExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GetExecutionPlanStatsComparisionResponse> GetExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetExecutionPlanStatsComparisionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetExecutionPlanStatsComparisionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetExecutionPlanStatsComparision API.
GetSqlExecutionPlan(GetSqlExecutionPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a SQL execution plan for the SQL being tuned.
Declaration
public Task<GetSqlExecutionPlanResponse> GetSqlExecutionPlan(GetSqlExecutionPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSqlExecutionPlanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSqlExecutionPlanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSqlExecutionPlan API.
GetSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the summary report for the specified SQL Tuning Advisor task.
Declaration
public Task<GetSqlTuningAdvisorTaskSummaryReportResponse> GetSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSqlTuningAdvisorTaskSummaryReportRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSqlTuningAdvisorTaskSummaryReportResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSqlTuningAdvisorTaskSummaryReport API.
ListSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an array of the details of the findings that match specific filters.
Declaration
public Task<ListSqlTuningAdvisorTaskFindingsResponse> ListSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSqlTuningAdvisorTaskFindingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSqlTuningAdvisorTaskFindingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSqlTuningAdvisorTaskFindings API.
ListSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the findings and possible actions for a given object in a SQL tuning task. The task ID and object ID are used to retrieve the findings and recommendations.
Declaration
public Task<ListSqlTuningAdvisorTaskRecommendationsResponse> ListSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSqlTuningAdvisorTaskRecommendationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSqlTuningAdvisorTaskRecommendationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSqlTuningAdvisorTaskRecommendations API.
ListSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the SQL Tuning Advisor tasks for the specified Managed Database.
Declaration
public Task<ListSqlTuningAdvisorTasksResponse> ListSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSqlTuningAdvisorTasksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSqlTuningAdvisorTasksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSqlTuningAdvisorTasks API.
ListSqlTuningSets(ListSqlTuningSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the SQL tuning sets for the specified Managed Database.
Declaration
public Task<ListSqlTuningSetsResponse> ListSqlTuningSets(ListSqlTuningSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSqlTuningSetsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSqlTuningSetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSqlTuningSets API.
LoadSqlTuningSet(LoadSqlTuningSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Load Sql statements into the Sql tuning set specified by name and optional filter parameters within the Managed Database specified by managedDatabaseId.
Declaration
public Task<LoadSqlTuningSetResponse> LoadSqlTuningSet(LoadSqlTuningSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
LoadSqlTuningSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<LoadSqlTuningSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use LoadSqlTuningSet API.
SaveSqlTuningSetAs(SaveSqlTuningSetAsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Saves the specified list of Sqls statements into another new Sql tuning set or loads into an existing Sql tuning set'.
Declaration
public Task<SaveSqlTuningSetAsResponse> SaveSqlTuningSetAs(SaveSqlTuningSetAsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SaveSqlTuningSetAsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SaveSqlTuningSetAsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SaveSqlTuningSetAs API.
StartSqlTuningTask(StartSqlTuningTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.
Declaration
public Task<StartSqlTuningTaskResponse> StartSqlTuningTask(StartSqlTuningTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StartSqlTuningTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StartSqlTuningTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartSqlTuningTask API.
ValidateBasicFilter(ValidateBasicFilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Executes a SQL query to check whether user entered basic filter criteria is valid or not.
Declaration
public Task<ValidateBasicFilterResponse> ValidateBasicFilter(ValidateBasicFilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateBasicFilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateBasicFilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateBasicFilter API.