Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace StartSqlTuningTaskDetails

The request to start a SQL tuning task. It takes either credentialDetails or databaseCredential. It's recommended to provide databaseCredential

Properties

Optional credentialDetails

Optional databaseCredential

scope

scope: Scope

The scope for the SQL tuning task. For LIMITED scope, the SQL profile recommendation is excluded, so the task is executed faster. For COMPREHENSIVE scope, the SQL profile recommendation is included.

Optional sqlDetails

The details of the SQL statement on which tuning is performed. To obtain the details of the SQL statement, you must provide either the sqlTuningSet or the tuple of sqlDetails/timeStarted/timeEnded.

Optional sqlTuningSet

sqlTuningSet: model.SqlTuningSetInput

Optional statementTimeLimitInMinutes

statementTimeLimitInMinutes: undefined | number

The time limit per SQL statement (in minutes). This is for a task with the COMPREHENSIVE scope. The time limit per SQL statement should not be more than the total time limit. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional taskDescription

taskDescription: undefined | string

The description of the SQL tuning task.

taskName

taskName: string

The name of the SQL tuning task. The name is unique per user in a database, and it is case-sensitive.

Optional timeEnded

timeEnded: Date

The end time of the period in which SQL statements are running.

Optional timeStarted

timeStarted: Date

The start time of the period in which SQL statements are running.

totalTimeLimitInMinutes

totalTimeLimitInMinutes: number

The time limit for running the SQL tuning task. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj