Manage Data Catalog using Rudder CLI Alpha

This section explains how to create and manage events, properties, and custom data types in Data Catalog using Rudder CLI.

Important

Data Catalog management via Rudder CLI is a push-only feature, meaning you can only push changes to your RudderStack workspace. You cannot pull changes from your workspace to your local system.

Overview

RudderStack’s Data Catalog feature lets you centrally define and manage the events, properties, and data structures that power your data collection strategy. It serves as a single source of truth for your organization’s data schema, helping teams maintain consistency across different platforms and applications.

Data Catalog helps you:

• Standardize event definitions and properties across all platforms
• Create reusable data validation patterns with custom types
• Maintain data quality through centralized schema management
• Ensure consistency between different teams and applications
• Track schema changes through version control

You can use these catalog components to configure Tracking Plans that enforce consistent data collection practices.

How it works

Rudder CLI lets you manage the following Data Catalog components through YAML configuration files in your project:

• Events that represent user actions or occurrences you want to track
• Properties that provide additional context and attributes for events
• Custom Types for reusable validation patterns and data structures

You can use Rudder CLI to:

• Add and validate definitions for these components locally
• Deploy the Catalog components to your workspace
• Manage changes through version control

Data Catalog components

The Data Catalog consists of three main components:

• Events: Events represent specific user actions or occurrences you want to track in your application. They can be events related to user actions (track), user identification (identify), view tracking (page/screen), or organization/account tracking (group).
• Properties: Properties are the attributes associated with events. They provide additional context about the event and can include user properties, event-specific properties, and contextual properties shared across events.
• Custom data types: Custom types allow you to define reusable data validation patterns that can be referenced across multiple properties, ensuring consistent data validation, standardized formats, and reduced duplication.

In this section

See the following guides to start creating and managing your Data Catalog project in Rudder CLI:

Questions? Contact us by email or on Slack