KEkeboola
Workspaces

Load data

Loads tables from Storage into a Workspace. BigQuery supports only loading as view.

Each input item maps a source table (source, or dataFileId for file workspaces) to a destination table in the workspace. Optional per-item settings allow limiting rows (rows, changedSince, changedUntil, whereFilters), selecting and typing columns (columns), incremental loading (incremental), overwriting existing tables when preserve is set (overwrite), defining a primary key (primaryKey, Snowflake only) and selecting the load type.

loadType: default COPY. Use AUTO to let Storage API decide the best load type. Copy is used always when filters, columns, or incremental are set. CLONE is supported on Snowflake and BigQuery backends and accepts only source, destination, overwrite and dropTimestampColumn options; it is not supported with incremental loading or for linked buckets on BigQuery. VIEW is experimental for Snowflake (requires feature input-mapping-read-only-storage, aliases are not supported) and works on BigQuery without a feature (aliases are not supported); a view is created in the workspace instead of loading the table (accepts only source, destination and overwrite).

whereColumn, whereValues, whereOperator and seconds are deprecated; use whereFilters, changedSince and changedUntil instead.

The load runs as an asynchronous workspaceLoad job.

post/v2/storage/workspaces/{workspaceId}/load

Request

Path parameters

workspaceIdinteger required

ID of the workspace.

Request body

preserveboolean

Whether to keep tables already present in the workspace that are not part of this load.

Response

Workspace load job enqueued.

idstring required

Job ID.

statusstring required

Current status of the job.

urlstring required

API detail URL for the job.

tableIdstring nullable required

ID of the table affected by the job.

operationNamestring required

Type of operation performed.

operationParamsobject required

Parameters for the operation.

createdTimestring date-time required

Job creation timestamp.

startTimestring date-time nullable required

Job start timestamp.

endTimestring date-time nullable required

Job end timestamp.

runIdstring nullable required

Run ID for the job.

Example response

{
  "id": "22077337",
  "status": "waiting",
  "url": "https://connection.keboola.com/v2/storage/jobs/22077337",
  "tableId": null,
  "operationName": "workspaceLoad",
  "operationParams": {
    "workspaceId": "78423",
    "preserve": false,
    "input": [
      {
        "source": "in.c-application-testing.cashier-data",
        "destination": "my-table"
      }
    ],
    "queue": "main_fast"
  },
  "createdTime": "2017-02-13T16:41:18+0100",
  "startTime": null,
  "endTime": null,
  "runId": null,
  "results": null,
  "creatorToken": {
    "id": "27978",
    "description": "john.doe@keboola.com"
  },
  "actor": {
    "type": "token",
    "id": "27978",
    "name": "john.doe@keboola.com",
    "adminId": 1234
  },
  "metrics": {
    "inCompressed": false,
    "inBytes": 0,
    "inBytesUncompressed": 0,
    "outCompressed": false,
    "outBytes": 0,
    "outBytesUncompressed": 0
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.