nosql.oracle.com/v1beta1
Back to API Reference
APIVersion: nosql.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
| Package |
Support |
Latest release |
Resources |
| NoSQL |
preview |
v2.0.0-alpha |
Table |
Resources
| Kind |
Scope |
Sample |
Packages |
| Table |
Namespaced |
Sample |
NoSQL (v2.0.0-alpha) |
Table
Manage OCI NoSQL tables.
Plural: tablesScope: NamespacedAPIVersion: nosql.oracle.com/v1beta1Sample: Sample (config/samples/nosql_v1beta1_table.yaml)Packages: NoSQL (v2.0.0-alpha)
Spec
TableSpec defines the desired state of Table.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
Compartment Identifier. |
string |
Yes |
- |
- |
ddlStatement |
Complete CREATE TABLE DDL statement. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
isAutoReclaimable |
True if table can be reclaimed after an idle period. |
boolean |
No |
- |
- |
name |
Table name. |
string |
Yes |
- |
- |
tableLimits |
TableLimits defines nested fields for Table.TableLimits. |
object |
No |
- |
- |
Spec.tableLimits
Back to Table spec
TableLimits defines nested fields for Table.TableLimits.
| Field |
Description |
Type |
Required |
Default |
Enum |
capacityMode |
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. |
string |
No |
- |
- |
maxReadUnits |
Maximum sustained read throughput limit for the table. |
integer |
Yes |
- |
- |
maxStorageInGBs |
Maximum size of storage used by the table. |
integer |
Yes |
- |
- |
maxWriteUnits |
Maximum sustained write throughput limit for the table. |
integer |
Yes |
- |
- |
Status
TableStatus defines the observed state of Table.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
Compartment Identifier. |
string |
No |
- |
- |
ddlStatement |
A DDL statement representing the schema. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
Unique identifier that is immutable. |
string |
No |
- |
- |
isAutoReclaimable |
True if this table can be reclaimed after an idle period. |
boolean |
No |
- |
- |
isMultiRegion |
True if this table is currently a member of a replication set. |
boolean |
No |
- |
- |
lifecycleDetails |
A message describing the current state in more detail. |
string |
No |
- |
- |
lifecycleState |
The state of a table. |
string |
No |
- |
- |
localReplicaInitializationInPercent |
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. |
integer |
No |
- |
- |
name |
Human-friendly table name, immutable. |
string |
No |
- |
- |
replicas |
An array of Replica listing this table's replicas, if any |
list[object] |
No |
- |
- |
schema |
TableSchema defines nested fields for Table.Schema. |
object |
No |
- |
- |
schemaState |
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. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
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"}} |
map[string, map[string, string]] |
No |
- |
- |
tableLimits |
TableLimits defines nested fields for Table.TableLimits. |
object |
No |
- |
- |
timeCreated |
The time the the table was created. An RFC3339 formatted datetime string. |
string |
No |
- |
- |
timeOfExpiration |
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string. |
string |
No |
- |
- |
timeUpdated |
The time the the table's metadata was last updated. An RFC3339 formatted datetime string. |
string |
No |
- |
- |
Status.replicas[]
Back to Table status
TableReplica defines nested fields for Table.Replica.
| Field |
Description |
Type |
Required |
Default |
Enum |
capacityMode |
The capacity mode of the replica. |
string |
No |
- |
- |
lifecycleDetails |
A message describing the current state in more detail. |
string |
No |
- |
- |
lifecycleState |
The state of the replica. |
string |
No |
- |
- |
maxWriteUnits |
Maximum sustained write throughput limit of the replica table. |
integer |
No |
- |
- |
region |
A customer-facing region identifier |
string |
No |
- |
- |
tableId |
The OCID of the replica table |
string |
No |
- |
- |
Status.schema
Back to Table status
TableSchema defines nested fields for Table.Schema.
| Field |
Description |
Type |
Required |
Default |
Enum |
columns |
The columns of a table. |
list[object] |
No |
- |
- |
identity |
TableSchemaIdentity defines nested fields for Table.Schema.Identity. |
object |
No |
- |
- |
primaryKey |
A list of column names that make up a key. |
list[string] |
No |
- |
- |
shardKey |
A list of column names that make up a key. |
list[string] |
No |
- |
- |
ttl |
The default Time-to-Live for the table, in days. |
integer |
No |
- |
- |
Status.schema.columns[]
Back to Table status
TableSchemaColumn defines nested fields for Table.Schema.Column.
| Field |
Description |
Type |
Required |
Default |
Enum |
defaultValue |
The column default value. |
string |
No |
- |
- |
isAsUuid |
True if the STRING column was declared AS UUID. |
boolean |
No |
- |
- |
isGenerated |
True if the STRING AS UUID column is also GENERATED BY DEFAULT. |
boolean |
No |
- |
- |
isNullable |
The column nullable flag. |
boolean |
No |
- |
- |
name |
The column name. |
string |
No |
- |
- |
type |
The column type. |
string |
No |
- |
- |
Status.schema.identity
Back to Table status
TableSchemaIdentity defines nested fields for Table.Schema.Identity.
| Field |
Description |
Type |
Required |
Default |
Enum |
columnName |
The name of the identity column. |
string |
No |
- |
- |
isAlways |
True if the identity value is GENERATED ALWAYS. |
boolean |
No |
- |
- |
isNull |
True if the identity value is GENERATED BY DEFAULT ON NULL. |
boolean |
No |
- |
- |
Status.status
Back to Table status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to Table status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to Table status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to Table status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Status.tableLimits
Back to Table status
TableLimits defines nested fields for Table.TableLimits.
| Field |
Description |
Type |
Required |
Default |
Enum |
capacityMode |
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. |
string |
No |
- |
- |
maxReadUnits |
Maximum sustained read throughput limit for the table. |
integer |
Yes |
- |
- |
maxStorageInGBs |
Maximum size of storage used by the table. |
integer |
Yes |
- |
- |
maxWriteUnits |
Maximum sustained write throughput limit for the table. |
integer |
Yes |
- |
- |