oracle.oci.oci_nosql_table – Manage a Table resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_nosql_table.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Table resource in Oracle Cloud Infrastructure

  • For state=present, create a new table.

  • This resource has the following action operations in the oracle.oci.oci_nosql_table_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
Compartment Identifier.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
ddl_statement
string
Complete CREATE TABLE DDL statement.
Required for create using state=present.
This parameter is updatable.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
is_auto_reclaimable
boolean
    Choices:
  • no
  • yes
True if table can be reclaimed after an idle period.
is_if_exists
boolean
    Choices:
  • no
  • yes
Set as true to select "if exists" behavior.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
name
string
Table name.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the Table.
Use state=present to create or update a Table.
Use state=absent to delete a Table.
table_limits
dictionary
This parameter is updatable.
capacity_mode
string
    Choices:
  • PROVISIONED
  • ON_DEMAND
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
integer / required
Maximum sustained read throughput limit for the table.
max_storage_in_g_bs
integer / required
Maximum size of storage used by the table.
max_write_units
integer / required
Maximum sustained write throughput limit for the table.
table_name_or_id
string
A table name within the compartment, or a table OCID.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create table
  oci_nosql_table:
    # required
    name: name_example
    ddl_statement: ddl_statement_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_auto_reclaimable: true
    table_limits:
      # required
      max_read_units: 56
      max_write_units: 56
      max_storage_in_g_bs: 56

      # optional
      capacity_mode: PROVISIONED
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update table
  oci_nosql_table:
    # required
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    ddl_statement: ddl_statement_example
    table_limits:
      # required
      max_read_units: 56
      max_write_units: 56
      max_storage_in_g_bs: 56

      # optional
      capacity_mode: PROVISIONED
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_nosql_table:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    ddl_statement: ddl_statement_example
    table_limits:
      # required
      max_read_units: 56
      max_write_units: 56
      max_storage_in_g_bs: 56

      # optional
      capacity_mode: PROVISIONED
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete table
  oci_nosql_table:
    # required
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    is_if_exists: true

- name: Delete table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_nosql_table:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
table
complex
on success
Details of the Table resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'ddl_statement': 'ddl_statement_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_auto_reclaimable': True, 'is_multi_region': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'local_replica_initialization_in_percent': 56, 'name': 'name_example', 'replicas': [{'capacity_mode': 'PROVISIONED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'max_write_units': 56, 'region': 'us-phoenix-1', 'table_id': 'ocid1.table.oc1..xxxxxxEXAMPLExxxxxx'}], 'schema': {'columns': [{'default_value': 'default_value_example', 'is_as_uuid': True, 'is_generated': True, 'is_nullable': True, 'name': 'name_example', 'type': 'type_example'}], 'identity': {'column_name': 'column_name_example', 'is_always': True, 'is_null': True}, 'primary_key': [], 'shard_key': [], 'ttl': 56}, 'schema_state': 'MUTABLE', 'system_tags': {}, 'table_limits': {'capacity_mode': 'PROVISIONED', 'max_read_units': 56, 'max_storage_in_g_bs': 56, 'max_write_units': 56}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_of_expiration': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
Compartment Identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
ddl_statement
string
on success
A DDL statement representing the schema.

Sample:
ddl_statement_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier that is immutable.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_auto_reclaimable
boolean
on success
True if this table can be reclaimed after an idle period.

Sample:
True
 
is_multi_region
boolean
on success
True if this table is currently a member of a replication set.

Sample:
True
 
lifecycle_details
string
on success
A message describing the current state in more detail.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The state of a table.

Sample:
CREATING
 
local_replica_initialization_in_percent
integer
on success
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.

Sample:
56
 
name
string
on success
Human-friendly table name, immutable.

Sample:
name_example
 
replicas
complex
on success
An array of Replica listing this table's replicas, if any
   
capacity_mode
string
on success
The capacity mode of the replica.

Sample:
PROVISIONED
   
lifecycle_details
string
on success
A message describing the current state in more detail.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The state of the replica.

Sample:
CREATING
   
max_write_units
integer
on success
Maximum sustained write throughput limit of the replica table.

Sample:
56
   
region
string
on success
A customer-facing region identifier

Sample:
us-phoenix-1
   
table_id
string
on success
The OCID of the replica table

Sample:
ocid1.table.oc1..xxxxxxEXAMPLExxxxxx
 
schema
complex
on success

   
columns
complex
on success
The columns of a table.
     
default_value
string
on success
The column default value.

Sample:
default_value_example
     
is_as_uuid
boolean
on success
True if the STRING column was declared AS UUID.

Sample:
True
     
is_generated
boolean
on success
True if the STRING AS UUID column is also GENERATED BY DEFAULT.

Sample:
True
     
is_nullable
boolean
on success
The column nullable flag.

Sample:
True
     
name
string
on success
The column name.

Sample:
name_example
     
type
string
on success
The column type.

Sample:
type_example
   
identity
complex
on success

     
column_name
string
on success
The name of the identity column.

Sample:
column_name_example
     
is_always
boolean
on success
True if the identity value is GENERATED ALWAYS.

Sample:
True
     
is_null
boolean
on success
True if the identity value is GENERATED BY DEFAULT ON NULL.

Sample:
True
   
primary_key
list / elements=string
on success
A list of column names that make up a key.
   
shard_key
list / elements=string
on success
A list of column names that make up a key.
   
ttl
integer
on success
The default Time-to-Live for the table, in days.

Sample:
56
 
schema_state
string
on success
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.

Sample:
MUTABLE
 
system_tags
dictionary
on success
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
complex
on success

   
capacity_mode
string
on success
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.

Sample:
PROVISIONED
   
max_read_units
integer
on success
Maximum sustained read throughput limit for the table.

Sample:
56
   
max_storage_in_g_bs
integer
on success
Maximum size of storage used by the table.

Sample:
56
   
max_write_units
integer
on success
Maximum sustained write throughput limit for the table.

Sample:
56
 
time_created
string
on success
The time the the table was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_expiration
string
on success
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)