Class LoadSqlTuningSetDetails

The details required to load the Sql statements into the Sql tuning set. It takes either credentialDetails or databaseCredential. It's recommended to provide databaseCredential

Inheritance

object

LoadSqlTuningSetDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemanagementService.Models

Assembly: OCI.DotNetSDK.Databasemanagement.dll

Syntax

public class LoadSqlTuningSetDetails

Properties

AttributeList

Declaration

[JsonProperty(PropertyName = "attributeList")]
public string AttributeList { get; set; }

Property Value

Type	Description
string	Specifies the list of Sql statement attributes to return in the result. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Attribute list can take one of the following values. TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. ALL - Specifies all attributes. CUSTOM - Comma-separated list of the following attribute names. - EXECUTION_STATISTICS - BIND_LIST - OBJECT_LIST - SQL_PLAN - SQL_PLAN_STATISTICS Usage examples: "attributeList": "TYPICAL" "attributeList": "ALL" "attributeList": "EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN"

Type

Description

string

Specifies the list of Sql statement attributes to return in the result. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Attribute list can take one of the following values. TYPICAL - Specifies BASIC plus Sql plan (without row source statistics) and without object reference list (default). BASIC - Specifies all attributes (such as execution statistics and binds) except the plans. The execution context is always part of the result. ALL - Specifies all attributes. CUSTOM - Comma-separated list of the following attribute names. - EXECUTION_STATISTICS - BIND_LIST - OBJECT_LIST - SQL_PLAN - SQL_PLAN_STATISTICS Usage examples:

"attributeList": "TYPICAL"
"attributeList": "ALL"
"attributeList": "EXECUTION_STATISTICS,OBJECT_LIST,SQL_PLAN"

BaselineName

Declaration

[JsonProperty(PropertyName = "baselineName")]
public string BaselineName { get; set; }

Property Value

Type	Description
string	Specifies the name of the AWR baseline period. When loading the sql statements from AWR, following inputs has to be provided: beginSnapshot and endSnapshot OR baselineName

BasicFilter

Declaration

[JsonProperty(PropertyName = "basicFilter")]
public string BasicFilter { get; set; }

Property Value

Type	Description
string	Specifies the Sql predicate to filter the Sql from the Sql tuning set defined on attributes of the SQLSET_ROW. User could use any combination of the following columns with appropriate values as Sql predicate Refer to the documentation https://docs.oracle.com/en/database/oracle/oracle-database/18/arpls/DBMS_SQLTUNE.html#GUID-1F4AFB03-7B29-46FC-B3F2-CB01EC36326C

BeginSnapshot

Declaration

[JsonProperty(PropertyName = "beginSnapshot")]
public long? BeginSnapshot { get; set; }

Property Value

Type	Description
long?	Defines the beginning AWR snapshot (non-inclusive).

CaptureMode

Declaration

[JsonProperty(PropertyName = "captureMode")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.CaptureModeEnum? CaptureMode { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.CaptureModeEnum?	Specifies the capture mode. Note that this parameter is applicable only for UPDATE and MERGE capture options. Capture mode can take one of the following values MODE_REPLACE_OLD_STATS Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set MODE_ACCUMULATE_STATS Adds new values to current values for Sql that is already stored. Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under.

Type

Description

LoadSqlTuningSetDetails.CaptureModeEnum?

Specifies the capture mode. Note that this parameter is applicable only for UPDATE and MERGE capture options. Capture mode can take one of the following values

MODE_REPLACE_OLD_STATS Replaces statistics when the number of executions is greater than the number stored in the Sql tuning set
MODE_ACCUMULATE_STATS Adds new values to current values for Sql that is already stored. Note that this mode detects if a statement has been aged out, so the final value for a statistics is the sum of the statistics of all cursors that statement existed under.

CaptureOption

Declaration

[JsonProperty(PropertyName = "captureOption")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.CaptureOptionEnum? CaptureOption { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.CaptureOptionEnum?	Specifies whether to insert new statements, update existing statements, or both.

CommitRows

Declaration

[JsonProperty(PropertyName = "commitRows")]
public int? CommitRows { get; set; }

Property Value

Type	Description
int?	Specifies whether to commit statements after DML. If a value is provided, then the load commits after each specified number of statements is inserted. If NULL is provided, then the load commits only once, at the end of the operation.

CredentialDetails

Declaration

[JsonProperty(PropertyName = "credentialDetails")]
public SqlTuningSetAdminCredentialDetails CredentialDetails { get; set; }

Property Value

Type	Description
SqlTuningSetAdminCredentialDetails

DatabaseCredential

Declaration

[JsonProperty(PropertyName = "databaseCredential")]
public DatabaseCredentialDetails DatabaseCredential { get; set; }

Property Value

Type	Description
DatabaseCredentialDetails

EndSnapshot

Declaration

[JsonProperty(PropertyName = "endSnapshot")]
public long? EndSnapshot { get; set; }

Property Value

Type	Description
long?	Defines the ending AWR snapshot (inclusive).

IsIgnoreNull

Declaration

[JsonProperty(PropertyName = "isIgnoreNull")]
public bool? IsIgnoreNull { get; set; }

Property Value

Type	Description
bool?	Specifies whether to update attributes when the new value is NULL. If TRUE, then the procedure does not update an attribute when the new value is NULL. That is, do not override with NULL values unless intentional. Possible values - true or false

LoadOption

Declaration

[JsonProperty(PropertyName = "loadOption")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.LoadOptionEnum? LoadOption { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.LoadOptionEnum?	Specifies which statements are loaded into the Sql tuning set. The possible values are. INSERT (default) Adds only new statements. UPDATE Updates existing the Sql statements and ignores any new statements. MERGE Inserts new statements and updates the information of the existing ones.

Type

Description

LoadSqlTuningSetDetails.LoadOptionEnum?

Specifies which statements are loaded into the Sql tuning set. The possible values are.

INSERT (default) Adds only new statements.
UPDATE Updates existing the Sql statements and ignores any new statements.
MERGE Inserts new statements and updates the information of the existing ones.

LoadType

Declaration

[Required(ErrorMessage = "LoadType is required.")]
[JsonProperty(PropertyName = "loadType")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.LoadTypeEnum? LoadType { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.LoadTypeEnum?	Specifies the loading method into the Sql tuning set.

Remarks

Required

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	The name of the Sql tuning set.

Remarks

Required

Owner

Declaration

[JsonProperty(PropertyName = "owner")]
public string Owner { get; set; }

Property Value

Type	Description
string	The owner of the Sql tuning set.

RankingMeasure1

Declaration

[JsonProperty(PropertyName = "rankingMeasure1")]
[JsonConverter(typeof(StringEnumConverter))]
public RankingMeasure? RankingMeasure1 { get; set; }

Property Value

Type	Description
RankingMeasure?	Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

RankingMeasure2

Declaration

[JsonProperty(PropertyName = "rankingMeasure2")]
[JsonConverter(typeof(StringEnumConverter))]
public RankingMeasure? RankingMeasure2 { get; set; }

Property Value

Type	Description
RankingMeasure?	Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

RankingMeasure3

Declaration

[JsonProperty(PropertyName = "rankingMeasure3")]
[JsonConverter(typeof(StringEnumConverter))]
public RankingMeasure? RankingMeasure3 { get; set; }

Property Value

Type	Description
RankingMeasure?	Specifies an ORDER BY clause on the selected Sql. User can specify upto three ranking measures.

RecursiveSql

Declaration

[JsonProperty(PropertyName = "recursiveSql")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.RecursiveSqlEnum? RecursiveSql { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.RecursiveSqlEnum?	Specifies that the filter must include recursive Sql in the Sql tuning set.

RepeatInterval

Declaration

[JsonProperty(PropertyName = "repeatInterval")]
public int? RepeatInterval { get; set; }

Property Value

Type	Description
int?	Defines the amount of time, in seconds, to pause between sampling.

ResultLimit

Declaration

[JsonProperty(PropertyName = "resultLimit")]
public int? ResultLimit { get; set; }

Property Value

Type	Description
int?	The top limit Sql from the filtered source, ranked by the ranking measure.

ResultPercentage

Declaration

[JsonProperty(PropertyName = "resultPercentage")]
public double ResultPercentage { get; set; }

Property Value

Type	Description
double	Specifies a filter that picks the top n% according to the supplied ranking measure. Note that this parameter applies only if one ranking measure is supplied.

ShowSqlOnly

Declaration

[JsonProperty(PropertyName = "showSqlOnly")]
public int? ShowSqlOnly { get; set; }

Property Value

Type	Description
int?	Flag to indicate whether to create the Sql tuning set or just display the plsql used to create Sql tuning set.

TotalTimeLimit

Declaration

[JsonProperty(PropertyName = "totalTimeLimit")]
public int? TotalTimeLimit { get; set; }

Property Value

Type	Description
int?	Defines the total amount of time, in seconds, to execute.

UpdateAttributes

Declaration

[JsonProperty(PropertyName = "updateAttributes")]
public string UpdateAttributes { get; set; }

Property Value

Type	Description
string	Specifies the list of Sql statement attributes to update during a merge or update. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Update attributes can take one of the following values. NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. BASIC - Specifies statistics and binds only. TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. ALL - Specifies all attributes, including the execution context attributes such as module and action. CUSTOM - List of comma separated attribute names to update EXECUTION_CONTEXT EXECUTION_STATISTICS SQL_BINDS SQL_PLAN SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) Usage examples: "updateAttributes": "TYPICAL" "updateAttributes": "BASIC" "updateAttributes": "EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN" "updateAttributes": "EXECUTION_STATISTICS,SQL_PLAN"

Type

Description

string

Specifies the list of Sql statement attributes to update during a merge or update. Note that this parameter cannot be made an enum since custom value can take a list of comma separated attribute names. Update attributes can take one of the following values. NULL (default) - Specifies the content of the input cursor except the execution context. On other terms, it is equivalent to ALL without execution contexts such as module and action. BASIC - Specifies statistics and binds only. TYPICAL - Specifies BASIC with Sql plans (without row source statistics) and without an object reference list. ALL - Specifies all attributes, including the execution context attributes such as module and action. CUSTOM - List of comma separated attribute names to update EXECUTION_CONTEXT EXECUTION_STATISTICS SQL_BINDS SQL_PLAN SQL_PLAN_STATISTICS (similar to SQL_PLAN with added row source statistics) Usage examples:

"updateAttributes": "TYPICAL"
"updateAttributes": "BASIC"
"updateAttributes": "EXECUTION_STATISTICS,SQL_PLAN_STATISTICS,SQL_PLAN"
"updateAttributes": "EXECUTION_STATISTICS,SQL_PLAN"

UpdateCondition

Declaration

[JsonProperty(PropertyName = "updateCondition")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.UpdateConditionEnum? UpdateCondition { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.UpdateConditionEnum?	Specifies when to perform the update. The procedure only performs the update when the specified condition is satisfied. The condition can refer to either the data source or destination. The condition must use the following prefixes to refer to attributes from the source or the destination: OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). NEW \u2014 Refers to statement attributes from the input statements (source). NULL \u2014 No updates are performed.

Type

Description

LoadSqlTuningSetDetails.UpdateConditionEnum?

Specifies when to perform the update. The procedure only performs the update when the specified condition is satisfied. The condition can refer to either the data source or destination. The condition must use the following prefixes to refer to attributes from the source or the destination: OLD \u2014 Refers to statement attributes from the SQL tuning set (destination). NEW \u2014 Refers to statement attributes from the input statements (source). NULL \u2014 No updates are performed.

UpdateOption

Declaration

[JsonProperty(PropertyName = "updateOption")]
[JsonConverter(typeof(StringEnumConverter))]
public LoadSqlTuningSetDetails.UpdateOptionEnum? UpdateOption { get; set; }

Property Value

Type	Description
LoadSqlTuningSetDetails.UpdateOptionEnum?	Specifies how existing Sql statements are updated. This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. Update option can take one of the following values. REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. Following Sql statement attributes can be accumulated. elapsed_time buffer_gets direct_writes disk_reads row_processed fetches executions end_of_fetch_count stat_period active_stat_period

Type

Description

LoadSqlTuningSetDetails.UpdateOptionEnum?

Specifies how existing Sql statements are updated. This parameter is applicable only if load_option is specified with UPDATE or MERGE as an option. Update option can take one of the following values. REPLACE (default) - Updates the statement using the new statistics, bind list, object list, and so on. ACCUMULATE - Combines attributes when possible (for example, statistics such as elapsed_time), otherwise replaces the existing values (for example, module and action) with the provided values. Following Sql statement attributes can be accumulated. elapsed_time buffer_gets direct_writes disk_reads row_processed fetches executions end_of_fetch_count stat_period active_stat_period