Documentation

Welcome to the ElasticRelay documentation! This guide will help you get started with real-time CDC from MySQL, PostgreSQL, and MongoDB to Elasticsearch.

Getting Started

New to ElasticRelay? Start here:

• Introduction - What is ElasticRelay?
• Installation - How to install ElasticRelay
• Quick Start - Get up and running in 5 minutes
• Configuration - Configure your first CDC pipeline

Database Connectors

Learn how to use ElasticRelay with different databases:

• MySQL CDC - Setup and configuration for MySQL
• PostgreSQL CDC - Setup and configuration for PostgreSQL
• MongoDB CDC - Setup and configuration for MongoDB

Core Concepts

Understand how ElasticRelay works:

• Architecture - System design and components
• Change Data Capture - How CDC works
• Checkpointing - Checkpoint system
• Dead Letter Queue (DLQ) - Error handling

Operations

Running ElasticRelay in production:

• Deployment Guide - Deploy to production
• Monitoring - Monitor your pipelines
• Troubleshooting - Common issues and solutions
• Performance Tuning - Optimize throughput

Advanced Topics

• Parallel Processing - Multi-threaded snapshot sync
• Large Table Optimization - Handle big tables efficiently
• Security - Security best practices

Reference

• Configuration Reference - All configuration options
• API Reference - gRPC API documentation
• Changelog - Version history

Need Help?

• GitHub Discussions - Ask questions
• GitHub Issues - Report bugs
• Contact Support - Get enterprise support