Sign in
CatalogsService

Get a catalog

Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the catalog, or a user that has the USE_CATALOG privilege set for their account.

get/catalogs/{name}

Path parameters

namestring required

Name of catalog.

Query parameters

includeBrowseboolean

Whether to include catalogs in the response for which the principal can only access selective metadata for

Response

OK

idstring

Unique identifier for the catalog.

namestring

Name of catalog.

ownerstring

Username of current owner of catalog.

commentstring

User-provided free-form text description.

propertiesobject

A map of key-value properties attached to the securable.

storageRootstring

Storage root URL for managed tables within catalog.

providerNamestring

The name of delta sharing provider.

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.

shareNamestring

The name of the share under the share provider.

catalogTypeinteger

The type of the catalog.

createdAtstring

Time at which this catalog was created, in epoch milliseconds.

createdBystring

Username of catalog creator.

updatedAtstring

Time at which this catalog was last updated, in epoch milliseconds.

updatedBystring

Username of user who last modified catalog.

browseOnlyboolean

Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

Changes

Changed in 3 of the 9 revisions of this API.2217

  • 60220bae69ec1216See the full diff
    • ▲

      the response property name became optional for the status 200

      response-property-became-optional

    • ●

      removed the optional property createAt from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property updateAt from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag CatalogsService added

      api-tag-added

    • ○

      api tag CatalogService removed

      api-tag-removed

    • ○

      api tag catalogs removed

      api-tag-removed

    • ○

      api tag unity removed

      api-tag-removed

    • ○

      added the new optional query request parameter includeBrowse

      new-optional-request-parameter

    • ○

      added the optional property browseOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property catalogType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property createdAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property providerName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property shareName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property storageRoot to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property updatedAt to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property createdBy became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property owner became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property updatedBy became not read-only for the status 200

      response-optional-property-became-not-read-only

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 27d7bed71eaa1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af378e92b27b1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog