DatabasePlanDirective¶

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

Bases: object

Manages resource allocation among databases. Besides the name, at least one other property must be available.

Attributes

`ROLE_NONE`	A constant which can be used with the role property of a DatabasePlanDirective.
`ROLE_PRIMARY`	A constant which can be used with the role property of a DatabasePlanDirective.
`ROLE_STANDBY`	A constant which can be used with the role property of a DatabasePlanDirective.
`TYPE_DATABASE`	A constant which can be used with the type property of a DatabasePlanDirective.
`TYPE_OTHER`	A constant which can be used with the type property of a DatabasePlanDirective.
`TYPE_PROFILE`	A constant which can be used with the type property of a DatabasePlanDirective.
`allocation`	Gets the allocation of this DatabasePlanDirective.
`asm_cluster`	Gets the asm_cluster of this DatabasePlanDirective.
`flash_cache_limit`	Gets the flash_cache_limit of this DatabasePlanDirective.
`flash_cache_min`	Gets the flash_cache_min of this DatabasePlanDirective.
`flash_cache_size`	Gets the flash_cache_size of this DatabasePlanDirective.
`is_flash_cache_on`	Gets the is_flash_cache_on of this DatabasePlanDirective.
`is_flash_log_on`	Gets the is_flash_log_on of this DatabasePlanDirective.
`is_pmem_cache_on`	Gets the is_pmem_cache_on of this DatabasePlanDirective.
`is_pmem_log_on`	Gets the is_pmem_log_on of this DatabasePlanDirective.
`level`	Gets the level of this DatabasePlanDirective.
`limit`	Gets the limit of this DatabasePlanDirective.
`name`	[Required] Gets the name of this DatabasePlanDirective.
`pmem_cache_limit`	Gets the pmem_cache_limit of this DatabasePlanDirective.
`pmem_cache_min`	Gets the pmem_cache_min of this DatabasePlanDirective.
`pmem_cache_size`	Gets the pmem_cache_size of this DatabasePlanDirective.
`role`	Gets the role of this DatabasePlanDirective.
`share`	Gets the share of this DatabasePlanDirective.
`type`	Gets the type of this DatabasePlanDirective.

Methods

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

ROLE_NONE = 'NONE'¶: A constant which can be used with the role property of a DatabasePlanDirective. This constant has a value of “NONE”

ROLE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the role property of a DatabasePlanDirective. This constant has a value of “PRIMARY”

ROLE_STANDBY = 'STANDBY'¶: A constant which can be used with the role property of a DatabasePlanDirective. This constant has a value of “STANDBY”

TYPE_DATABASE = 'DATABASE'¶: A constant which can be used with the type property of a DatabasePlanDirective. This constant has a value of “DATABASE”

TYPE_OTHER = 'OTHER'¶: A constant which can be used with the type property of a DatabasePlanDirective. This constant has a value of “OTHER”

TYPE_PROFILE = 'PROFILE'¶: A constant which can be used with the type property of a DatabasePlanDirective. This constant has a value of “PROFILE”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this DatabasePlanDirective.
share (int) – The value to assign to the share property of this DatabasePlanDirective.
level (int) – The value to assign to the level property of this DatabasePlanDirective.
allocation (int) – The value to assign to the allocation property of this DatabasePlanDirective.
limit (int) – The value to assign to the limit property of this DatabasePlanDirective.
is_flash_cache_on (bool) – The value to assign to the is_flash_cache_on property of this DatabasePlanDirective.
is_pmem_cache_on (bool) – The value to assign to the is_pmem_cache_on property of this DatabasePlanDirective.
is_flash_log_on (bool) – The value to assign to the is_flash_log_on property of this DatabasePlanDirective.
is_pmem_log_on (bool) – The value to assign to the is_pmem_log_on property of this DatabasePlanDirective.
flash_cache_limit (str) – The value to assign to the flash_cache_limit property of this DatabasePlanDirective.
flash_cache_min (str) – The value to assign to the flash_cache_min property of this DatabasePlanDirective.
flash_cache_size (str) – The value to assign to the flash_cache_size property of this DatabasePlanDirective.
pmem_cache_limit (str) – The value to assign to the pmem_cache_limit property of this DatabasePlanDirective.
pmem_cache_min (str) – The value to assign to the pmem_cache_min property of this DatabasePlanDirective.
pmem_cache_size (str) – The value to assign to the pmem_cache_size property of this DatabasePlanDirective.
asm_cluster (str) – The value to assign to the asm_cluster property of this DatabasePlanDirective.
type (str) – The value to assign to the type property of this DatabasePlanDirective. Allowed values for this property are: “DATABASE”, “PROFILE”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
role (str) – The value to assign to the role property of this DatabasePlanDirective. Allowed values for this property are: “PRIMARY”, “STANDBY”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

allocation¶

Gets the allocation of this DatabasePlanDirective. The resource allocation as a percentage (0-100) within the level.

Returns:	The allocation of this DatabasePlanDirective.
Return type:	int

asm_cluster¶

Gets the asm_cluster of this DatabasePlanDirective. Starting with Oracle Exadata System Software release 19.1.0, you can use the asmcluster attribute to distinguish between databases with the same name running in different Oracle ASM clusters.

Returns:	The asm_cluster of this DatabasePlanDirective.
Return type:	str

flash_cache_limit¶

Gets the flash_cache_limit of this DatabasePlanDirective. Defines a soft limit for space usage in Exadata Smart Flash Cache. If the cache is not full, the limit can be exceeded. You specify the value for flashcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachelimit must be at least 4 MB. The flashcachelimit and flashcachesize attributes cannot be specified in the same directive. The value for flashcachelimit cannot be smaller than flashcachemin, if it is specified.

Returns:	The flash_cache_limit of this DatabasePlanDirective.
Return type:	str

flash_cache_min¶

Gets the flash_cache_min of this DatabasePlanDirective. Specifies a minimum guaranteed space allocation in Exadata Smart Flash Cache. You specify the value for flashcachemin in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachemin must be at least 4 MB. In any plan, the sum of all flashcachemin values cannot exceed the size of Exadata Smart Flash Cache. If flashcachelimit is specified, then the value for flashcachemin cannot exceed flashcachelimit. If flashcachesize is specified, then the value for flashcachemin cannot exceed flashcachesize.

Returns:	The flash_cache_min of this DatabasePlanDirective.
Return type:	str

flash_cache_size¶

Gets the flash_cache_size of this DatabasePlanDirective. Defines a hard limit for space usage in Exadata Smart Flash Cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of Exadata Smart Flash Cache can accommodate all of the flashcachemin and flashcachesize allocations, then each flashcachesize definition represents a guaranteed space allocation. However, starting with Oracle Exadata System Software release 19.2.0 you can use the flashcachesize attribute to over-provision space in Exadata Smart Flash Cache. Consequently, if the size of Exadata Smart Flash Cache cannot accommodate all of the flashcachemin and flashcachesize allocations, then only flashcachemin is guaranteed.

Returns:	The flash_cache_size of this DatabasePlanDirective.
Return type:	str

is_flash_cache_on¶

Gets the is_flash_cache_on of this DatabasePlanDirective. Controls use of Exadata Smart Flash Cache by a database. This ensures that cache space is reserved for mission-critical databases. flashcache=off is invalid in a directive that contains the flashcachemin, flashcachelimit, or flashcachesize attributes.

Returns:	The is_flash_cache_on of this DatabasePlanDirective.
Return type:	bool

is_flash_log_on¶

Gets the is_flash_log_on of this DatabasePlanDirective. Controls use of Exadata Smart Flash Log by a database. This ensures that Exadata Smart Flash Log is reserved for mission-critical databases.

Returns:	The is_flash_log_on of this DatabasePlanDirective.
Return type:	bool

is_pmem_cache_on¶

Gets the is_pmem_cache_on of this DatabasePlanDirective. Controls use of the persistent memory (PMEM) cache by a database. This ensures that cache space is reserved for mission-critical databases. pmemcache=off is invalid in a directive that contains the pmemcachemin, pmemcachelimit, or pmemcachesize attributes.

Returns:	The is_pmem_cache_on of this DatabasePlanDirective.
Return type:	bool

is_pmem_log_on¶

Gets the is_pmem_log_on of this DatabasePlanDirective. Controls use of persistent memory logging (PMEM log) by a database. This ensures that PMEM log is reserved for mission-critical databases.

Returns:	The is_pmem_log_on of this DatabasePlanDirective.
Return type:	bool

level¶

Gets the level of this DatabasePlanDirective. The allocation level. Valid values are from 1 to 8. Resources are allocated to level 1 first, and then remaining resources are allocated to level 2, and so on.

Returns:	The level of this DatabasePlanDirective.
Return type:	int

limit¶

Gets the limit of this DatabasePlanDirective. The maximum I/O utilization limit as a percentage of the available resources.

Returns:	The limit of this DatabasePlanDirective.
Return type:	int

name¶

[Required] Gets the name of this DatabasePlanDirective. The name of a database or a profile.

Returns:	The name of this DatabasePlanDirective.
Return type:	str

pmem_cache_limit¶

Gets the pmem_cache_limit of this DatabasePlanDirective. Defines a soft limit for space usage in the persistent memory (PMEM) cache. If the cache is not full, the limit can be exceeded. You specify the value for pmemcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for pmemcachelimit must be at least 4 MB. The pmemcachelimit and pmemcachesize attributes cannot be specified in the same directive. The value for pmemcachelimit cannot be smaller than pmemcachemin, if it is specified.

Returns:	The pmem_cache_limit of this DatabasePlanDirective.
Return type:	str

pmem_cache_min¶

Gets the pmem_cache_min of this DatabasePlanDirective. Specifies a minimum guaranteed space allocation in the persistent memory (PMEM) cache.

Returns:	The pmem_cache_min of this DatabasePlanDirective.
Return type:	str

pmem_cache_size¶

Gets the pmem_cache_size of this DatabasePlanDirective. Defines a hard limit for space usage in the persistent memory (PMEM) cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of the PMEM cache can accommodate all of the pmemcachemin and pmemcachesize allocations, then each pmemcachesize definition represents a guaranteed space allocation. However, you can use the pmemcachesize attribute to over-provision space in the PMEM cache. Consequently, if the PMEM cache size cannot accommodate all of the pmemcachemin and pmemcachesize allocations, then only pmemcachemin is guaranteed.

Returns:	The pmem_cache_size of this DatabasePlanDirective.
Return type:	str

role¶

Gets the role of this DatabasePlanDirective. Enables you to specify different plan directives based on the Oracle Data Guard database role.

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

Returns:	The role of this DatabasePlanDirective.
Return type:	str

share¶

Gets the share of this DatabasePlanDirective. The relative priority of a database in the database plan. A higher share value implies higher priority and more access to the I/O resources. Use either share or (level, allocation). All plan directives in a database plan should use the same setting. Share-based resource allocation is the recommended method for a database plan.

Returns:	The share of this DatabasePlanDirective.
Return type:	int

type¶

Gets the type of this DatabasePlanDirective. Enables you to create a profile or template, to ease management and configuration of resource plans in environments with many databases.

type=database: Specifies a directive that applies to a specific database.

If type in not specified, then the directive defaults to the database type. - type=profile: Specifies a directive that applies to a profile rather than a specific database.

To associate a database with an IORM profile, you must set the database initialization parameter db_performance_profile to the value of the profile name. Databases that map to a profile inherit the settings specified in the profile.

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

Returns:	The type of this DatabasePlanDirective.
Return type:	str