https://github.com/replikativ/konserve-jdbc
A JDBC backend for konserve.
https://github.com/replikativ/konserve-jdbc
clojure jdbc konserve
Last synced: about 2 months ago
JSON representation
A JDBC backend for konserve.
- Host: GitHub
- URL: https://github.com/replikativ/konserve-jdbc
- Owner: replikativ
- License: epl-2.0
- Created: 2021-10-05T07:50:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T15:36:05.000Z (2 months ago)
- Last Synced: 2025-04-06T00:59:58.157Z (about 2 months ago)
- Topics: clojure, jdbc, konserve
- Language: Clojure
- Homepage:
- Size: 107 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yaml
- License: LICENSE
Awesome Lists containing this project
README
# konserve-jdbc
A [JDBC](https://github.com/clojure/java.jdbc) backend for [konserve](https://github.com/replikativ/konserve).
## Usage
Add to your dependencies:
[](http://clojars.org/io.replikativ/konserve-jdbc)
### Synchronous Execution
``` clojure
(require '[konserve-jdbc.core :refer [connect-jdbc-store]]
'[konserve.core :as k])
(def db-spec
{:dbtype "sqlite"
:dbname "./tmp/sql/konserve"})
(def store (connect-jdbc-store db-spec :opts {:sync? true}))
(k/assoc-in store ["foo" :bar] {:foo "baz"} {:sync? true})
(k/get-in store ["foo"] nil {:sync? true})
(k/exists? store "foo" {:sync? true})
(k/assoc-in store [:bar] 42 {:sync? true})
(k/update-in store [:bar] inc {:sync? true})
(k/get-in store [:bar] nil {:sync? true})
(k/dissoc store :bar {:sync? true})
(k/append store :error-log {:type :horrible} {:sync? true})
(k/log store :error-log {:sync? true})
(let [ba (byte-array (* 10 1024 1024) (byte 42))]
(time (k/bassoc store "banana" ba {:sync? true})))
(k/bassoc store :binbar (byte-array (range 10)) {:sync? true})
(k/bget store :binbar (fn [{:keys [input-stream]}]
(map byte (slurp input-stream)))
{:sync? true})
```
### Asynchronous Execution
``` clojure
(ns test-db
(require '[konserve-jdbc.core :refer [connect-jdbc-store]]
'[clojure.core.async :refer [ konserve
(def store-b (connect-jdbc-store cfg-b :opts {:sync? true})) ;; table name => water
(def store-c (connect-jdbc-store cfg-b :table "fire" :opts {:sync? true})) ;;table name => fire
``````
## Supported Databases
**BREAKING CHANGE**: konserve-jdbc versions after `0.1.79` no longer include
actual JDBC drivers. Before you upgrade please make sure your application
provides the necessary dependencies.
Not all databases available for JDBC have been tested to work with this implementation.
Other databases might still work, but there is no guarantee. Please see working
drivers in the dev-alias in the `deps.edn` file.
If you are interested in another database, please feel free to contact us.
Fully supported so far are the following databases:
1) PostgreSQL
``` clojure
(def pg-cfg {:dbtype "postgresql"
:dbname "konserve"
:host "localhost"
:user "user"
:password "password"})
(def pg-url {:dbtype "postgresql"
:jdbcUrl "postgresql://user:password@localhost/konserve"})
```
2) MySQL
``` clojure
(def mysql-cfg {:dbtype "mysql"
:dbname "konserve"
:host "localhost"
:user "user"
:password "password"})
(def mysql-url {:dbtype "mysql"
:jdbcUrl "mysql://user:password@localhost/konserve"})
```
3) SQlite
``` clojure
(def sqlite {:dbtype "sqlite"
:dbname "/konserve"})
```
4) SQLserver
``` clojure
(def sqlserver {:dbtype "sqlserver"
:dbname "konserve"
:host "localhost"
:user "sa"
:password "password"})
```
5) MSSQL
``` clojure
(def mssql {:dbtype "mssql"
:dbname "konserve"
:host "localhost"
:user "sa"
:password "password"})
```
6) H2
``` clojure
(def h2 {:dbtype "h2"
:dbname "tmp/konserve;DB_CLOSE_ON_EXIT=FALSE"
:user "sa"
:password ""})
```
## Commercial support
We are happy to provide commercial support with
[lambdaforge](https://lambdaforge.io). If you are interested in a particular
feature, please let us know.
## License
Copyright © 2021-2022 Judith Massa, Alexander Oloo
Licensed under Eclipse Public License (see [LICENSE](LICENSE)).