Data Source: oci_nosql_table

This data source provides details about a specific Table resource in Oracle Cloud Infrastructure NoSQL Database service.

Get table info by identifier.

Example Usage

data "oci_nosql_table" "test_table" {
	#Required
	table_name_or_id = oci_nosql_table_name_or.test_table_name_or.id

	#Optional
	compartment_id = var.compartment_id
}

Argument Reference

The following arguments are supported:

• compartment_id - (Optional) The ID of a table’s compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
• table_name_or_id - (Required) A table name within the compartment, or a table OCID.

Attributes Reference

The following attributes are exported:

• compartment_id - Compartment Identifier.
• ddl_statement - A DDL statement representing the schema.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
• freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
• id - Unique identifier that is immutable.
• is_auto_reclaimable - True if this table can be reclaimed after an idle period.
• is_multi_region - True if this table is currently a member of a replication set.
• lifecycle_details - A message describing the current state in more detail.
• local_replica_initialization_in_percent - 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.
• name - Human-friendly table name, immutable.
• replicas - An array of Replica listing this table’s replicas, if any
  • capacity_mode - The capacity mode of the replica.
  • lifecycle_details - A message describing the current state in more detail.
  • max_write_units - Maximum sustained write throughput limit of the replica table.
  • region - A customer-facing region identifier
  • state - The state of the replica.
  • table_id - The OCID of the replica table
• schema - The table schema information as a JSON object.
  • columns - The columns of a table.
    • default_value - The column default value.
    • is_as_uuid - True if the STRING column was declared AS UUID.
    • is_generated - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
    • is_nullable - The column nullable flag.
    • name - The column name.
    • type - The column type.
  • identity - The identity properties of a table, if any.
    • column_name - The name of the identity column.
    • is_always - True if the identity value is GENERATED ALWAYS.
    • is_null - True if the identity value is GENERATED BY DEFAULT ON NULL.
  • primary_key - A list of column names that make up a key.
  • shard_key - A list of column names that make up a key.
  • ttl - The default Time-to-Live for the table, in days.
• schema_state - 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.
• state - The state of a table.
• system_tags - 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"}}
• table_limits - Throughput and storage limits configuration of a table.
  • capacity_mode - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
  • max_read_units - Maximum sustained read throughput limit for the table.
  • max_storage_in_gbs - Maximum size of storage used by the table.
  • max_write_units - Maximum sustained write throughput limit for the table.
• time_created - The time the the table was created. An RFC3339 formatted datetime string.
• time_of_expiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
• time_updated - The time the the table’s metadata was last updated. An RFC3339 formatted datetime string.