data-anaxi/README.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2024-08-08 14:44:15 +02:00
# Anaxi
`Anaxi` is Superhog's tool to perform Extract-Load (EL) syncs between our multiple Cosmos DB databases and our DWH.
2024-08-08 18:48:50 +02:00
## How to use the tool
*Note: the app has only been used so far in a Linux environment. Windows support is dubious.*
### Install
- Ensure you have Python 3.10>= and `poetry` installed.
- Run `poetry install` to install dependencies.
- Activate the project's virtual environment. You can use `poetry shell`.
- Test that everything is working by running `anaxi smoke-test`. You should see a happy pig.
### Set up credentials
`anaxi` needs a few configs and secrets to run.
Regarding Cosmos DB databases: `anaxi` expects to find a file called `cosmos-db.yml` in the path `~/.anaxi/cosmos-db.yml`. The file should specify one or more Cosmos DB databases, along with the required secrets to interact with them. You can check the example file in this repo named `example-cosmos-db.yml` to understand how to build this file. Once you've done that, you can check if any database is reachable with the `cosmos-db-healthcheck` command. See more in the `General Usage` section below.
### General Usage
You can run a healthcheck against any Cosmos DB database like this:
```bash
anaxis cosmos-db-healthcheck --cosmos-db-id <your-db-id>
```
2024-08-08 17:52:09 +02:00
## Incremental scopes
2024-08-08 18:48:50 +02:00
- [X] Callable CLI app
2024-08-08 17:52:09 +02:00
- [ ] Env vars readable from file system
- [ ] Healthchecks against Cosmos DB doable
- [ ] Healthchecks against DWH doable
- [ ] Reading from Cosmos DB
- [ ] Writing into DWH
- [ ] Refactors and improvements
2024-08-08 14:44:15 +02:00
## What's with the name
`Anaxi` is short for Anaximander. [Anaximander of Miletus](https://en.wikipedia.org/wiki/Anaximander) was a pre-Socratic Greek philosopher who lived in Miletus. He is often called the "Father of Cosmology" and founder of astronomy.