https://github.com/ivarref/datomic-schema
Simplified writing of Datomic schemas.
https://github.com/ivarref/datomic-schema
clojure datomic
Last synced: about 1 month ago
JSON representation
Simplified writing of Datomic schemas.
- Host: GitHub
- URL: https://github.com/ivarref/datomic-schema
- Owner: ivarref
- License: epl-1.0
- Created: 2018-05-07T13:37:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-14T21:06:05.000Z (over 5 years ago)
- Last Synced: 2025-03-28T12:38:26.080Z (about 2 months ago)
- Topics: clojure, datomic
- Language: Clojure
- Homepage:
- Size: 39.1 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# datomic-schema
Simplified writing of [Datomic schemas](https://docs.datomic.com/on-prem/schema.html).
## Installation
[](http://clojars.org/ivarref/datomic-schema)
Add `[ivarref/datomic-schema "0.2.0"]` to your dependency vector.
## Syntax
The syntax is
```
#d/schema[[attribute-name cardinality? type toggles* docstring?]*]
attribute-name = The name of your attribute
cardinality = :one or :many. Defaults to :one
type = A type from the list below
toggles = Zero or more toggles
docstring = An optional documentation string
type = :bigdec
| :bigint
| :boolean
| :bytes
| :double
| :float
| :instant
| :keyword
| :long
| :ref
| :string
| :symbol
| :uri
| :uuid
| tuple-type
tuple-type = Composite tuple: a 2-8 length vector referring other attributes
| Heterogeneous fixed length tuples: a 2-8 length vector referring scalar types such as :long, :string, etc.
| Homogeneous variable length tuples: a 1 length vector referring a single scalar type.
toggles = :component
| :fulltext
| :id ; alias for :identity
| :identity
| :index
| :indexed ; alias for :index
| :no-history
| :unique
Enums are also supported: #d/schema [[attribute-name :enum]]
```
## Example usage from REPL
```clojure
(require 'datomic-schema.core) ; namespace needs to be required so that reader literal is loaded
#d/schema [[:entity/attr :one :string "Documentation"]]
=> [#:db{:ident :entity/attr
:cardinality :db.cardinality/one
:valueType :db.type/string
:doc "Documentation"}]
#d/schema [[:entity/attr :string]] ; default cardinality is :one
=> [#:db{:ident :entity/attr
:cardinality :db.cardinality/one
:valueType :db.type/string}]
#d/schema [[:entity/attr :many :long]] ; cardinality :many
=> [#:db{:ident :entity/attr
:cardinality :db.cardinality/many
:valueType :db.type/long}]
#d/schema [[:entity/id :uuid :id]] ; use :id toggle for :db.unique/identity
=> [#:db{:ident :entity/id
:cardinality :db.cardinality/one
:valueType :db.type/uuid
:unique :db.unique/identity}]
#d/schema [[:e/id :uuid :id]
[:e/info :string]] ; multiple attribute definitions
=> [#:db{:ident :e/id :cardinality :db.cardinality/one :valueType :db.type/uuid :unique :db.unique/identity}
#:db{:ident :e/info :cardinality :db.cardinality/one :valueType :db.type/string}]
#d/schema [[:entity/attr :enum]] ; enums
=> [#:db{:ident :entity/attr}]
```
and so forth.
## Example usage with conformity
In order to use this library with [conformity](https://github.com/rkneufeld/conformity),
you will need to require the namespace so that the reader literal is loaded before `conformity` runs.
Add the following file to `resources/`:
```
;; resources/something.edn
{:my-project/something-schema
{:txes [#d/schema[[:something/title :one :string]
[:something/author :one :uuid]]]}}
```
Then in your code:
```clojure
(ns my-project.something
(:require [datomic-schema.core] ; namespace needs to be required so that reader literal is loaded
[io.rkn.conformity :as c]
[datomic.api :as d]))
(def uri "datomic:mem://my-project")
(d/create-database uri)
(def conn (d/connect uri))
(def norms-map (c/read-resource "something.edn"))
(println (str "Has attribute? " (c/has-attribute? (d/db conn) :something/title)))
(c/ensure-conforms conn norms-map [:my-project/something-schema])
(println (str "Has attribute? " (c/has-attribute? (d/db conn) :something/title)))
```
## Example development usage
```clojure
(ns dato-ivre.dev-demo
(:require [datomic.api :as d]
[datomic-schema.core])) ; namespace needs to be required so that reader literal is loaded
(defn create-empty-in-memory-db []
(let [uri "datomic:mem://pet-owners-test-db"]
(d/delete-database uri)
(d/create-database uri)
(let [conn (d/connect uri)]
conn)))
(def conn (create-empty-in-memory-db))
@(d/transact conn #d/schema[[:m/id :string :id]
[:m/info :string]])
@(d/transact conn [{:m/id "id1" :m/info "Hello"}]) ; upsert (insert)
@(d/transact conn [{:m/id "id1" :m/info "Hello2"}]) ; upsert (update)
(println (d/pull (d/db conn) '[:*] [:m/id "id1"]))
; {:db/id 17592186045418, :m/id id1, :m/info Hello2}
```
## Acknowledgements
This project is derived from [cognitect-labs/vase](https://github.com/cognitect-labs/vase).
Please see their [LICENSE](https://github.com/cognitect-labs/vase/blob/master/LICENSE).
## License
Copyright © 2015-2017 Cognitect, Inc. All rights reserved.
Copyright © 2018-2020 Ivar Refsdal.
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.