Compile

April 1, 2025 · View on GitHub

= The SQL Graph in Clojure

Utilizes Tinkerpop3 graph over SQL database using sqlg.

image:https://img.shields.io/github/license/fern-flower-lab/sqlg-clj?style=for-the-badge[GitHub] image:https://img.shields.io/clojars/v/ai.z7/sqlg-clj.svg?style=for-the-badge[] image:https://img.shields.io/github/v/tag/fern-flower-lab/sqlg-clj?style=for-the-badge[GitHub tag (latest by date)] image:https://img.shields.io/github/last-commit/fern-flower-lab/sqlg-clj?style=for-the-badge[GitHub last commit] image:https://img.shields.io/github/v/release/fern-flower-lab/sqlg-clj?style=for-the-badge[GitHub release (latest by date)]

WARNING: Origin's library uses J17 for releases (at least for 3.0.x versions), so independently on this Clojure library build you will be forced to use that version too.

== Installation

Add this dependency to your project.clj:

[ai.z7/sqlg-clj "0.1.0"]

This library supports multiple versions of the SQLG library. To specify which version you want to use, activate the appropriate profile:

For SQLG 3.1.1 (latest): [source,shell]

For SQLG 3.0.4: [source,shell]

For SQLG 3.0.1: [source,shell]

For SQLG 2.1.6 (legacy): [source,shell]

For development with logging enabled: [source,shell]

lein with-profile +dev,+logging,+lib-3.1.1

== Supported DBs

. PostgreSQL . MySQL . MariaDB . HSQLDB . H2 . MSSQL

CAUTION: The low-level driver is well tested only with PostgreSQL + C3P0. You are warned.

== Config

Basic config is represented by sample.properties

sample.graph.db.type = postgresql sample.graph.db.host = localhost sample.graph.db.port = 5432 sample.graph.db.name = sample sample.graph.db.user = username sample.graph.db.pass = password

In order to get it prepared use

user=> (require '[sqlg-clj.config :as c]) user=> (def config (-> "sample" c/load-config :sample :graph :db c/db-config))

Same result may be done using EDN config, i.e. directly from your app:

user=> (def config (c/db-config {:port 5432 :pass "password" :user "username" :type "postgresql" :host "localhost" :name "sample"}))

When the config is ready it may be easily read back

user=>(c/config->clj config) {"jdbc.url" "jdbc:postgresql://localhost:5432/sample", "jdbc.username" "username", "jdbc.password" "password"}

=== Starting

Open SqlgGraph directly

The last method opens a new TinkerGraph with default configuration or open a new Graph instance with the specified configuration. The configuration may be a path to a file or a Map of configuration options. When gets prepared BaseConfiguration or Configuration object as an argument - returns SqlgGraph.

=== Using

[source,clojure]

user=> (require '[sqlg-clj.core :refer :all]) user=> (-> ^Graph G traversal V (has-label "label")) #object[org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.DefaultGraphTraversal 0x3fffba3f "[GraphStep(vertex,[]), HasStep([~label.eq(label)])]"]

=== Transactions

In order to store or to unroll the changes were made by some iteration between calls, use

[source,clojure]

user=> (require '[sqlg-clj.util :as u]) user=> (u/commit! G) ;; or user=> (u/rollback! G)

respectively.

=== Examples

==== create, find, process

[source,clojure]

user=> (require '[sqlg-clj.util :as u]) user=> (require '[sqlg-clj.data :as d]) user=> (require '[sqlg-clj.core :refer :all])

user=> (-> G (d/add-V :test {:aa 11 :bb 22})) #object[org.umlg.sqlg.structure.SqlgVertex 0x2e5e87e9 "v[public.test:::14]"] user=> (-> G (d/add-V :test {:aa 33 :cc 44})) #object[org.umlg.sqlg.structure.SqlgVertex 0x6ec0ead1 "v[public.test:::15]"] user=> (u/commit! G) nil

user=> (def vxs (-> G traversal V (has-label :test) (has :aa) u/into-vec!)) #'user/vxs