Edit

Share via


Discovery - Discover Tables

Note

This API is in preview.

Returns a list of tables in the given schema from Unity Catalog.
This API supports pagination.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.Read.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities No

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas/{schemaName}/tables?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas/{schemaName}/tables?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}&continuationToken={continuationToken}&maxResults={maxResults}

URI Parameters

Name In Required Type Description
catalogName
path True

string

The catalog name.

schemaName
path True

string

The schema name.

workspaceId
path True

string (uuid)

The workspace ID.

databricksWorkspaceConnectionId
query True

string (uuid)

The Databricks workspace connection ID.

continuationToken
query

string

A token for retrieving the next page of results.

maxResults
query

integer

The maximum number of results to return.

Responses

Name Type Description
200 OK

DatabricksTables

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

  • CorruptedPayload - The provided payload is corrupted.

Examples

List Databricks tables example

Sample request

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/azuredatabricks/catalogs/catalog_1/schemas/schema_1/tables?databricksWorkspaceConnectionId=c1128f28-d84f-417c-8234-0feb91e35f86

Sample response

{
  "value": [
    {
      "name": "table_1",
      "fullName": "catalog_1.schema_1.table_1",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b",
      "tableType": "MANAGED",
      "dataSourceFormat": "DELTA"
    },
    {
      "name": "table_2",
      "fullName": "catalog_1.schema_1.table_2",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b",
      "tableType": "MANAGED",
      "dataSourceFormat": "DELTA"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definitions

Name Description
DatabricksTable

A table from Unity Catalog

DatabricksTables

A list of tables from Unity Catalog.

DataSourceFormat

The data source format of the table. Additional DataSourceFormat types may be added over time.

ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

TableType

The type of the table. Additional TableType types may be added over time.

DatabricksTable

A table from Unity Catalog

Name Type Description
dataSourceFormat

DataSourceFormat

The data source format of the table.

fullName

string

The full name of the table, in the form of catalog_name.schema_name.table_name.

name

string

The name of the table, relative to the parent schema.

storageLocation

string

The storage location of the table.

tableType

TableType

The type of the table.

DatabricksTables

A list of tables from Unity Catalog.

Name Type Description
Error

ErrorResponse

Error is set if unable to fetch tables

continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.

continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.

value

DatabricksTable[]

A list of Databricks tables.

DataSourceFormat

The data source format of the table. Additional DataSourceFormat types may be added over time.

Value Description
DELTA

Delta format

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.

resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.

message

string

A human readable representation of the error.

moreDetails

ErrorResponseDetails[]

List of additional error details.

relatedResource

ErrorRelatedResource

The error related resource details.

requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.

message

string

A human readable representation of the error.

relatedResource

ErrorRelatedResource

The error related resource details.

TableType

The type of the table. Additional TableType types may be added over time.

Value Description
MANAGED

Managed Table

EXTERNAL

External Table