Skip to content

Create a schema for an existing unannotated CLOUD database from the CLI

Jarrod edited this page Sep 15, 2022 · 3 revisions

Clone this repository and run the following command in your terminal:

Usage: clojure -m schema-cartographer.core [options]

Options:
  -c, --client-file CLIENT-FILE            Filename containing edn client args
  -r, --region REGION                      Region where Datomic cloud is located
  -s, --system SYSTEM                      Datomic cloud system name
  -p, --endpoint END-POINT                 ClientApiGatewayEndpoint
  -d, --db DATABASE                        Database Name
  -o, --output FILE                        Write schema edn to FILE
  -l, --ref-search-limit REF-SEARCH-LIMIT  The number of referenced entities to inspect when building relationships
  -a, --audit                              Audit schema annotations and log gaps. Boolean
  -e, --explore                            Explore unannotated database and build schema. Boolean
  -h, --help
clojure -M -m schema-cartographer.core -r "us-east-1" \
                                       -s "your-system-name" \
                                       -d "your-database" \
                                       -p "https://ClientApiGatewayEndpoint.execute-api.us-east-1.amazonaws.com" \
                                       -o "resources/db-schema.edn" \
                                       -l 2000 \
                                       -e

Progress will be logged to the shell while the utility is running.

Load the resulting output file in the UI that resides at https://schema-cartographer.com