Overview of the data catalog
EventHouse Catalog is the metadata management layer for EventBridge EventHouse. It centrally manages metadata, schema definitions, and access permissions for event data sources.
EventHouse Catalog uses a three-layer namespace structure aligned with mainstream data catalogs such as the Catalog-Schema-Table architecture of Databricks Unity Catalog, letting you organize and manage event data assets by business domain.
Namespace structure
Catalog (Data catalog)
└── Namespace (Namespace)
└── Event Table (Event table)|
Level |
Name |
Description |
Naming convention |
|
Layer 1 |
Catalog |
The top-level directory, divided by business domain or environment. |
1 to 64 characters. Must start with a letter. Supports letters, numbers, and underscores (_). |
|
Layer 2 |
Namespace |
Divided by subsystem or data subject. |
1 to 64 characters. Must start with a letter. Supports letters, numbers, and underscores (_). |
|
Layer 3 |
Event Table |
A specific event data table. |
1 to 48 characters. Supports numbers, lowercase letters, and hyphens (-). Cannot start with a hyphen. |
Naming suggestions:
-
Catalog: Divide by business domain or environment, such as
prod-catalog,dev-catalog, andfinance-catalog. -
Namespace: Divide by subsystem or data subject, such as
order_namespaceandpayment_namespace.
Prerequisites
Log on to the EventBridge console. In the navigation pane on the left, select EventHouse > Data Catalog.
Manage catalogs
Create a catalog
-
On the Data Catalog page, click Create Catalog.
-
In the Create Catalog dialog box, configure the following parameters.
Parameter
Required
Description
Name
Yes
The catalog name. Must be 1 to 64 characters in length, start with a letter, and can contain letters, numbers, and underscores (_).
Description
No
The description of the catalog.
-
Click OK.
After the catalog is created, it appears in the navigation tree on the left and in the catalog list on the right.
Edit a catalog description
-
In the navigation tree on the left, click the target catalog to open its details page.
-
In the Description section, click Edit Description.
-
Modify the description and save your changes.
Delete a catalog
Note Before you delete a catalog, you must delete all namespaces and event tables within it.
-
In the navigation tree on the left, click the target catalog to open its details page.
-
In the upper-right corner of the page, click Delete.
-
In the confirmation dialog box, click OK.
Manage namespaces
Create a namespace
-
In the navigation tree on the left, click the target catalog to open its details page.
-
Click Create Namespace.
-
In the Create Namespace dialog box, configure the following parameters.
Parameter
Required
Description
Namespace Name
Yes
The namespace name. Must be 1 to 64 characters in length, start with a letter, and can contain letters, numbers, and underscores (_).
Description
No
The description of the namespace.
-
Click OK.
After the namespace is created, it appears as a child node of the corresponding catalog in the navigation tree on the left.
Edit a namespace description
-
In the navigation tree on the left, click the target namespace to open its details page.
-
In the Description section, click Edit Description.
-
Modify the description and save your changes.
Delete a namespace
Note Before you delete a namespace, you must delete all event tables within it.
-
In the navigation tree on the left, click the target namespace to open its details page.
-
In the upper-right corner of the page, click Delete.
-
In the confirmation dialog box, confirm the namespace information and then click OK.
Manage event tables
Create an event table
-
In the navigation tree on the left, expand the target catalog and click the target namespace to open its details page.
-
Click Create Event Table.
-
In the Create Event Table dialog box, configure the following parameters.
Basic information
|
Parameter |
Required |
Description |
|
Event Table Name |
Yes |
The event table name. Must be 1 to 48 characters in length and can contain numbers, lowercase letters, and hyphens (-). Cannot start with a hyphen. |
|
Description |
No |
The description of the event table. |
Storage configuration
|
Parameter |
Required |
Description |
|
Data retention period |
Yes |
How long event data is stored. Select Limited days and enter a specific number of days, or select Permanent retention. |
|
Data tiering |
No |
Enables tiered data storage. Disabled by default. When enabled, data is automatically managed in tiers for hot storage and Infrequent Access (IA) storage. |
If you enable data tiering, configure the following parameters:
|
Parameter |
Description |
|
Hot storage data retention |
The number of days data is retained in hot storage. After this period, data is automatically moved to IA storage. |
|
IA storage data retention |
Automatically calculated based on the total retention period and the hot storage retention period. Data is deleted when the IA storage period expires. |
Metadata configuration
Configure the event table schema in one of the following ways:
|
Method |
Description |
|
Import schema |
Select a schema from an existing schema group. The column definitions (name, type, and description) are displayed in the column preview area and cannot be edited. |
|
Custom registration |
Manually define the column structure of the event table. Supported column types: text, bigint, double, json, and timestamp. Click Add Metadata to add columns. |
-
Click OK.
Delete an event table
-
On the namespace details page, find the target event table in the event table list.
-
In the Operations column, click Delete.
-
In the confirmation dialog box, click OK.