KEkeboola
Search

Search Tables

Search all tables accessible by the token by either metadataKey, metadataValue or metadataProvider. By default, all tables are returned with their attributes and information about the containing bucket. At least one of parameters metadataKey|metadataValue|metadataProvider must be provided.

The include parameter is a comma separated list of resources to include for each table: buckets, columns, metadata, columnMetadata, sourceMetadata (for alias tables, includes source table metadata in sourceTable.metadata; works across projects for linked buckets), sourceColumnMetadata (for alias tables, includes source column metadata in sourceTable.columnMetadata).

get/v2/storage/search/tables

Request

Query parameters

metadataKeystring nullable

Metadata key to search for.

metadataValuestring nullable

Metadata value to search for.

metadataProviderstring nullable

Metadata provider to search for.

string

Comma-separated list of resources.

OR
string[]

Repeated array of resources.

Response

List of tables matching the search criteria.

uristring required
idstring required
namestring required
displayNamestring required
transactionalboolean required
primaryKeystring[] required
indexTypestring nullable required
indexKeystring[] required
distributionTypestring nullable required
distributionKeystring[] required
syntheticPrimaryKeyEnabledboolean required
createdstring nullable required

Creation timestamp, ISO 8601 with a +hhmm offset; null for a zero date.

lastImportDatestring nullable required

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

lastChangeDatestring nullable required

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

rowsCountinteger nullable required
dataSizeBytesinteger nullable required
isAliasboolean required
isAliasableboolean required
isTypedboolean required
isDescriptionSystemManagedboolean required
timestampTypestring required
tableTypestring required
pathstring required
aliasColumnsAutoSyncboolean

Present only for simple (non-SQL) alias tables.

selectSqlstring

Present only for custom SQL aliases.

isPersistedboolean

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

attributesobject[]

Deprecated, always empty. Present with include=attributes (default).

columnsstring[]

Present with include=columns.

columnMetadataTableColumnMetadataResponse

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

Example response

[
  {
    "uri": "https://connection.keboola.com/v2/storage/tables/in.c-application-testing.cashier-data",
    "id": "in.c-application-testing.cashier-data",
    "name": "cashier-data",
    "displayName": "cashier-data",
    "created": "2017-02-13T12:01:05+0100",
    "lastImportDate": "2017-02-13T12:01:05+0100",
    "lastChangeDate": "2017-02-13T12:01:05+0100",
    "timestampType": "MANAGED",
    "tableType": "table",
    "path": "kbc_578.c-application-testing.cashier-data",
    "sourceTable": {
      "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"
        }
      ]
    },
    "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.