⌘K
Documentation

Add Catalog Panel

Overview

The Add Catalog panel allows administrators to create a new data catalog, which represents the highest-level organizational layer within the DataFloem system hierarchy.

Each newly instantiated Catalog acts as a logical container, managing its own internal schemas, namespaces, tables, and execution capabilities such as Iceberg REST, Commit tracking, and Maintenance operations.

Access Denied

You don't have access to this resource.

Prerequisites

Before creating a new Catalog, ensure that:

  • You possess the required administrative or create privileges to execute catalog management functions.
  • The designated Catalog name is entirely unique within the system architecture.
  • The target default data warehouse destination is active and accessible.

Catalog Form Fields

The following operational attributes must be configured within the panel:

Field Required Description
Name Yes Unique identifier for the Catalog, used for internal routing and resource path reference.
Display Name No Human-readable alias displayed across the user interface.
Description No Contextual text defining the purpose, team, or department of this catalog. Supports up to 200 characters.
Default Warehouse No Specifies the default data warehouse that will manage storage and query execution for this catalog.
Is Active Yes (Toggle) Controls whether the catalog becomes immediately operational upon creation. Enabled by default.

Supported Capabilities

Capability Required Description
Iceberg Rest Yes (Toggle) Enables Apache Iceberg REST API support for client integrations.
Commit Yes (Toggle) Enables table commit and transaction logging capabilities.
Maintanenance Yes (Toggle) Enables automated background maintenance operations (e.g., compaction, snapshot cleanup).

Catalog Creation Process

  1. Click the Add Catalog button on the main catalog view to open the right side-panel.
  2. Fill in the unique Name and optional Display Name fields.
  3. Provide an optional descriptive Description (up to 200 characters).
  4. Assign a Default Warehouse for execution routing.
  5. Set the Is Active state toggle according to governance requirements.
  6. Configure the Supported Capabilities (Iceberg Rest, Commit, Maintanenance) toggles based on your requirements.
  7. Review inputs and click Save to create the catalog, or click Cancel to abort.

Validation

  • The Name field cannot be left blank or consist solely of whitespace characters.
  • The Description text boundary must strictly conform to the 0 - 200 character threshold.
ESC

Start typing to search across the documentation.