Table¶

class oci.nosql.models.Table(**kwargs)¶

Bases: object

Complete metadata about a table.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Table.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Table.
`SCHEMA_STATE_FROZEN`	A constant which can be used with the schema_state property of a Table.
`SCHEMA_STATE_MUTABLE`	A constant which can be used with the schema_state property of a Table.
`compartment_id`	[Required] Gets the compartment_id of this Table.
`ddl_statement`	Gets the ddl_statement of this Table.
`defined_tags`	Gets the defined_tags of this Table.
`freeform_tags`	Gets the freeform_tags of this Table.
`id`	[Required] Gets the id of this Table.
`is_auto_reclaimable`	Gets the is_auto_reclaimable of this Table.
`is_multi_region`	Gets the is_multi_region of this Table.
`lifecycle_details`	Gets the lifecycle_details of this Table.
`lifecycle_state`	Gets the lifecycle_state of this Table.
`local_replica_initialization_in_percent`	Gets the local_replica_initialization_in_percent of this Table.
`name`	Gets the name of this Table.
`replicas`	Gets the replicas of this Table.
`schema`	Gets the schema of this Table.
`schema_state`	Gets the schema_state of this Table.
`system_tags`	Gets the system_tags of this Table.
`table_limits`	Gets the table_limits of this Table.
`time_created`	Gets the time_created of this Table.
`time_of_expiration`	Gets the time_of_expiration of this Table.
`time_updated`	Gets the time_updated of this Table.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Table. This constant has a value of “UPDATING”

SCHEMA_STATE_FROZEN = 'FROZEN'¶: A constant which can be used with the schema_state property of a Table. This constant has a value of “FROZEN”

SCHEMA_STATE_MUTABLE = 'MUTABLE'¶: A constant which can be used with the schema_state property of a Table. This constant has a value of “MUTABLE”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this Table.
name (str) – The value to assign to the name property of this Table.
compartment_id (str) – The value to assign to the compartment_id property of this Table.
time_created (datetime) – The value to assign to the time_created property of this Table.
time_updated (datetime) – The value to assign to the time_updated property of this Table.
table_limits (oci.nosql.models.TableLimits) – The value to assign to the table_limits property of this Table.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Table. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_auto_reclaimable (bool) – The value to assign to the is_auto_reclaimable property of this Table.
time_of_expiration (datetime) – The value to assign to the time_of_expiration property of this Table.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Table.
schema (oci.nosql.models.Schema) – The value to assign to the schema property of this Table.
ddl_statement (str) – The value to assign to the ddl_statement property of this Table.
schema_state (str) – The value to assign to the schema_state property of this Table. Allowed values for this property are: “MUTABLE”, “FROZEN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_multi_region (bool) – The value to assign to the is_multi_region property of this Table.
local_replica_initialization_in_percent (int) – The value to assign to the local_replica_initialization_in_percent property of this Table.
replicas (list[oci.nosql.models.Replica]) – The value to assign to the replicas property of this Table.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Table.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Table.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Table.

compartment_id¶

[Required] Gets the compartment_id of this Table. Compartment Identifier.

Returns:	The compartment_id of this Table.
Return type:	str

ddl_statement¶

Gets the ddl_statement of this Table. A DDL statement representing the schema.

Returns:	The ddl_statement of this Table.
Return type:	str

defined_tags¶

Gets the defined_tags of this Table. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this Table.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this Table. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this Table.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Table. Unique identifier that is immutable.

Returns:	The id of this Table.
Return type:	str

is_auto_reclaimable¶

Gets the is_auto_reclaimable of this Table. True if this table can be reclaimed after an idle period.

Returns:	The is_auto_reclaimable of this Table.
Return type:	bool

is_multi_region¶

Gets the is_multi_region of this Table. True if this table is currently a member of a replication set.

Returns:	The is_multi_region of this Table.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this Table. A message describing the current state in more detail.

Returns:	The lifecycle_details of this Table.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this Table. The state of a table.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Table.
Return type:	str

local_replica_initialization_in_percent¶

Gets the local_replica_initialization_in_percent of this Table. If this table is in a replication set, this value represents the progress of the initialization of the replica’s data. A value of 100 indicates that initialization has completed.

Returns:	The local_replica_initialization_in_percent of this Table.
Return type:	int

name¶

Gets the name of this Table. Human-friendly table name, immutable.

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

replicas¶

Gets the replicas of this Table. An array of Replica listing this table’s replicas, if any

Returns:	The replicas of this Table.
Return type:	list[oci.nosql.models.Replica]

schema¶

Gets the schema of this Table.

Returns:	The schema of this Table.
Return type:	oci.nosql.models.Schema

schema_state¶

Gets the schema_state of this Table. The current state of this table’s schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.

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

Returns:	The schema_state of this Table.
Return type:	str

system_tags¶

Gets the system_tags of this Table. Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is “orcl-cloud”; and the only key in that namespace is “free-tier-retained”. Example: {“orcl-cloud””: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this Table.
Return type:	dict(str, dict(str, object))

table_limits¶

Gets the table_limits of this Table.

Returns:	The table_limits of this Table.
Return type:	oci.nosql.models.TableLimits

time_created¶

Gets the time_created of this Table. The time the the table was created. An RFC3339 formatted datetime string.

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

time_of_expiration¶

Gets the time_of_expiration of this Table. If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.

Returns:	The time_of_expiration of this Table.
Return type:	datetime

time_updated¶

Gets the time_updated of this Table. The time the the table’s metadata was last updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this Table.
Return type:	datetime