schema-voyager.ingest.datomic — com.github.mainej/schema-voyager 2.0.240

Ingest schema data directly from a Datomic database.

A running Datomic database is the authority on which attributes are installed, so many projects will want to ingest schema data from it.

To use this namespace, datomic.client.api must be on your classpath.

cli-attributes clj

(cli-attributes {:keys [client-config db-name exclusions]})

A shorthand, used by the CLI, for connecting to a Datomic database (with datomic-db) and extracting installed attributes (with ingest).

See excluded-attr? for information about how to use exclusions.

cli-inferences clj

(cli-inferences {:keys [client-config db-name infer]})

A shorthand, used by the CLI, for connecting to a Datomic database (with datomic-db) and inferring deprecations and/or references from db usage (with infer).

Specify what you would like to infer, as explained in the inference docs, heeding the warnings there.

cli-ingest clj

(cli-ingest {:keys [client-config db-name infer exclusions]})

A shorthand, used by the CLI, for connecting to a Datomic database, ingesting and making inferences all in one step. Essentially the same as running cli-attributes and cli-inferences at the same time.

Before calling with the infer param, see the warnings in the inference docs.

datomic-coll-exclusions clj

These are collections installed by Datomic itself, as of release 480-8770. Typically, you don't want to document them, so they are excluded by default, along with all of their attributes. You can re-enable certain attributes or constants, and their associated collection, by passing datomic-entity-inclusions to ingest.

datomic-db clj

(datomic-db client-config db-name)

Get the current value of the Datomic db db-name, using a client described by client-config.

excluded-attr? clj

(excluded-attr?
  attr
  {:keys [entity-exclusions coll-exclusions datomic-entity-inclusions]
   :or
     {entity-exclusions #{} coll-exclusions #{} datomic-entity-inclusions #{}}})

Individual attributes can be ignored by including their :db/ident in entity-exclusions. Entire collections worth of attributes can be ignored by including the collection in coll-exclusions. Attributes installed by Datomic itself are excluded unless they are part of datomic-entity-inclusions.

infer clj

(infer db infer)

Infer deprecations and/or references from db usage.

This is a unified interface for calling the other more specialized infer-* methods.

Before using, see the warnings in the inference docs.

infer-deprecations clj

(infer-deprecations db)

(infer-deprecations db exclusions)

Infer that attributes and constants that do not appear on any entities are deprecated.

Ignores attributes that are excluded per the exclusions. See excluded-attr?.

Before using, see the warnings in the inference docs.

infer-heterogeneous-tuple-references clj

(infer-heterogeneous-tuple-references db)

(infer-heterogeneous-tuple-references db exclusions)

Infer references from heterogeneous tuple attributes by inspecting the things to which they refer.

Ignores attributes that are not in-use and attributes that are excluded per the exclusions. See excluded-attr?.

Before using, see the warnings in the inference docs.

infer-homogeneous-tuple-references clj

(infer-homogeneous-tuple-references db)

(infer-homogeneous-tuple-references db exclusions)

Infer references from homogeneous tuple attributes by inspecting the things to which they refer.

Ignores attributes that are not in-use and attributes that are excluded per the exclusions. See excluded-attr?.

NOTE: Makes a (large) assumption. Each item in the tuple could refer to different types of entities. This function assumes that the first item in the tuple can and will refer to all the interesting types. That means that if collection-a never appears in the first item of the tuple, this will fail to infer that collection-a is a reference. Of course, if your data is structured that way, perhaps you would be better suited by a heterogeneous tuple.

Before using, see the warnings in the inference docs.

infer-plain-references clj

(infer-plain-references db)

(infer-plain-references db exclusions)

Infer references between :db.type/ref attributes by inspecting the things to which they refer.

Ignores attributes that are not in-use and attributes that are excluded per the exclusions. See excluded-attr?.

Before using, see the warnings in the inference docs.

infer-references clj

(infer-references db)

(infer-references db exclusions)

Infer references between ref and tuple attributes by inspecting the things to which they refer.

Ignores attributes that are not in-use and attributes that are excluded per the exclusions. See excluded-attr?.

Before using, see the warnings in the inference docs.

ingest clj

(ingest db)

(ingest db exclusions)

Converts all attributes from a Datomic database db into the form that schema-voyager.ingest.core/process expects.

Ignores attributes that are excluded per the exclusions. See excluded-attr?.