oracle.oci.oci_nosql_index – Manage an Index resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_index.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and delete an Index resource in Oracle Cloud Infrastructure

  • For state=present, create a new index on the table identified by tableNameOrId.

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
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
The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.
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.
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.
is_if_exists
boolean
    Choices:
  • no
  • yes
Set as true to select "if exists" behavior.
is_if_not_exists
boolean
    Choices:
  • no
  • yes
If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error.
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.
keys
list / elements=dictionary
A set of keys for a secondary index.
Required for create using state=present.
column_name
string / required
The name of a column to be included as an index key.
json_field_type
string
If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.
json_path
string
If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.
name
string / required
Index name.
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 Index.
Use state=present to create an Index.
Use state=absent to delete an Index.
table_name_or_id
string / required
A table name within the compartment, or a table OCID.
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 index
  oci_nosql_index:
    # required
    keys:
    - # required
      column_name: column_name_example

      # optional
      json_path: json_path_example
      json_field_type: json_field_type_example
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

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

- name: Delete index
  oci_nosql_index:
    # required
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

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

Return Values

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

Key Returned Description
index
complex
on success
Details of the Index resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'keys': [{'column_name': 'column_name_example', 'json_field_type': 'json_field_type_example', 'json_path': 'json_path_example'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'table_id': 'ocid1.table.oc1..xxxxxxEXAMPLExxxxxx', 'table_name': 'table_name_example'}
 
compartment_id
string
on success
Compartment Identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
keys
complex
on success
A set of keys for a secondary index.

   
column_name
string
on success
The name of a column to be included as an index key.

Sample:
column_name_example
   
json_field_type
string
on success
If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.

Sample:
json_field_type_example
   
json_path
string
on success
If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.

Sample:
json_path_example
 
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 an index.

Sample:
CREATING
 
name
string
on success
Index name.

Sample:
name_example
 
table_id
string
on success
the OCID of the table to which this index belongs.

Sample:
ocid1.table.oc1..xxxxxxEXAMPLExxxxxx
 
table_name
string
on success
The name of the table to which this index belongs.

Sample:
table_name_example


Authors

  • Oracle (@oracle)