Azimutt CLI

Azimutt CLI is aimed at helping you explore databases, schema but also data.

It works with relational and document ones, such as Couchbase, MariaDB, MongoDB, MySQL, PostgreSQL, SQL Server 🎉

Use this CLI without installing it thanks to npx: npx azimutt@latest.

Get the help simply by running the CLI (npx azimutt@latest) or for a specific command using npx azimutt@latest help export for example.

Available commands

• gateway (npx azimutt gateway): launch the Gateway server locally to proxy database calls from your computer
• explore (npx azimutt explore <url>): open Azimutt in your browser with the db url already configured (& start the Gateway server)
• export (npx azimutt export <url> [arguments]): export a database schema as JSON file to import in Azimutt
  • ex: npx azimutt export bigquery://bigquery.googleapis.com/my-project?key=key.json
  • ex: npx azimutt export couchbases://cb.gfn6dh493pmfh613v.cloud.couchbase.com
  • ex: npx azimutt export mariadb://user:[email protected]:3306/my_db
  • ex: npx azimutt export "mongodb+srv://user:[email protected]"
  • ex: npx azimutt export mysql://user:[email protected]:3306/my_db
  • ex: npx azimutt export postgresql://postgres:postgres@localhost:5432/azimutt_dev
  • ex: npx azimutt export snowflake://user:[email protected]?db=my_db
  • ex: npx azimutt export Server=host.com,1433;Database=db;User Id=user;Password=pass
  • url the database connection url, must contain everything needed (user, pass, port...)
  • --database is optional, restrict extraction to this database or database pattern (using %)
  • --catalog is optional, restrict extraction to this catalog or catalog pattern (using %)
  • --bucket is optional, restrict extraction to this bucket or bucket pattern (using %)
  • --schema is optional, restrict extraction to this schema or schema pattern (using %)
  • --entity is optional, restrict extraction to this entity or entity pattern (using %)
  • --sample-size is optional, defines how many items are used to infer a schema (for document databases or json fields)
  • --mixed-json is optional, split collections given the specified json field (if you have several kind of documents in the same collection)
  • --infer-json-attributes is optional, if JSON fields should be fetched to infer their schema
  • --infer-polymorphic-relations is optional, if kind field on polymorphic relations should be fetched to know all relations
  • --infer-relations build relations based on column names, for example a user_id will have a relation if a table users has an id column
  • --ignore-errors is optional, do not stop export on errors, just log them
  • --log-queries is optional, log queries when executing them
  • --format is optional, default to json but for relational database it could also be sql
  • --output is optional, database name will be inferred from url and prefixed by the timestamp
  • --debug allows to see the full stack trace of the error (can be helpful to debug)

Developing

Start with npm run setup to install dependencies and set up the CLI, then you have:

• npm run exec to compile and launch the CLI (use -- args for CLI args, ex: npm run exec -- export postgresql://postgres:postgres@localhost:5432/azimutt_dev), or npm run build && node lib/index.js
• npm run start to launch it with live reload (same, use -- args to pass arguments to the CLI)
• npm run test to launch tests

Publish

• update package.json and src/version.ts versions
• update lib versions (npm run update + manual) & run npm install
• test with npm run dry-publish and check azimutt-x.y.z.tgz content
• launch npm publish

View it on npm.

Dev

If you need to develop on multiple libs at the same time (ex: want to update a connector and try it through the CLI), depend on local libs but publish & revert before commit.

• Depend on a local lib: npm install <path>, ex: npm install ../gateway
• "Publish" lib locally by building it: npm run build