SqlPlanBaseline¶

class oci.database_management.models.SqlPlanBaseline(**kwargs)¶

Bases: object

The details of a SQL plan baseline.

Attributes

`ACCEPTED_NO`	A constant which can be used with the accepted property of a SqlPlanBaseline.
`ACCEPTED_YES`	A constant which can be used with the accepted property of a SqlPlanBaseline.
`ADAPTIVE_NO`	A constant which can be used with the adaptive property of a SqlPlanBaseline.
`ADAPTIVE_YES`	A constant which can be used with the adaptive property of a SqlPlanBaseline.
`AUTO_PURGE_NO`	A constant which can be used with the auto_purge property of a SqlPlanBaseline.
`AUTO_PURGE_YES`	A constant which can be used with the auto_purge property of a SqlPlanBaseline.
`ENABLED_NO`	A constant which can be used with the enabled property of a SqlPlanBaseline.
`ENABLED_YES`	A constant which can be used with the enabled property of a SqlPlanBaseline.
`FIXED_NO`	A constant which can be used with the fixed property of a SqlPlanBaseline.
`FIXED_YES`	A constant which can be used with the fixed property of a SqlPlanBaseline.
`ORIGIN_ADDM_SQLTUNE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_AUTO_CAPTURE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_AUTO_SQLTUNE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_EVOLVE_AUTO_INDEX_LOAD`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_EVOLVE_CREATE_FROM_ADAPTIVE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_EVOLVE_LOAD_FROM_AWR`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_EVOLVE_LOAD_FROM_CURSOR_CACHE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_EVOLVE_LOAD_FROM_STS`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_MANUAL_LOAD`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_MANUAL_LOAD_FROM_AWR`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_MANUAL_LOAD_FROM_CURSOR_CACHE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_MANUAL_LOAD_FROM_STS`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_MANUAL_SQLTUNE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_STORED_OUTLINE`	A constant which can be used with the origin property of a SqlPlanBaseline.
`ORIGIN_UNKNOWN`	A constant which can be used with the origin property of a SqlPlanBaseline.
`REPRODUCED_NO`	A constant which can be used with the reproduced property of a SqlPlanBaseline.
`REPRODUCED_YES`	A constant which can be used with the reproduced property of a SqlPlanBaseline.
`accepted`	Gets the accepted of this SqlPlanBaseline.
`action`	Gets the action of this SqlPlanBaseline.
`adaptive`	Gets the adaptive of this SqlPlanBaseline.
`auto_purge`	Gets the auto_purge of this SqlPlanBaseline.
`enabled`	Gets the enabled of this SqlPlanBaseline.
`execution_plan`	[Required] Gets the execution_plan of this SqlPlanBaseline.
`fixed`	Gets the fixed of this SqlPlanBaseline.
`module`	Gets the module of this SqlPlanBaseline.
`origin`	Gets the origin of this SqlPlanBaseline.
`plan_name`	[Required] Gets the plan_name of this SqlPlanBaseline.
`reproduced`	Gets the reproduced of this SqlPlanBaseline.
`sql_handle`	[Required] Gets the sql_handle of this SqlPlanBaseline.
`sql_text`	[Required] Gets the sql_text of this SqlPlanBaseline.
`time_created`	[Required] Gets the time_created of this SqlPlanBaseline.
`time_last_executed`	Gets the time_last_executed of this SqlPlanBaseline.
`time_last_modified`	Gets the time_last_modified of this SqlPlanBaseline.

Methods

__init__(**kwargs) Initializes a new SqlPlanBaseline object with values from keyword arguments.

ACCEPTED_NO = 'NO'¶: A constant which can be used with the accepted property of a SqlPlanBaseline. This constant has a value of “NO”

ACCEPTED_YES = 'YES'¶: A constant which can be used with the accepted property of a SqlPlanBaseline. This constant has a value of “YES”

ADAPTIVE_NO = 'NO'¶: A constant which can be used with the adaptive property of a SqlPlanBaseline. This constant has a value of “NO”

ADAPTIVE_YES = 'YES'¶: A constant which can be used with the adaptive property of a SqlPlanBaseline. This constant has a value of “YES”

AUTO_PURGE_NO = 'NO'¶: A constant which can be used with the auto_purge property of a SqlPlanBaseline. This constant has a value of “NO”

AUTO_PURGE_YES = 'YES'¶: A constant which can be used with the auto_purge property of a SqlPlanBaseline. This constant has a value of “YES”

ENABLED_NO = 'NO'¶: A constant which can be used with the enabled property of a SqlPlanBaseline. This constant has a value of “NO”

ENABLED_YES = 'YES'¶: A constant which can be used with the enabled property of a SqlPlanBaseline. This constant has a value of “YES”

FIXED_NO = 'NO'¶: A constant which can be used with the fixed property of a SqlPlanBaseline. This constant has a value of “NO”

FIXED_YES = 'YES'¶: A constant which can be used with the fixed property of a SqlPlanBaseline. This constant has a value of “YES”

ORIGIN_ADDM_SQLTUNE = 'ADDM_SQLTUNE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “ADDM_SQLTUNE”

ORIGIN_AUTO_CAPTURE = 'AUTO_CAPTURE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “AUTO_CAPTURE”

ORIGIN_AUTO_SQLTUNE = 'AUTO_SQLTUNE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “AUTO_SQLTUNE”

ORIGIN_EVOLVE_AUTO_INDEX_LOAD = 'EVOLVE_AUTO_INDEX_LOAD'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “EVOLVE_AUTO_INDEX_LOAD”

ORIGIN_EVOLVE_CREATE_FROM_ADAPTIVE = 'EVOLVE_CREATE_FROM_ADAPTIVE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “EVOLVE_CREATE_FROM_ADAPTIVE”

ORIGIN_EVOLVE_LOAD_FROM_AWR = 'EVOLVE_LOAD_FROM_AWR'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “EVOLVE_LOAD_FROM_AWR”

ORIGIN_EVOLVE_LOAD_FROM_CURSOR_CACHE = 'EVOLVE_LOAD_FROM_CURSOR_CACHE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “EVOLVE_LOAD_FROM_CURSOR_CACHE”

ORIGIN_EVOLVE_LOAD_FROM_STS = 'EVOLVE_LOAD_FROM_STS'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “EVOLVE_LOAD_FROM_STS”

ORIGIN_MANUAL_LOAD = 'MANUAL_LOAD'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “MANUAL_LOAD”

ORIGIN_MANUAL_LOAD_FROM_AWR = 'MANUAL_LOAD_FROM_AWR'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “MANUAL_LOAD_FROM_AWR”

ORIGIN_MANUAL_LOAD_FROM_CURSOR_CACHE = 'MANUAL_LOAD_FROM_CURSOR_CACHE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “MANUAL_LOAD_FROM_CURSOR_CACHE”

ORIGIN_MANUAL_LOAD_FROM_STS = 'MANUAL_LOAD_FROM_STS'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “MANUAL_LOAD_FROM_STS”

ORIGIN_MANUAL_SQLTUNE = 'MANUAL_SQLTUNE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “MANUAL_SQLTUNE”

ORIGIN_STORED_OUTLINE = 'STORED_OUTLINE'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “STORED_OUTLINE”

ORIGIN_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the origin property of a SqlPlanBaseline. This constant has a value of “UNKNOWN”

REPRODUCED_NO = 'NO'¶: A constant which can be used with the reproduced property of a SqlPlanBaseline. This constant has a value of “NO”

REPRODUCED_YES = 'YES'¶: A constant which can be used with the reproduced property of a SqlPlanBaseline. This constant has a value of “YES”

__init__(**kwargs)¶

Initializes a new SqlPlanBaseline object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

plan_name (str) – The value to assign to the plan_name property of this SqlPlanBaseline.
sql_handle (str) – The value to assign to the sql_handle property of this SqlPlanBaseline.
sql_text (str) – The value to assign to the sql_text property of this SqlPlanBaseline.
origin (str) – The value to assign to the origin property of this SqlPlanBaseline. Allowed values for this property are: “ADDM_SQLTUNE”, “AUTO_CAPTURE”, “AUTO_SQLTUNE”, “EVOLVE_AUTO_INDEX_LOAD”, “EVOLVE_CREATE_FROM_ADAPTIVE”, “EVOLVE_LOAD_FROM_STS”, “EVOLVE_LOAD_FROM_AWR”, “EVOLVE_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD”, “MANUAL_LOAD_FROM_AWR”, “MANUAL_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD_FROM_STS”, “MANUAL_SQLTUNE”, “STORED_OUTLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this SqlPlanBaseline.
time_last_modified (datetime) – The value to assign to the time_last_modified property of this SqlPlanBaseline.
time_last_executed (datetime) – The value to assign to the time_last_executed property of this SqlPlanBaseline.
enabled (str) – The value to assign to the enabled property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
accepted (str) – The value to assign to the accepted property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
fixed (str) – The value to assign to the fixed property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
reproduced (str) – The value to assign to the reproduced property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
auto_purge (str) – The value to assign to the auto_purge property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
adaptive (str) – The value to assign to the adaptive property of this SqlPlanBaseline. Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
module (str) – The value to assign to the module property of this SqlPlanBaseline.
action (str) – The value to assign to the action property of this SqlPlanBaseline.
execution_plan (str) – The value to assign to the execution_plan property of this SqlPlanBaseline.

accepted¶

Gets the accepted of this SqlPlanBaseline. Indicates whether the plan baseline is accepted (YES) or not (NO).

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The accepted of this SqlPlanBaseline.
Return type:	str

action¶

Gets the action of this SqlPlanBaseline. The application action.

Returns:	The action of this SqlPlanBaseline.
Return type:	str

adaptive¶

Gets the adaptive of this SqlPlanBaseline. Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.

When a new adaptive plan is found for a SQL statement that has an existing SQL plan baseline, that new plan will be added to the SQL plan baseline as an unaccepted plan, and the ADAPTIVE property will be marked YES. When this new plan is verified (either manually or via the auto evolve task), the plan will be test executed and the final plan determined at execution will become an accepted plan if its performance is better than the existing plan baseline. At this point, the value of the ADAPTIVE property is set to NO since the plan is no longer adaptive, but resolved.

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The adaptive of this SqlPlanBaseline.
Return type:	str

auto_purge¶

Gets the auto_purge of this SqlPlanBaseline. Indicates whether the plan baseline is auto-purged (YES) or not (NO).

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The auto_purge of this SqlPlanBaseline.
Return type:	str

enabled¶

Gets the enabled of this SqlPlanBaseline. Indicates whether the plan baseline is enabled (YES) or disabled (NO).

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The enabled of this SqlPlanBaseline.
Return type:	str

execution_plan¶

[Required] Gets the execution_plan of this SqlPlanBaseline. The execution plan for the SQL statement.

Returns:	The execution_plan of this SqlPlanBaseline.
Return type:	str

fixed¶

Gets the fixed of this SqlPlanBaseline. Indicates whether the plan baseline is fixed (YES) or not (NO).

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The fixed of this SqlPlanBaseline.
Return type:	str

module¶

Gets the module of this SqlPlanBaseline. The application module name.

Returns:	The module of this SqlPlanBaseline.
Return type:	str

origin¶

Gets the origin of this SqlPlanBaseline. The origin of the SQL plan baseline.

Allowed values for this property are: “ADDM_SQLTUNE”, “AUTO_CAPTURE”, “AUTO_SQLTUNE”, “EVOLVE_AUTO_INDEX_LOAD”, “EVOLVE_CREATE_FROM_ADAPTIVE”, “EVOLVE_LOAD_FROM_STS”, “EVOLVE_LOAD_FROM_AWR”, “EVOLVE_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD”, “MANUAL_LOAD_FROM_AWR”, “MANUAL_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD_FROM_STS”, “MANUAL_SQLTUNE”, “STORED_OUTLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The origin of this SqlPlanBaseline.
Return type:	str

plan_name¶

[Required] Gets the plan_name of this SqlPlanBaseline. The unique plan identifier.

Returns:	The plan_name of this SqlPlanBaseline.
Return type:	str

reproduced¶

Gets the reproduced of this SqlPlanBaseline. Indicates whether the optimizer was able to reproduce the plan (YES) or not (NO). The value is set to YES when a plan is initially added to the plan baseline.

Allowed values for this property are: “YES”, “NO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The reproduced of this SqlPlanBaseline.
Return type:	str

sql_handle¶

[Required] Gets the sql_handle of this SqlPlanBaseline. The unique SQL identifier.

Returns:	The sql_handle of this SqlPlanBaseline.
Return type:	str

sql_text¶

[Required] Gets the sql_text of this SqlPlanBaseline. The SQL text.

Returns:	The sql_text of this SqlPlanBaseline.
Return type:	str

time_created¶

[Required] Gets the time_created of this SqlPlanBaseline. The date and time when the plan baseline was created.

Returns:	The time_created of this SqlPlanBaseline.
Return type:	datetime

time_last_executed¶

Gets the time_last_executed of this SqlPlanBaseline. The date and time when the plan baseline was last executed.

Note: For performance reasons, database does not update this value immediately after each execution of the plan baseline. Therefore, the plan baseline may have been executed more recently than this value indicates.

Returns:	The time_last_executed of this SqlPlanBaseline.
Return type:	datetime

time_last_modified¶

Gets the time_last_modified of this SqlPlanBaseline. The date and time when the plan baseline was last modified.

Returns:	The time_last_modified of this SqlPlanBaseline.
Return type:	datetime