KEkeboola
Tables

Tables in bucket

Lists tables in a given bucket. By default each table is returned with its attributes and metadata; use the include query parameter to add columns, column metadata or (for aliases) source table metadata.

get/v2/storage/branch/{branchId}/buckets/{bucketId}/tables

Request

Path parameters

bucketIdstring required

Bucket string id (e.g. in.c-main).

branchIdstring required

Query parameters

includestring

Comma-separated list of resources to include for each table: columns, metadata, columnMetadata, sourceMetadata (alias tables: source table metadata in sourceTable.metadata, works across projects for linked buckets), sourceColumnMetadata (alias tables: source column metadata in sourceTable.columnMetadata). Also accepted: attributes, buckets, bucketsWithoutSourceTables. Default: attributes,metadata; an empty value returns no extra data.

Response

List of tables in the bucket.

uristring required

Table detail URI

idstring required

Table identifier

namestring required

Table name

displayNamestring required

Display name of the table

transactionalboolean required

Transactional flag

primaryKeystring[] required
indexTypestring nullable required
indexKeystring[] required
distributionTypestring nullable required
distributionKeystring[] required
syntheticPrimaryKeyEnabledboolean required
createdstring nullable required

Created timestamp, ISO 8601 with a +hhmm offset.

lastImportDatestring nullable required

Last import date, ISO 8601 with a +hhmm offset.

lastChangeDatestring nullable required

Last change date, ISO 8601 with a +hhmm offset.

rowsCountinteger nullable required
dataSizeBytesinteger nullable required
isAliasboolean required
isAliasableboolean required
isTypedboolean required
isDescriptionSystemManagedboolean required

True when the table description is managed by the system.

timestampType'MANAGED' | 'SELFMANAGED' | 'NONE' required

How the _timestamp column is managed.

tableTypestring required
pathstring required
attributesobject[]

Always an empty array, kept for backward compatibility. Present with include=attributes (the default).

columnsstring[]

Column names. Present with include=columns.

columnMetadataTableColumnMetadataResponse

Column metadata of a table, keyed by column name. Built by Model_Row_MetadataTable::getTableColumnMetadataApiResponse().

aliasColumnsAutoSyncboolean

Present only for simple aliases.

selectSqlstring

Present only for custom SQL aliases.

isPersistedboolean

Whether the alias is persisted as a table in the backend. Present only for alias tables.

Example response

[
  {
    "created": "2017-02-13T12:01:05+0100",
    "lastImportDate": "2017-02-13T12:01:05+0100",
    "lastChangeDate": "2017-02-13T12:01:05+0100",
    "bucket": {
      "uri": "https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket",
      "id": "in.c-my-new-bucket",
      "name": "c-my-new-bucket",
      "displayName": "my-new-bucket",
      "idBranch": 1234,
      "stage": "in",
      "description": "Some Description",
      "tables": "https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket",
      "created": "2017-02-13T12:01:05+0100",
      "updated": "2024-11-28T13:03:13+0100",
      "backend": "snowflake",
      "path": "database_name.c-my-new-bucket",
      "bucketSharingAllowed": true,
      "sharingParameters": {
        "projects": [
          {
            "id": 321,
            "name": "Some Project"
          }
        ],
        "users": [
          {
            "id": 5,
            "name": "Jan Developer",
            "email": "jan.dev@keboola.com"
          }
        ]
      },
      "sharedBy": {
        "id": 5,
        "name": "dev@keboola.com",
        "date": "2020-02-03T14:58:29+0100"
      },
      "owner": {
        "id": 123,
        "name": "Jan Developer",
        "email": "jan.dev@keboola.com"
      },
      "sourceBucket": {
        "id": "in.c-main",
        "name": "c-main",
        "displayName": "main",
        "stage": "in",
        "description": "Organization shared data",
        "sharing": "organization-project",
        "created": "2020-01-12T18:28:31+0100",
        "lastChangeDate": "2020-01-12T18:31:49+0100",
        "dataSizeBytes": 1536,
        "rowsCount": 32,
        "backend": "snowflake",
        "path": "database_name.c-main",
        "project": {
          "id": 123,
          "name": "Project name"
        },
        "tables": [
          {
            "id": "in.c-main.languages",
            "name": "languages",
            "displayName": "languages-display-name",
            "path": "/1234-languages"
          }
        ],
        "sharingParameters": {
          "projects": [
            {
              "id": 321,
              "name": "Some Project"
            }
          ],
          "users": [
            {
              "id": 5,
              "name": "Jan Developer",
              "email": "jan.dev@keboola.com"
            }
          ]
        },
        "sharedBy": {
          "id": 5,
          "name": "dev@keboola.com",
          "date": "2020-02-03T14:58:29+0100"
        },
        "owner": {
          "id": 123,
          "name": "Jan Developer",
          "email": "jan.dev@keboola.com"
        },
        "metadata": [
          {
            "id": "19509",
            "key": "some-key",
            "value": "Some value",
            "provider": "test-component",
            "timestamp": "2017-02-13T23:36:10+0100"
          }
        ]
      },
      "backendPath": [
        "KBC_PRJ_123",
        "in.c-my-new-bucket"
      ],
      "metadata": [
        {
          "id": "19509",
          "key": "some-key",
          "value": "Some value",
          "provider": "test-component",
          "timestamp": "2017-02-13T23:36:10+0100"
        }
      ]
    },
    "metadata": [
      {
        "id": "19509",
        "key": "some-key",
        "value": "Some value",
        "provider": "test-component",
        "timestamp": "2017-02-13T23:36:10+0100"
      }
    ],
    "sourceTable": {
      "metadata": [
        {
          "id": "19509",
          "key": "some-key",
          "value": "Some value",
          "provider": "test-component",
          "timestamp": "2017-02-13T23:36:10+0100"
        }
      ]
    }
  }
]

Changes

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