Schema¶
-
class
oci.nosql.models.
Schema
(**kwargs)¶ Bases:
object
The table schema information as a JSON object.
Methods
__init__
(**kwargs)Initializes a new Schema object with values from keyword arguments. Attributes
columns
[Required] Gets the columns of this Schema. identity
Gets the identity of this Schema. primary_key
[Required] Gets the primary_key of this Schema. shard_key
[Required] Gets the shard_key of this Schema. ttl
[Required] Gets the ttl of this Schema. -
__init__
(**kwargs)¶ Initializes a new Schema object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - columns (list[oci.nosql.models.Column]) – The value to assign to the columns property of this Schema.
- primary_key (list[str]) – The value to assign to the primary_key property of this Schema.
- shard_key (list[str]) – The value to assign to the shard_key property of this Schema.
- ttl (int) – The value to assign to the ttl property of this Schema.
- identity (oci.nosql.models.Identity) – The value to assign to the identity property of this Schema.
-
columns
¶ [Required] Gets the columns of this Schema. The columns of a table.
Returns: The columns of this Schema. Return type: list[oci.nosql.models.Column]
-
identity
¶ Gets the identity of this Schema.
Returns: The identity of this Schema. Return type: oci.nosql.models.Identity
-
primary_key
¶ [Required] Gets the primary_key of this Schema. A list of column names that make up a key.
Returns: The primary_key of this Schema. Return type: list[str]
-
shard_key
¶ [Required] Gets the shard_key of this Schema. A list of column names that make up a key.
Returns: The shard_key of this Schema. Return type: list[str]
-
ttl
¶ [Required] Gets the ttl of this Schema. The default Time-to-Live for the table, in days.
Returns: The ttl of this Schema. Return type: int
-