DEdelta-incubator
CatalogsService

PATCH /catalogs/{name}

Changed on

Update a catalog

Updates the catalog that matches the supplied name. The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog).

Request

Path parameters

namestring required

Name of catalog.

Request body

namestring required

Name of catalog.

ownerstring

Username of new owner of catalog.

commentstring

User-provided free-form text description.

propertiesobject

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

When provided in update request, the specified properties will override the existing properties. To add and remove properties, one would need to perform a read-modify-write.

newNamestring

Name of catalog.

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

  • 60220bae69ecRevision changes
    • breaking

      the response property became optional for the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api tag CatalogsService added

    • info

      api tag CatalogService removed

    • info

      api tag catalogs removed

    • info

      api tag unity removed

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

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

    • info

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

    • info

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

    • info

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

  • 27d7bed71eaaRevision changes
    • info

      endpoint added