schema-voyager.cli
Tools for invoking Schema Voyager from the CLI. This is the main external interface into Schema Voyager.
See the installation and usage docs for the mechanics of calling this code.
Tools for invoking Schema Voyager from the CLI. This is the main external interface into Schema Voyager. See the [installation and usage docs](/doc/installation-and-usage.md) for the mechanics of calling this code.
ingestclj
(ingest {:keys [db-file sources]})Ingest schema into Schema Voyager as per ingest-into-db, saving the
resulting DataScript DB at db-file (by default
resources/schema_voyager_db.edn).
This is mostly used during development of Schema Voyager itself.
Read about how to invoke ingest in the advanced usage
docs.
NOTICE: If you experience errors using a Datomic source, see the troubleshooting docs.
Ingest schema into Schema Voyager as per [[ingest-into-db]], saving the resulting DataScript DB at `db-file` (by default `resources/schema_voyager_db.edn`). This is mostly used during development of Schema Voyager itself. Read about how to invoke [[ingest]] in the [advanced usage docs](/doc/advanced-exploration.md). NOTICE: If you experience errors using a Datomic source, see the [troubleshooting docs](/doc/troubleshooting.md).
ingest-into-dbclj
(ingest-into-db {:keys [sources]})Create an in-memory DataScript DB from the sources. Does not persist the
database. Useful primarily for exploring the database from a script.
Read about specifying sources in the sources docs.
Create an in-memory DataScript DB from the `sources`. Does not persist the database. Useful primarily for exploring the database from a script. Read about specifying sources in the [sources docs](/doc/sources.md).
print-attributesclj
(print-attributes {:keys [datomic/client-config datomic/db-name]})Print the attributes Schema Voyager is loading from a Datomic source.
Expects the argument to be a Datomic source,
that is, it should contain :datomic/client-config and :datomic/db-name.
Useful mostly for debugging.
Print the attributes Schema Voyager is loading from a Datomic source. Expects the argument to be a [Datomic source](/doc/sources.md#datomic-source), that is, it should contain `:datomic/client-config` and `:datomic/db-name`. Useful mostly for debugging.
print-inferencesclj
(print-inferences {:keys [datomic/client-config datomic/db-name datomic/infer]})Print the supplemental attributes Schema Voyager infers from a Datomic source.
Read about how to invoke print-inferences in the inference
docs.
Running inferences is expensive (again, see the inference docs) so use this command to run the inferences once, copying the output to a file. In the future, use the file as a source, instead of re-running the inferences.
Expects the argument to be a Datomic source,
that is, it should contain :datomic/client-config and :datomic/db-name.
Specify what you would like to :datomic/infer, as explained in the
inference docs.
Print the supplemental attributes Schema Voyager infers from a Datomic source. Read about how to invoke [[print-inferences]] in the [inference docs](/doc/datomic-inference.md). Running inferences is expensive (again, see the [inference docs](/doc/datomic-inference.md)) so use this command to run the inferences once, copying the output to a file. In the future, use the file as a source, instead of re-running the inferences. Expects the argument to be a [Datomic source](/doc/sources.md#datomic-source), that is, it should contain `:datomic/client-config` and `:datomic/db-name`. Specify what you would like to `:datomic/infer`, as explained in the [inference docs](/doc/datomic-inference.md).
standaloneclj
(standalone {:keys [sources output-path]})Creates a standalone HTML page at output-path, after importing the sources
as per ingest-into-db.
This is the most common CLI function for app developers to call.
Read about how to invoke standalone in the usage
docs.
By default, the output-path is schema-voyager.html.
Creates a standalone HTML page at `output-path`, after importing the `sources` as per [[ingest-into-db]]. This is the most common CLI function for app developers to call. Read about how to invoke [[standalone]] in the [usage docs](/doc/installation-and-usage.md). By default, the `output-path` is `schema-voyager.html`.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close