KEkeboola
Tables

Table detail

Obtains information about a table.

  • definition property is available only for tables with native datatypes.
  • Data types in the definition are never alias/synonymous/virtual, they are always base types. E.g. INT = NUMERIC(38,0) for Snowflake.
get/v2/storage/tables/{id}

Request

Path parameters

idstring required

Table string id (e.g. in.c-main.orders).

Response

Table detail response

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
columnsstring[] required
columnMetadataTableColumnMetadataResponse required

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

attributesobject[] required

Always an empty array, kept for backward compatibility.

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",
  "metadata": [
    {
      "id": "19509",
      "key": "some-key",
      "value": "Some value",
      "provider": "test-component",
      "timestamp": "2017-02-13T23:36:10+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"
      }
    ]
  },
  "sourceTable": {
    "metadata": [
      {
        "id": "19509",
        "key": "some-key",
        "value": "Some value",
        "provider": "test-component",
        "timestamp": "2017-02-13T23:36:10+0100"
      }
    ]
  },
  "createdBy": {
    "componentId": "keboola.snowflake-transformation",
    "configurationId": "12345",
    "configurationRowId": "67890",
    "branchId": "1234"
  },
  "lastUpdatedBy": {
    "componentId": "keboola.snowflake-transformation",
    "configurationId": "12345",
    "configurationRowId": "67890",
    "branchId": "1234"
  }
}

Changes

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