Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateCatalogRequest

    interface UpdateCatalogRequest {
        browseOnly?: boolean;
        catalogType?: CatalogType;
        comment?: string;
        connectionName?: string;
        createdAt?: bigint;
        createdBy?: string;
        customMaxRetentionHours?: bigint;
        effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag;
        enablePredictiveOptimization?: string;
        fullName?: string;
        isolationMode?: CatalogIsolationMode;
        managedEncryptionSettings?: EncryptionSettings;
        metastoreId?: string;
        name?: string;
        nameArg?: string;
        newName?: string;
        options?: Record<string, string>;
        owner?: string;
        properties?: Record<string, string>;
        providerName?: string;
        provisioningInfo?: ProvisioningInfo;
        securableType?: SecurableType;
        shareName?: string;
        storageLocation?: string;
        storageRoot?: string;
        updatedAt?: bigint;
        updatedBy?: string;
    }
    Index

    Properties

    browseOnly? catalogType? comment? connectionName? createdAt? createdBy? customMaxRetentionHours? effectivePredictiveOptimizationFlag? enablePredictiveOptimization? fullName? isolationMode? managedEncryptionSettings? metastoreId? name? nameArg? newName? options? owner? properties? providerName? provisioningInfo? securableType? shareName? storageLocation? storageRoot? updatedAt? updatedBy?

    Properties

    browseOnly?: boolean

    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.

    catalogType?: CatalogType
    comment?: string

    User-provided free-form text description.

    connectionName?: string

    The name of the connection to an external data source.

    createdAt?: bigint

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

    createdBy?: string

    Username of catalog creator.

    customMaxRetentionHours?: bigint

    Custom maximum retention period in hours for the catalog

    effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag
    enablePredictiveOptimization?: string

    Whether predictive optimization should be enabled for this object and objects under it.

    fullName?: string

    The full name of the catalog. Corresponds with the name field.

    isolationMode?: CatalogIsolationMode

    Whether the current securable is accessible from all workspaces or a specific set of workspaces.

    managedEncryptionSettings?: EncryptionSettings

    Control CMK encryption for managed catalog data

    metastoreId?: string

    Unique identifier of parent metastore.

    name?: string

    Name of catalog.

    nameArg?: string

    The name of the catalog.

    newName?: string

    New name for the catalog.

    options?: Record<string, string>

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

    owner?: string

    Username of current owner of catalog.

    properties?: Record<string, string>

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

    providerName?: string

    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.

    provisioningInfo?: ProvisioningInfo
    securableType?: SecurableType
    shareName?: string

    The name of the share under the share provider.

    storageLocation?: string

    Storage Location URL (full path) for managed tables within catalog.

    storageRoot?: string

    Storage root URL for managed tables within catalog.

    updatedAt?: bigint

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

    updatedBy?: string

    Username of user who last modified catalog.

    Settings

    Member Visibility

    On This Page

    Properties