oracle.oci.oci_nosql_row – Manage a Row resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

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
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.
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.
identity_cache_size
integer
Sets the number of generated identity values that are requested from the server during a put. If present and greater than 0, this value takes precedence over a default value for the table.
This parameter is updatable.
is_exact_match
boolean
    Choices:
  • no
  • yes
If present and true, the presented row value must exactly match the table's schema. Otherwise, rows with missing non-key fields or extra fields can be written successfully.
This parameter is updatable.
is_get_return_row
boolean
    Choices:
  • no
  • yes
If true, and the put fails due to an option setting, then the existing row will be returned.
This parameter is updatable.
is_ttl_use_table_default
boolean
    Choices:
  • no
  • yes
If true, set time-to-live for this row to the table's default.
This parameter is updatable.
key
list / elements=string
An array of strings, each of the format "column-name:value", representing the primary key of the row.
Required for delete using state=absent.
option
string
    Choices:
  • IF_ABSENT
  • IF_PRESENT
Specifies a condition for the put operation.
This parameter is updatable.
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 Row.
Use state=present to update an existing a Row.
Use state=absent to delete a Row.
table_name_or_id
string / required
A table name within the compartment, or a table OCID.

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
timeout_in_ms
integer
Timeout setting for the put.
This parameter is updatable.
ttl
integer
Time-to-live for the row, in days.
This parameter is updatable.
value
dictionary
The map of values from a row.
Required for update using state=present with table_name_or_id present.

Examples

- name: Update row
  oci_nosql_row:
    # required
    value: null
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    option: IF_ABSENT
    ttl: 56
    is_ttl_use_table_default: true
    identity_cache_size: 56
    is_exact_match: true
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    is_get_return_row: true
    timeout_in_ms: 56

- name: Delete row
  oci_nosql_row:
    # required
    table_name_or_id: "ocid1.tablenameor.oc1..xxxxxxEXAMPLExxxxxx"
    key: [ "key_example" ]
    state: absent

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    is_get_return_row: true
    timeout_in_ms: 56

Return Values

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

Key Returned Description
row
complex
on success
Details of the Row resource acted upon by the current operation

Sample:
{'existing_value': {}, 'existing_version': 'existing_version_example', 'generated_value': 'generated_value_example', 'is_success': True, 'usage': {'read_units_consumed': 56, 'write_units_consumed': 56}, 'version': 'version_example'}
 
existing_value
dictionary
on success
The map of values from a row.
 
existing_version
string
on success
The version string associated with the existing row. Returned if the put fails due to options setting in the request.

Sample:
existing_version_example
 
generated_value
string
on success
The value generated if the operation created a new value for an identity column. If the table has no identity column, this value is null. If it has an identity column, and a value was generated for that column, it is non-null.

Sample:
generated_value_example
 
is_success
boolean
on success
Convey the success or failure of the operation.

Sample:
True
 
usage
complex
on success

   
read_units_consumed
integer
on success
Read Units consumed by this operation.

Sample:
56
   
write_units_consumed
integer
on success
Write Units consumed by this operation.

Sample:
56
 
version
string
on success
An opaque version string associated with the row.

Sample:
version_example


Authors

  • Oracle (@oracle)