Class TableResult
Namespace: Oracle.NoSQL.SDK
Assembly: Oracle.NoSQL.SDK.dll
Syntax
public class TableResult : Object
Remarks
This is the result of APIs ExecuteTableDDLAsync, ExecuteTableDDLWithCompletionAsync, SetTableLimitsAsync(String, TableLimits, TableDDLOptions, CancellationToken), SetTableLimitsWithCompletionAsync(String, TableLimits, TableDDLOptions, CancellationToken), GetTableAsync, as well as WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) and WaitForTableStateAsync(String, TableState, TableCompletionOptions, CancellationToken). It encapsulates the state of the table that is the target of the operation.
Table DDL operations performed by ExecuteTableDDLAsync and SetTableLimitsAsync(String, TableLimits, TableDDLOptions, CancellationToken) such as table creation, modification, and drop are potentially long-running and not necessarily completed when these methods return result and the table may still be in one of its intermediate states. You may call WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) to be notified when the operation completes and the table reaches desired state (which, depending on the operation, would be either Active or Dropped.
Alternatively you may use ExecuteTableDDLWithCompletionAsync or SetTableLimitsWithCompletionAsync(String, TableLimits, TableDDLOptions, CancellationToken) which will return the result only when the DDL operation is fully completed. You may also call GetTableAsync(String, GetTableOptions, CancellationToken) to receive static information about the table as well as its current state.
Properties
Name | Description |
---|---|
CompartmentId | Cloud Service only. Gets the compartment id of the table. |
DefinedTags | Gets defined tags associated with this table. |
ETag | Cloud Service only. Gets the entity tag associated with the table. |
FreeFormTags | Gets free-form tags associated with this table. |
IsLocalReplicaInitialized | Cloud Service only. Gets a value indicating whether this table is a replica and its initialization process has been completed. |
IsReplicated | Cloud Service only. Gets a value indicating whether the table has replicas, that is whether it is a Global Active table. |
IsSchemaFrozen | Cloud Service only. Gets a value indicating whether the table's schema is frozen. |
Namespace | On-premise NoSQL database only. Gets the namespace of the table. |
Replicas | Cloud Service only. Gets a list containing information for each replica, if this table is replicated (i.e. Global Active Table). |
TableDDL | Gets the DDL (CREATE TABLE) statement used to create this table if available. |
TableLimits | Gets the throughput and capacity limits for the table. |
TableName | Gets the name of the table. |
TableOCID | Cloud Service only. Gets the OCID of the table. |
TableSchema | Gets the table schema. |
TableState | Gets the current table state. |
Methods
Name | Description |
---|---|
WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) | Asynchronously waits for completion of table DDL operations. |