Datafile¶

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

Bases: object

The details of a data file.

Attributes

`LOST_WRITE_PROTECT_ENABLED`	A constant which can be used with the lost_write_protect property of a Datafile.
`LOST_WRITE_PROTECT_PROTECT_OFF`	A constant which can be used with the lost_write_protect property of a Datafile.
`LOST_WRITE_PROTECT_SUSPEND`	A constant which can be used with the lost_write_protect property of a Datafile.
`ONLINE_STATUS_OFFLINE`	A constant which can be used with the online_status property of a Datafile.
`ONLINE_STATUS_ONLINE`	A constant which can be used with the online_status property of a Datafile.
`ONLINE_STATUS_RECOVER`	A constant which can be used with the online_status property of a Datafile.
`ONLINE_STATUS_SYSOFF`	A constant which can be used with the online_status property of a Datafile.
`ONLINE_STATUS_SYSTEM`	A constant which can be used with the online_status property of a Datafile.
`SHARED_LOCAL_FOR_ALL`	A constant which can be used with the shared property of a Datafile.
`SHARED_LOCAL_FOR_RIM`	A constant which can be used with the shared property of a Datafile.
`SHARED_SHARED`	A constant which can be used with the shared property of a Datafile.
`STATUS_AVAILABLE`	A constant which can be used with the status property of a Datafile.
`STATUS_INVALID`	A constant which can be used with the status property of a Datafile.
`STATUS_OFFLINE`	A constant which can be used with the status property of a Datafile.
`STATUS_ONLINE`	A constant which can be used with the status property of a Datafile.
`STATUS_UNKNOWN`	A constant which can be used with the status property of a Datafile.
`allocated_size_kb`	Gets the allocated_size_kb of this Datafile.
`free_space_kb`	Gets the free_space_kb of this Datafile.
`increment_by`	Gets the increment_by of this Datafile.
`instance_id`	Gets the instance_id of this Datafile.
`is_auto_extensible`	Gets the is_auto_extensible of this Datafile.
`lost_write_protect`	Gets the lost_write_protect of this Datafile.
`max_size_kb`	Gets the max_size_kb of this Datafile.
`name`	[Required] Gets the name of this Datafile.
`online_status`	Gets the online_status of this Datafile.
`shared`	Gets the shared of this Datafile.
`status`	Gets the status of this Datafile.
`used_percent_allocated`	Gets the used_percent_allocated of this Datafile.
`used_percent_available`	Gets the used_percent_available of this Datafile.
`used_space_kb`	Gets the used_space_kb of this Datafile.
`user_size_kb`	Gets the user_size_kb of this Datafile.

Methods

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

LOST_WRITE_PROTECT_ENABLED = 'ENABLED'¶: A constant which can be used with the lost_write_protect property of a Datafile. This constant has a value of “ENABLED”

LOST_WRITE_PROTECT_PROTECT_OFF = 'PROTECT_OFF'¶: A constant which can be used with the lost_write_protect property of a Datafile. This constant has a value of “PROTECT_OFF”

LOST_WRITE_PROTECT_SUSPEND = 'SUSPEND'¶: A constant which can be used with the lost_write_protect property of a Datafile. This constant has a value of “SUSPEND”

ONLINE_STATUS_OFFLINE = 'OFFLINE'¶: A constant which can be used with the online_status property of a Datafile. This constant has a value of “OFFLINE”

ONLINE_STATUS_ONLINE = 'ONLINE'¶: A constant which can be used with the online_status property of a Datafile. This constant has a value of “ONLINE”

ONLINE_STATUS_RECOVER = 'RECOVER'¶: A constant which can be used with the online_status property of a Datafile. This constant has a value of “RECOVER”

ONLINE_STATUS_SYSOFF = 'SYSOFF'¶: A constant which can be used with the online_status property of a Datafile. This constant has a value of “SYSOFF”

ONLINE_STATUS_SYSTEM = 'SYSTEM'¶: A constant which can be used with the online_status property of a Datafile. This constant has a value of “SYSTEM”

SHARED_LOCAL_FOR_ALL = 'LOCAL_FOR_ALL'¶: A constant which can be used with the shared property of a Datafile. This constant has a value of “LOCAL_FOR_ALL”

SHARED_LOCAL_FOR_RIM = 'LOCAL_FOR_RIM'¶: A constant which can be used with the shared property of a Datafile. This constant has a value of “LOCAL_FOR_RIM”

SHARED_SHARED = 'SHARED'¶: A constant which can be used with the shared property of a Datafile. This constant has a value of “SHARED”

STATUS_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the status property of a Datafile. This constant has a value of “AVAILABLE”

STATUS_INVALID = 'INVALID'¶: A constant which can be used with the status property of a Datafile. This constant has a value of “INVALID”

STATUS_OFFLINE = 'OFFLINE'¶: A constant which can be used with the status property of a Datafile. This constant has a value of “OFFLINE”

STATUS_ONLINE = 'ONLINE'¶: A constant which can be used with the status property of a Datafile. This constant has a value of “ONLINE”

STATUS_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the status property of a Datafile. This constant has a value of “UNKNOWN”

__init__(**kwargs)¶

Initializes a new Datafile 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 Datafile.
status (str) – The value to assign to the status property of this Datafile. Allowed values for this property are: “AVAILABLE”, “INVALID”, “OFFLINE”, “ONLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
online_status (str) – The value to assign to the online_status property of this Datafile. Allowed values for this property are: “SYSOFF”, “SYSTEM”, “OFFLINE”, “ONLINE”, “RECOVER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_auto_extensible (bool) – The value to assign to the is_auto_extensible property of this Datafile.
lost_write_protect (str) – The value to assign to the lost_write_protect property of this Datafile. Allowed values for this property are: “ENABLED”, “PROTECT_OFF”, “SUSPEND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
shared (str) – The value to assign to the shared property of this Datafile. Allowed values for this property are: “SHARED”, “LOCAL_FOR_RIM”, “LOCAL_FOR_ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
instance_id (float) – The value to assign to the instance_id property of this Datafile.
max_size_kb (float) – The value to assign to the max_size_kb property of this Datafile.
allocated_size_kb (float) – The value to assign to the allocated_size_kb property of this Datafile.
user_size_kb (float) – The value to assign to the user_size_kb property of this Datafile.
increment_by (float) – The value to assign to the increment_by property of this Datafile.
free_space_kb (float) – The value to assign to the free_space_kb property of this Datafile.
used_space_kb (float) – The value to assign to the used_space_kb property of this Datafile.
used_percent_available (float) – The value to assign to the used_percent_available property of this Datafile.
used_percent_allocated (float) – The value to assign to the used_percent_allocated property of this Datafile.

allocated_size_kb¶

Gets the allocated_size_kb of this Datafile. The allocated file size in KB.

Returns:	The allocated_size_kb of this Datafile.
Return type:	float

free_space_kb¶

Gets the free_space_kb of this Datafile. The free space available in the data file in KB.

Returns:	The free_space_kb of this Datafile.
Return type:	float

increment_by¶

Gets the increment_by of this Datafile. The number of blocks used as auto-extension increment.

Returns:	The increment_by of this Datafile.
Return type:	float

instance_id¶

Gets the instance_id of this Datafile. Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces.

Returns:	The instance_id of this Datafile.
Return type:	float

is_auto_extensible¶

Gets the is_auto_extensible of this Datafile. Indicates whether the data file is auto-extensible.

Returns:	The is_auto_extensible of this Datafile.
Return type:	bool

lost_write_protect¶

Gets the lost_write_protect of this Datafile. The lost write protection status of the file.

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

Returns:	The lost_write_protect of this Datafile.
Return type:	str

max_size_kb¶

Gets the max_size_kb of this Datafile. The maximum file size in KB.

Returns:	The max_size_kb of this Datafile.
Return type:	float

name¶

[Required] Gets the name of this Datafile. The filename (including the path) of the data file or temp file.

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

online_status¶

Gets the online_status of this Datafile. The online status of the file.

Allowed values for this property are: “SYSOFF”, “SYSTEM”, “OFFLINE”, “ONLINE”, “RECOVER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The online_status of this Datafile.
Return type:	str

shared¶

Gets the shared of this Datafile. Type of tablespace this file belongs to. If it’s for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types.

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

Returns:	The shared of this Datafile.
Return type:	str

status¶

Gets the status of this Datafile. The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed.

Allowed values for this property are: “AVAILABLE”, “INVALID”, “OFFLINE”, “ONLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this Datafile.
Return type:	str

used_percent_allocated¶

Gets the used_percent_allocated of this Datafile. The percentage of used space out of the total allocated space in the file.

Returns:	The used_percent_allocated of this Datafile.
Return type:	float

used_percent_available¶

Gets the used_percent_available of this Datafile. The percentage of used space out of the maximum available space in the file.

Returns:	The used_percent_available of this Datafile.
Return type:	float

used_space_kb¶

Gets the used_space_kb of this Datafile. The total space used in the data file in KB.

Returns:	The used_space_kb of this Datafile.
Return type:	float

user_size_kb¶

Gets the user_size_kb of this Datafile. The size of the file available for user data in KB. The actual size of the file minus the USER_BYTES value is used to store file-related metadata.

Returns:	The user_size_kb of this Datafile.
Return type:	float