Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenyouse/multco
cljs databases across platforms
https://github.com/greenyouse/multco
Last synced: 2 days ago
JSON representation
cljs databases across platforms
- Host: GitHub
- URL: https://github.com/greenyouse/multco
- Owner: greenyouse
- Created: 2015-03-11T08:18:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-04-13T01:26:38.000Z (over 9 years ago)
- Last Synced: 2024-03-07T11:42:57.650Z (7 months ago)
- Language: Clojure
- Homepage:
- Size: 230 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Multco
This library adds cross-platform persistence to existing ClojureScript
databases. It uses a storage polyfill with support for IndexedDB,
WebSQL, Web Storage, and UserData, so it works just about everywhere.
Right now it covers:
* [pldb](https://github.com/clojure/core.logic)
* [bacwn](https://github.com/fogus/bacwn)
* [datascript](https://github.com/tonsky/datascript)
## Installation
Add this dependency to your project.clj:
[](http://clojars.org/com.greenyouse/multco)
## Usage
The main feature of this library is a `db-atom`, which can hold either a
pldb, bacwn, or datascript database in memory and cache any db changes
into clientside storage (either IndexedDB, WebSQL, Web Storage, or
UserData depending on what's available). There are three types of
db-atoms that match their library names:
* `pldb-atom`
* `bacwn-atom`
* `datascript-atom`
When your program starts, load the database using one of these
db-atoms. This will either load a given data template, if the program
database has never been altered, or reload the lastest state of your
program.
```clj
(ns super-app.core
(:require [multco.core :as multco]))
(def app-atom
(multco/pldb-atom "app-name" "my-db" :facts
[[example foo bar]])
```
This means persistent clientside storage for your app! The database is
loaded into memory and stored in a special variation of an atom
(`app-atom` in the above example). Subsequent additions or retractions to
your database will be saved to the client-side storage and the in-memory
database.
To add data use `add-facts!`:
```clj
(multco/add-facts! app-atom [some new fact(s)])
```
To remove data use `rm-facts!`:
```clj
(multco/remove-facts! app-atom [rm some fact(s)])
```
A database can also be reset using `reset-facts!`:
```clj
(multco/reset-facts! app-atom [new fact(s) to use])
```
If you need to delete things, `clear` will empty a database and `rm-db`
will remove a database from clientside storage.
```clj
(multco/clear app-atom)
(multco/rm-db app-atom)
```
## Examples
Check the example folder for fun demos that cover each library.
## License
Copyright © 2015 greenyouse
Distributed under the [BSD 2-Clause License](http://www.opensource.org/licenses/BSD-2-Clause).