This repository was archived by the owner on Jan 27, 2026. It is now read-only.

Quickstart Example

Jump to bottom

jiawen-tw edited this page Apr 6, 2022 · 1 revision

Quickstart Example

This section is for new users to try Recce with the example scenario using the source and target databases provided.

Recce is currently only published as a container image to a private GHCR repo.

However, it also

requires a Postgres database
...and to be practically useful you will want to configure it with connectivity to some data sources you wish to reconcile.

Step 1: Run Recce locally

Clone this repository to your local machine
Install Docker and JDK 11+ locally if not yet installed
Build and run Recce locally with an example source and target database
```
./batect run
```

Step 2: Explore the APIs

Explore and trigger runs via Recce's APIs, accessible via interactive UI at http://localhost:8080/rapidoc.
Recce uses basic authentication to protect its API endpoints.
- In the example scenario, both username and password are set to "admin".
Some non-exhaustive examples are included below, but fuller documentation is available via the UI.
- Synchronously trigger a run, waiting for it to complete via UI or
```
curl -X POST http://localhost:8080/runs -H 'Content-Type: application/json' -d '{ "datasetId": "categories" }' -u "admin:admin"
```
- Retrieve details of an individual run by ID for a dataset via UI, or
```
curl 'http://localhost:8080/runs/35' -u "admin:admin"
```
- Retrieve details of recent runs for a dataset via UI, or
```
curl 'http://localhost:8080/runs?datasetId=categories' -u "admin:admin"
```

Next Steps

To configure Recce for reconciliation between actual databases, head to the Getting Started section.