com.oracle.bmc.databasemanagement

Interface SqlTuning

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SqlTuningClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public interface SqlTuning
extends AutoCloseable

Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and running a SQL job on a Managed Database or Managed Database Group.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CloneSqlTuningTaskResponse	cloneSqlTuningTask(CloneSqlTuningTaskRequest request) Clones and runs a SQL tuning task in the database.
DropSqlTuningTaskResponse	dropSqlTuningTask(DropSqlTuningTaskRequest request) Drops a SQL tuning task and its related results from the database.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetExecutionPlanStatsComparisionResponse	getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request) Retrieves a comparison of the existing SQL execution plan and a new plan.
SqlTuningPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSqlExecutionPlanResponse	getSqlExecutionPlan(GetSqlExecutionPlanRequest request) Retrieves a SQL execution plan for the SQL being tuned.
GetSqlTuningAdvisorTaskSummaryReportResponse	getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request) Gets the summary report for the specified SQL Tuning Advisor task.
ListSqlTuningAdvisorTaskFindingsResponse	listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request) Gets an array of the details of the findings that match specific filters.
ListSqlTuningAdvisorTaskRecommendationsResponse	listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request) Gets the findings and possible actions for a given object in a SQL tuning task.
ListSqlTuningAdvisorTasksResponse	listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request) Lists the SQL Tuning Advisor tasks for the specified Managed Database.
ListSqlTuningSetsResponse	listSqlTuningSets(ListSqlTuningSetsRequest request) Lists the SQL tuning sets for the specified Managed Database.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
StartSqlTuningTaskResponse	startSqlTuningTask(StartSqlTuningTaskRequest request) Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

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 - flag to enable the use of realm specific endpoint template

cloneSqlTuningTask

CloneSqlTuningTaskResponse cloneSqlTuningTask(CloneSqlTuningTaskRequest request)

Clones and runs a SQL tuning task in the database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CloneSqlTuningTask API.

dropSqlTuningTask

DropSqlTuningTaskResponse dropSqlTuningTask(DropSqlTuningTaskRequest request)

Drops a SQL tuning task and its related results from the database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DropSqlTuningTask API.

getExecutionPlanStatsComparision

GetExecutionPlanStatsComparisionResponse getExecutionPlanStatsComparision(GetExecutionPlanStatsComparisionRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetExecutionPlanStatsComparision API.

getSqlExecutionPlan

GetSqlExecutionPlanResponse getSqlExecutionPlan(GetSqlExecutionPlanRequest request)

Retrieves a SQL execution plan for the SQL being tuned.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetSqlExecutionPlan API.

getSqlTuningAdvisorTaskSummaryReport

GetSqlTuningAdvisorTaskSummaryReportResponse getSqlTuningAdvisorTaskSummaryReport(GetSqlTuningAdvisorTaskSummaryReportRequest request)

Gets the summary report for the specified SQL Tuning Advisor task.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetSqlTuningAdvisorTaskSummaryReport API.

listSqlTuningAdvisorTaskFindings

ListSqlTuningAdvisorTaskFindingsResponse listSqlTuningAdvisorTaskFindings(ListSqlTuningAdvisorTaskFindingsRequest request)

Gets an array of the details of the findings that match specific filters.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSqlTuningAdvisorTaskFindings API.

listSqlTuningAdvisorTaskRecommendations

ListSqlTuningAdvisorTaskRecommendationsResponse listSqlTuningAdvisorTaskRecommendations(ListSqlTuningAdvisorTaskRecommendationsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSqlTuningAdvisorTaskRecommendations API.

listSqlTuningAdvisorTasks

ListSqlTuningAdvisorTasksResponse listSqlTuningAdvisorTasks(ListSqlTuningAdvisorTasksRequest request)

Lists the SQL Tuning Advisor tasks for the specified Managed Database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSqlTuningAdvisorTasks API.

listSqlTuningSets

ListSqlTuningSetsResponse listSqlTuningSets(ListSqlTuningSetsRequest request)

Lists the SQL tuning sets for the specified Managed Database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSqlTuningSets API.

startSqlTuningTask

StartSqlTuningTaskResponse startSqlTuningTask(StartSqlTuningTaskRequest request)

Starts a SQL tuning task for a given set of SQL statements from the active session history top SQL statements.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use StartSqlTuningTask API.

getPaginators

SqlTuningPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.