KEkeboola
Tables

Create new table definition

Creates a table with typed columns. Snowflake|BigQuery only.

Request is handled asynchronously which means that the create request is created and added to a queue and the job resource URL for status polling is returned.

If there is no column datatype specified (column.definition.type or column.basetype) in a request a table will be created as a non-typed table.

The request payload is backend specific: timePartitioning, rangePartitioning and clustering are BigQuery only (documentation). Buckets on other backends are rejected.

Initial response returns job details JobResponse. The result of the asynchronous job can be fetched via /v2/storage/jobs/{id}. When the job completes, final result is TableCreateResponse.

Parameters of job will be TableDefinitionCreateJobParams.

post/v2/storage/branch/{branchId}/buckets/{bucketId}/tables-definition

Request

Path parameters

bucketIdstring required

The bucket Id.

branchIdstring required

Headers

contextstring nullable

Request body

OR

Example request

{
  "columns": [
    {
      "name": "created_at"
    }
  ]
}

Response

Job accepted; returns job details.

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.