Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateSchemaRequest

    interface UpdateSchemaRequest {
        browseOnly?: boolean;
        catalogName?: string;
        catalogType?: CatalogType;
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        customMaxRetentionHours?: bigint;
        effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag;
        enablePredictiveOptimization?: string;
        fullName?: string;
        fullNameArg?: string;
        metastoreId?: string;
        name?: string;
        newName?: string;
        options?: Record<string, string>;
        owner?: string;
        properties?: Record<string, string>;
        schemaId?: string;
        storageLocation?: string;
        storageRoot?: string;
        updatedAt?: bigint;
        updatedBy?: string;
    }
    Index

    Properties

    browseOnly? catalogName? catalogType? comment? createdAt? createdBy? customMaxRetentionHours? effectivePredictiveOptimizationFlag? enablePredictiveOptimization? fullName? fullNameArg? metastoreId? name? newName? options? owner? properties? schemaId? 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.

    catalogName?: string

    Name of parent catalog.

    catalogType?: CatalogType

    The type of the parent catalog.

    comment?: string

    User-provided free-form text description.

    createdAt?: bigint

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

    createdBy?: string

    Username of schema creator.

    customMaxRetentionHours?: bigint

    Custom maximum retention period in hours for the schema.

    effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag
    enablePredictiveOptimization?: string

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

    fullName?: string

    Full name of schema, in form of catalog_name.schema_name.

    fullNameArg?: string

    Full name of the schema.

    metastoreId?: string

    Unique identifier of parent metastore.

    name?: string

    Name of schema, relative to parent catalog.

    newName?: string

    New name for the schema.

    options?: Record<string, string>

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

    owner?: string

    Username of current owner of schema.

    properties?: Record<string, string>

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

    schemaId?: string

    The unique identifier of the schema.

    storageLocation?: string

    Storage location for managed tables within schema.

    storageRoot?: string

    Storage root URL for managed tables within schema.

    updatedAt?: bigint

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

    updatedBy?: string

    Username of user who last modified schema.

    Settings

    Member Visibility

    On This Page

    Properties