Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Srinivasan Ramesh
sonata
Commits
a99368df
Commit
a99368df
authored
Apr 03, 2020
by
Matthieu Dorier
Browse files
added readme
parent
3b322895
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
a99368df
# What is Sonata?
Sonata is a remotely-accessibl JSON document store based on UnQLite and on
the Mochi suit of libraries. It enables managing collections of JSON records,
searching through them, and running Jx9 scripts on them.
# Got some examples?
A comprehensive set of examples is available in
[
this directory
](
examples
)
.
# How do I install Sonata?
The easiest way to install Sonata is to use
[
spack
](
https://spack.readthedocs.io
)
.
Once you have spack installed and setup on your machine, you need to added the
mochi namespace to it, as follows.
```
git clone https://xgitlab.cels.anl.gov/sds/sds-repo.git
spack repo add sds-repo
```
You can now install Sonata as follows.
```
spack install mochi-sonata
```
# And then?
Sonata comes in three libraries: sonata-server, sonata-client, and sonata-admin.
The server library contains the
`sonata::Provider`
class, which allows to start
a Sonata service on a server program. The admin library contains the
`sonata::Admin`
class, which enables creating and destroying database on a
running provider. The
`sonata::Client`
class is contained in the client library.
This class provides the main interface to open a database, and manipulat
collections.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment