IndexKey

class oci.nosql.models.IndexKey(**kwargs)

Bases: object

Specifies a single key in a secondary index.

Methods:

__init__(**kwargs)

Initializes a new IndexKey object with values from keyword arguments.

Attributes:

column_name

[Required] Gets the column_name of this IndexKey.

json_field_type

Gets the json_field_type of this IndexKey.

json_path

Gets the json_path of this IndexKey.

__init__(**kwargs)

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

Parameters
  • column_name (str) – The value to assign to the column_name property of this IndexKey.

  • json_path (str) – The value to assign to the json_path property of this IndexKey.

  • json_field_type (str) – The value to assign to the json_field_type property of this IndexKey.

property column_name

[Required] Gets the column_name of this IndexKey. The name of a column to be included as an index key.

Returns

The column_name of this IndexKey.

Return type

str

property json_field_type

Gets the json_field_type of this IndexKey. If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.

Returns

The json_field_type of this IndexKey.

Return type

str

property json_path

Gets the json_path of this IndexKey. 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.

Returns

The json_path of this IndexKey.

Return type

str