List All Tables

Endpoint

GET {prefix}/shares/{share}/all-tables

This API lists all the tables under all schemas in a share. This is a convenience endpoint that allows you to discover all available tables without having to first list schemas.

Authentication

Authorization

string

required

Bearer token for authentication

Authorization: Bearer {token}

Path Parameters

The share name to query. Case-insensitive.

Query Parameters

maxResults

integer

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, the response will provide a nextPageToken that can be used to get the next page of results in subsequent list requests.The server may return fewer than maxResults items even if there are more available. The client should check nextPageToken in the response to determine if there are more available.Must be non-negative. 0 will return no results but nextPageToken may be populated.

pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.nextPageToken will not be returned in a response if there are no more results available.

Response

Success Response (200)

items

array

Array of table objects. May be an empty array or missing when no results are found.

Show Table object

name

string

required

Table name. Must not exceed 255 characters and must not contain restricted characters.

schema

string

required

Schema name. Must not exceed 255 characters and must not contain restricted characters.

Share name. Must not exceed 255 characters and must not contain restricted characters.

Unique immutable identifier for the share (UUID recommended).

string

Unique table identifier within the share (UUID recommended). If populated, its value should stay immutable through the table’s lifecycle.

location

string

Root directory path of the table where the delta log exists. Required if the server supports dir based access for the table.

auxiliaryLocations

array

Optional array of additional storage locations for table files. Usually no more than one auxiliary location.If present, these locations should be supported in the location field of the Generate Temporary Table Credential request body. If a client can’t read from an auxiliary location, it should fall back to URL access (if available) or fail the request.

accessModes

array

Supported access modes for the table: url, dir, or both.

If url is present, the Query Table API should be implemented for the table
If dir is present, the Generate Temporary Table Credential API should be implemented for the table
If this field is not present, the client will assume that the server only supports URL-based access

nextPageToken

string

Token for retrieving the next page of results. May be an empty string or missing when there are no additional results. The client must handle both cases.

Example Response

{
  "items": [
    {
      "name": "covid_data",
      "schema": "public_health",
      "share": "vaccine_share",
      "shareId": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
      "id": "dcb1e680-7da4-4041-9be8-88aff508d001",
      "location": "s3://my-bucket/delta-tables/covid_data",
      "accessModes": ["url", "dir"]
    },
    {
      "name": "patient_demographics",
      "schema": "healthcare",
      "share": "vaccine_share",
      "shareId": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
      "id": "f1234567-89ab-cdef-0123-456789abcdef",
      "location": "s3://my-bucket/delta-tables/patient_demographics",
      "auxiliaryLocations": [
        "s3://my-archive-bucket/patient-demographics-archive"
      ],
      "accessModes": ["url", "dir"]
    }
  ],
  "nextPageToken": "eyJsYXN0X3NjaGVtYSI6ImhlYWx0aGNhcmUiLCJsYXN0X3RhYmxlIjoicGF0aWVudF9kZW1vZ3JhcGhpY3MifQ=="
}

Error Responses

400 - Bad Request

The request is malformed.

{
  "errorCode": "INVALID_PARAMETER_VALUE",
  "message": "Invalid value for maxResults: -1"
}

401 - Unauthorized

The request is unauthenticated. The bearer token is missing or incorrect.

{
  "errorCode": "UNAUTHENTICATED",
  "message": "Missing or invalid authorization header"
}

403 - Forbidden

The request is forbidden from being fulfilled.

{
  "errorCode": "PERMISSION_DENIED",
  "message": "User does not have access to share: vaccine_share"
}

404 - Not Found

The requested resource does not exist.

{
  "errorCode": "RESOURCE_DOES_NOT_EXIST",
  "message": "Share not found: vaccine_share"
}

500 - Internal Server Error

The request is not handled correctly due to a server error.

{
  "errorCode": "INTERNAL_ERROR",
  "message": "An internal error occurred"
}

Usage Example

curl -X GET \
  https://sharing.delta.io/delta-sharing/shares/vaccine_share/all-tables \
  -H 'Authorization: Bearer {token}'

Notes

The items field may be an empty array or missing when no results are found. The client must handle both cases.

This endpoint is a convenience method that combines listing schemas and listing tables within each schema. For large shares with many tables, consider using pagination with the maxResults and pageToken parameters.

If auxiliaryLocations is present and a client does not support reading from multiple locations, they should either fall back to URL-based access via the Query Table API or throw an error.

Protocol Specification

REST API Endpoints

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Success Response (200)

Example Response

Error Responses

Usage Example

Notes

Build docs developers (and LLMs) love

Protocol Specification

REST API Endpoints

​Endpoint

​Authentication

​Path Parameters

​Query Parameters

​Response

​Success Response (200)

​Example Response

​Error Responses

​Usage Example

​Notes

Build docs developers (and LLMs) love

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Success Response (200)

Example Response

Error Responses

Usage Example

Notes