Optional Readonly compartmentCloud service only. Compartment id of the table.
Optional Readonly definedCloud service only. Defined tags associated with the table. See DefinedTags.
Optional Readonly etagCloud service only. Entity tag associated with the table. See TableETag.
Optional Readonly freeCloud Service only. Free-form tags associated with the table. See FreeFormTags.
Optional Readonly isCloud Service only. If this table is a replica, indicates whether its initialization process has been completed. The initialization process starts after the replica table is created and involves copying of the table data from the sender region to the receiver region. For more information, see Global Active Tables in NDCS. This value is true if the table is a replica and its initialization process has been completed, otherwise it is false.
Optional Readonly isCloud Service only. Indicates whether the table has replicas, that is whether it is a Global Active table. For more information, see Global Active Tables in NDCS.
Optional Readonly isCloud Service only. Indicates whether or not the table's schema is frozen. Frozen schema is required for Global Active tables. For more information, see Global Active Tables in NDCS.
Optional Readonly namespaceOn-premise NoSQL database only. The namespace of the table.
Optional Readonly operationOperation id of the operation that returned this result, if this result is returned by tableDDL, setTableLimits or setTableTags methods. It is used when the TableResult is subsequently passed to forCompletion or getTable as the first parameter to identify the operation and check for any errors from that operation. This value is undefined if the request did not generate a new operation.
Optional Readonly replicasCloud Service only. An array containing information for each replica, if this table is replicated (Global Active Table), otherwise undefined. For more information, see Global Active Tables in NDCS.
Optional Readonly schemaTable schema, in JSON format, if available.
Optional Readonly tableDDLDDL (CREATE TABLE) statement used to create this table if available. If the table has been altered since initial creation, the statement is also altered to reflect the current table schema. This value, when defined, is functionally equivalent to the schema returned by schema. The most reliable way to get the DDL statement is by using getTable on an existing table.
Optional Readonly tableCloud service only. Table limits, see TableLimits
Readonly tableTable name.
Optional Readonly tableOCIDCloud service only. The OCID of the table.
Readonly tableCurrent table state, see TableState.
Generated using TypeDoc
TableResult object is the result of tableDDL, setTableLimits, getTable and and may also be the result of forCompletion method. It encapsulates the state of the table that is the target of the operation.
Operations performed by tableDDL such as table creation, modification, and drop are potentially long running and not necessarily completed when tableDDL returns result and the table may still be in one of its intermediate states. You may call forCompletion to be notified when the operation completes and the table reaches desired state (which, depending on the operation, would be either ACTIVE or DROPPED. You may also call getTable to receive static information about the table as well as its current state.