# The OnlineTable object

Online Table information.

## Attributes

- `name` (string, Public Preview)
  Full three-part (catalog, schema, table) name of the table.
- `spec` (object, Public Preview)
  Specification of the online table.
  - `run_continuously` (object, Public Preview)
    Pipeline runs continuously after generating the initial data.
  - `run_triggered` (object, Public Preview)
    Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers)
  - `source_table_full_name` (string, Public Preview)
    Three-part (catalog, schema, table) name of the source Delta table.
  - `primary_key_columns` (array of string, Public Preview)
    Primary Key columns to be used for data insert/update in the destination.
  - `timeseries_key` (string, Public Preview)
    Time series key to deduplicate (tie-break) rows with the same primary key.
  - `perform_full_copy` (boolean, Public Preview)
    Whether to create a full-copy pipeline -- a pipeline that stops after creates a full copy of
     the source table upon initialization and does not process any change data feeds (CDFs)
     afterwards. The pipeline can still be manually triggered afterwards, but it always perform a
     full copy of the source table and there are no incremental updates. This mode is useful for
     syncing views or tables without CDFs to online tables.
     Note that the full-copy pipeline only supports "triggered" scheduling policy.
    Default: `false`
  - `pipeline_id` (string, Public Preview)
    ID of the associated pipeline. Generated by the server - cannot be set by the caller.
- `status` (object, Public Preview)
  Online Table data synchronization status
  - `detailed_state` (string, Public Preview)
    The state of the online table.
    Possible values: `ONLINE_TABLE_STATE_UNSPECIFIED`, `PROVISIONING`, `PROVISIONING_PIPELINE_RESOURCES`, `PROVISIONING_INITIAL_SNAPSHOT`, `ONLINE`, `ONLINE_CONTINUOUS_UPDATE`, `ONLINE_TRIGGERED_UPDATE`, `ONLINE_NO_PENDING_UPDATE`, `OFFLINE`, `OFFLINE_FAILED`, `ONLINE_PIPELINE_FAILED`, `ONLINE_UPDATING_PIPELINE_RESOURCES`
  - `message` (string, Public Preview)
    A text description of the current state of the online table.
  - `provisioning_status` (object, Public Preview)
    - `initial_pipeline_sync_progress` (object, Public Preview)
      Details about initial data synchronization. Only populated when in the
       PROVISIONING_INITIAL_SNAPSHOT state.
      - `latest_version_currently_processing` (int64, Public Preview)
        The source table Delta version that was last processed by the pipeline. The pipeline may not
         have completely processed this version yet.
      - `synced_row_count` (int64, Public Preview)
        The number of rows that have been synced in this update.
      - `total_row_count` (int64, Public Preview)
        The total number of rows that need to be synced in this update. This number may be an estimate.
      - `sync_progress_completion` (double, Public Preview)
        The completion ratio of this update. This is a number between 0 and 1.
      - `estimated_completion_time_seconds` (double, Public Preview)
        The estimated time remaining to complete this update in seconds.
  - `continuous_update_status` (object, Public Preview)
    - `last_processed_commit_version` (int64, Public Preview)
      The last source table Delta version that was synced to the online table. Note that this Delta
       version may not be completely synced to the online table yet.
    - `timestamp` (string, Public Preview)
      The timestamp of the last time any data was synchronized from the source table to the online
       table.
    - `initial_pipeline_sync_progress` (object, Public Preview)
      Progress of the initial data synchronization.
      - `latest_version_currently_processing` (int64, Public Preview)
        The source table Delta version that was last processed by the pipeline. The pipeline may not
         have completely processed this version yet.
      - `synced_row_count` (int64, Public Preview)
        The number of rows that have been synced in this update.
      - `total_row_count` (int64, Public Preview)
        The total number of rows that need to be synced in this update. This number may be an estimate.
      - `sync_progress_completion` (double, Public Preview)
        The completion ratio of this update. This is a number between 0 and 1.
      - `estimated_completion_time_seconds` (double, Public Preview)
        The estimated time remaining to complete this update in seconds.
  - `triggered_update_status` (object, Public Preview)
    - `last_processed_commit_version` (int64, Public Preview)
      The last source table Delta version that was synced to the online table. Note that this Delta
       version may not be completely synced to the online table yet.
    - `timestamp` (string, Public Preview)
      The timestamp of the last time any data was synchronized from the source table to the online
       table.
    - `triggered_update_progress` (object, Public Preview)
      Progress of the active data synchronization pipeline.
      - `latest_version_currently_processing` (int64, Public Preview)
        The source table Delta version that was last processed by the pipeline. The pipeline may not
         have completely processed this version yet.
      - `synced_row_count` (int64, Public Preview)
        The number of rows that have been synced in this update.
      - `total_row_count` (int64, Public Preview)
        The total number of rows that need to be synced in this update. This number may be an estimate.
      - `sync_progress_completion` (double, Public Preview)
        The completion ratio of this update. This is a number between 0 and 1.
      - `estimated_completion_time_seconds` (double, Public Preview)
        The estimated time remaining to complete this update in seconds.
  - `failed_status` (object, Public Preview)
    - `last_processed_commit_version` (int64, Public Preview)
      The last source table Delta version that was synced to the online table. Note that this Delta
       version may only be partially synced to the online table. Only populated if the table is still
       online and available for serving.
    - `timestamp` (string, Public Preview)
      The timestamp of the last time any data was synchronized from the source table to the online
       table. Only populated if the table is still online and available for serving.
- `table_serving_url` (string, Public Preview)
  Data serving REST API URL for this table
- `unity_catalog_provisioning_state` (string, Public Preview)
  The provisioning state of the online table entity in Unity Catalog. This is distinct from the
   state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline
   may be in "PROVISIONING" as it runs asynchronously).
  Possible values: `STATE_UNSPECIFIED`, `PROVISIONING`, `ACTIVE`, `FAILED`, `DELETING`, `UPDATING`, `DEGRADED`

## Example

```json
{
  "name": "string",
  "spec": {
    "run_continuously": {},
    "run_triggered": {},
    "source_table_full_name": "string",
    "primary_key_columns": [
      "string"
    ],
    "timeseries_key": "string",
    "perform_full_copy": true,
    "pipeline_id": "string"
  },
  "status": {
    "detailed_state": "string",
    "message": "string",
    "provisioning_status": {},
    "continuous_update_status": {},
    "triggered_update_status": {},
    "failed_status": {}
  },
  "table_serving_url": "string",
  "unity_catalog_provisioning_state": "string"
}
```