From 9603815c5d313dafab28300ba1d4b7337ca205d8 Mon Sep 17 00:00:00 2001
From: abimichel <abigail.michel@gov.bc.ca>
Date: Fri, 26 Jul 2024 16:51:50 -0700
Subject: [PATCH] add meltano documentation

---
 shared/tools/meltano/README.md | 56 ++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 shared/tools/meltano/README.md

diff --git a/shared/tools/meltano/README.md b/shared/tools/meltano/README.md
new file mode 100644
index 0000000..1677ddb
--- /dev/null
+++ b/shared/tools/meltano/README.md
@@ -0,0 +1,56 @@
+### Set up Meltano CLI
+```sh
+python3 -m pip install --user pipx
+
+pipx install meltano
+
+pipx ensurepath
+```
+
+### Run with Docker
+Link: https://docs.meltano.com/guide/containerization/
+```sh
+mkdir projects
+
+docker run -v .:/projects -w /projects meltano/meltano
+```
+
+### Set up a new Meltano replication job
+```sh
+meltano init odsdev
+
+cd ods-dev
+
+meltano add extractor tap-rest-api-msdk
+
+meltano config tap-rest-api-msdk set --interactive
+
+meltano invoke tap-rest-api-msdk
+
+meltano select tap-rest-api-msdk --list --all
+
+meltano add loader target-postgres
+
+meltano config target-postgres set --interactive
+
+meltano invoke target-postgres
+
+meltano select target-postgres --list --all
+```
+### Required Parameters
+
+For PostgreSQL:
+3. database
+11. host
+14. password
+15. port
+32. user
+
+For (public) API:
+3. API endpoint
+34. path
+
+### Notes
+- make sure to also set default_target_schema
+- secrets automatically go to .env file
+- --interactive allows you to semi-interactively set up the source and target details
\ No newline at end of file