Databricks SDK for JavaScript
    Preparing search index...

    Interface CatalogConfig

    Data Classification configuration for a Unity Catalog catalog. This message follows the "At Most One Resource" pattern: at most one CatalogConfig exists per catalog.

    • Full CRUD operations are supported: Create enables Data Classification, Delete disables it
    • It has no unique identifier of its own and uses its parent catalog's identifier (catalog_name)
    interface CatalogConfig {
        autoTagConfigs?: AutoTaggingConfig[];
        name?: string;
        selectedSchemas?:
            | {
                $case: "includedSchemas";
                includedSchemas: CatalogConfig_SchemaNames;
            }
            | { $case: "excludedSchemas"; excludedSchemas: CatalogConfig_SchemaNames };
    }
    Index

    Properties

    autoTagConfigs? name? selectedSchemas?

    Properties

    autoTagConfigs?: AutoTaggingConfig[]

    List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled.

    name?: string

    Resource name in the format: catalogs/{catalog_name}/config.

    selectedSchemas?:
        | {
            $case: "includedSchemas";
            includedSchemas: CatalogConfig_SchemaNames;
        }
        | { $case: "excludedSchemas"; excludedSchemas: CatalogConfig_SchemaNames }

    Type Declaration

    • { $case: "includedSchemas"; includedSchemas: CatalogConfig_SchemaNames }
      • $case: "includedSchemas"
      • includedSchemas: CatalogConfig_SchemaNames

        Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excluded_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

    • { $case: "excludedSchemas"; excludedSchemas: CatalogConfig_SchemaNames }
      • $case: "excludedSchemas"
      • excludedSchemas: CatalogConfig_SchemaNames

        Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with included_schemas: only one may be set per request. If neither included_schemas nor excluded_schemas is set, all schemas are scanned.

    Settings

    Member Visibility

    On This Page

    Properties