Select Database Type

Choose your database engine from the supported options

Enter Connection Name

Give your connection a descriptive name for easy identification

# Example connection names:
production_postgres
staging_mysql
analytics_mongodb
orders_sqlserver

Configure Connection Details

Enter the database host, port, credentials, and database name

MongoDB: Choose Connection Method

For MongoDB, you can connect using a URI string or individual fields

# URI Mode (recommended for Atlas):
mongodb+srv://user:pass@cluster.mongodb.net/mydb

# Fields Mode:
Host: localhost
Port: 27017
Database: mydb

SQL Server: Choose Authentication

SQL Server supports both SQL Server Authentication and Windows Authentication

Configure SSH Tunnel (Optional)

Connect through an SSH bastion host for secure access to databases in private networks

# SSH with Password:
SSH Host: bastion.example.com
SSH User: ubuntu
SSH Password: ********

# SSH with Private Key:
SSH Host: bastion.example.com
SSH User: ec2-user
Private Key: -----BEGIN PRIVATE KEY-----...

Test Connection

Click "Test Connection" to verify your settings before saving

CDCStream will attempt to connect to your database and verify that the provided credentials have the necessary permissions (SELECT, TRIGGER creation). A modal will show the connection status.

Save Connection

Click "Save" to store the connection and start using it

After a successful connection test, CDCStream will automatically save your connection and redirect you to the Connections page. You can now create alerts using this connection!

Select Database Connection

Choose which database connection to monitor

Select from your configured database connections (PostgreSQL, MySQL, MongoDB, or SQL Server). If you haven't added one yet, go to Connections first.

Select Schema & Table

Choose the schema and table (or view) you want to monitor

CDCStream fetches the schema structure from your database. You can monitor regular tables or database views.

Configure Rules

Select columns to include and add conditions to define which changes trigger the alert

# Example: Only trigger for high-value orders
Column: amount
Operator: > (Greater Than)
Value: 1000

# Example: Only trigger for specific status
Column: status
Operator: Equals
Value: "pending"

Alert Details

Configure alert name, description, and log retention

Select Notification Channel

Choose or create a notification channel for this alert

You can create a new channel directly from this screen or select an existing one.

Customize Message Template

Define the notification message using placeholders

🔔 *{{operation}}* on `{{schema_name}}.{{table_name}}`

📦 Data: {{column_name}}

Create Alert

Click "Create Alert" to save and activate

CDCStream will automatically install the necessary database triggers. Your alert starts monitoring immediately!