
- Creates a message for changes like
create,update,deletefor rows in MSSQL database tables to a single Kafka topic. - Athena only creates messages for all new table changes. Existing ones are ignored.
- Kafka topic have to be created before hand. Unlike Debezium, Athena will not create the topic own it's own.
- All CDC setups in MSSQL is automatically done by Athena when
setupcommand is run. - By default, Athena will poll for changes for all tables, you can use the
skippedTablesoption in theconfig.jsonto ignore any tables.
You can download the pre-compiled binaries from the Github releases page and copy them to the desired location. After that you can follow the below steps in order.
Create a config.json file in the root folder where you but the Athena binary. Here is the format of the JSON file. Fill all the credentials also.
You can find more details about the paramters in config file in below sections.
{
"dbHost": "127.0.0.1",
"dbPort": 1433,
"dbUser": "",
"dbPassword": "",
"dbName": "",
"kafkaHost": "",
"kafkaEnableTLS": false,
"kafkaTopic": "",
"kafkaSASLMechanisms": "NONE",
"kafkaSASLUsername": "",
"kafkaSASLPassword": "",
"pollInterval": 10,
"fetchLimit": 50,
"skippedTables": [],
// If you want to collect logs in clickhouse
"clickHouse": false,
"clickHouseHost": "<host>:<port>",
"clickHouseUsername": "",
"clickHousePassword": "",
"clickHouseDatabase": "",
"clickHouseTableName": "",
"clickHouseTableTTL": 12
}Create topic with name given in config.json without scheme and with required partitions in you Kafka broker.
Setup a service for running Athena in the background. Setting this up will different for Windows and Linux. Below given are the steps to create them on a Linux distro.
Create a service file called athena_mssql_kafka.service in the directory /etc/systemd/system using the following commands.
cd /etc/systemd/system
nano athena_mssql_kafka.service[Unit]
Description=Athena MSSQL Kafka Service
After=network.target
[Service]
Type=simple
ExecStart=athena run
[Install]
WantedBy=multi-user.targetPlease note that path in
ExecStartneeds to change while creating the service file.
systemctl start athena_mmsql_kafka.service
systemctl status athena_mmsql_kafka.serviceAthena can be configured using the config.json file created on the root the Athena binary. Here are the details of the configuration keys and what they do in table format.
| Option | Description | Example |
|---|---|---|
dbHost |
Database host of MSSQL | 127.0.0.1 |
dbPort |
Database port of MSSQL | 1433 |
dbUser |
Username for the MSSQL database | |
dbPassword |
Password for the MSSQL database | |
dbName |
Database name of MSSQL | |
kafkaHost |
Host with port for the Kafka server | 127.0.0.1:9092 |
kafkaTopic |
Kafka topic that you created for table changes to show | |
kafkaEnableTLS |
Enables TLS for Kafka connection | true, false |
kafkaSASLMechanisms |
SASL mechanism that need to be used for Kafka connection | NONE, SASL-PLAIN, SASL-SCRAM-SHA-256, SASL-SCRAM-SHA-512 |
kafkaSASLUsername |
SASL user name of the Kafka server | |
kafkaSASLPassword |
SASL password of the Kafka server | |
pollInterval |
Interval where next polling to the database is made. It's given in seconds format. | 10 |
fetchLimit |
Number of CDC changes rows that will be pulled from the table at once. | 50 |
skippedTables |
Array of tables that needs to skipped while taking CDC changes. | ["table1", "table2"] |
clickHouse |
Enable Clickhouse logs. Table and struture for Clickhouse is automatically created by Athena when setup command is run |
true, false |
clickHouseHost |
Host with port for the Clickhouse server | 127.0.0.1:8123 |
clickHouseUsername |
User name of Clickhouse server | |
clickHousePassword |
Password of Clickhouse server | |
clickHouseDatabase |
Dasebase name of Clickhouse server | |
clickHouseTableName |
Table name of Clickhouse server | |
clickHouseTableTTL |
Time to live for each record in hours | 24 |
Athena executable have some other helper functions apart from setup or run which are explained below. These can be run like eg: ./athena uninstall
| Option | Description |
|---|---|
uninstall |
Will disable CDC in MSSQL database and remove the SQlite database |
add-cdc |
Will run CDC setup in the MSSQL database |
remove-cdc |
Will disable CDC in MSSQL database |
clear-cdc-history |
Clear CDC history or changes that Athena didn't process yet from the MSSQL database |
recreate-clickhouse |
Rerun the Clickhouse migration |
recreate-sqlite |
Recreate the SQlite database and rerun the migration |
help |
To view all the options available |
For setting up development environment, there is a docker file in the folder dev. It will create all necessary services like MSSQL with sample database, Kafka etc. This same environment can be used for running integration tests.
- Install latest version of Go from here.
- Clone that project from Github.
- Run
go mod downloadcommand to install all mods. - Then run the commands below as needed.
cd dev
docker composer up -d
cd ..
set GORUN=true # Used for identifying if script is run from go run command to choose correct path for reading config.json or db.sqlite
go run . setup
go run . runPlease note that the
docker-compose.ymlin thedevfolder should only be used for development purpose.
Before running the tests, make sure you have setup the development environment and also config.json is setup correctly.
cd tests
go test -v -run TestIntegrationYou can build the binaries or do development of Athena by following the below steps. Athena is build fully on Golang. So you should install latest version of Go from here. Do note that building binaries are managed with the Goreleaser.
- Clone that project from Github.
- Run
go mod downloadcommand to install all mods. - Run
SET GORUN=truecommand to set gorun variable. - Run the command
goreleaser release --snapshot --cleanfor building the binaries.
Athena is licensed under the MIT License.