To set up jIO, include the source file, dependencies and connectors for the storages you plan to use in your page header (dependencies vary depending on the types of storages being used):
To set up jIO include jio.js, dependencies and the connectors for the storages
```
you want to use in your page header (note that more dependencies may be required
<!-- jio core-->
depending on type of storages being used):
<script src="jio.js"></script>
<!-- jio dependencies-->
<!-- jio + dependency -->
<script src="md5.js"></script>
<script src="md5.js"></script>
<!-- jio storage connectors -->
<script src="jio.js"></script>
<script src="localstorage.js">
<!-- jio storage libraries -->
<script ...>
<script src="localstorage.js">
<!-- jio complex queries -->
<script src="revisionstorage.js">
<script src="jio.complex_queries.js"></script>
<script ...>
```
Then create your jIO instance like this:
Then create your jIO instance like this:
```
var jio = jIO.newJio({
// create a new jio (type = localStorage)
var jio = jIO.newJio({
"type": "local",
"type": "local",
"username": "your_username",
"username": "your_username",
"application_name": "your_application_name"
"application_name": "your_application_name"
});
});
```
Documents and Methods
## Documents and Methods
-------------------------------------------------
Documents are JSON strings that contain <em><u>meta-data</u></em>
(properties, e.g. filename) and <em><u>attachments</u></em> (optional content, e.g. a base64-encoded image).
jIO exposes the following methods to <em><u>create</u></em>,
Documents are JSON strings that contain _meta-data_ (properties, like a filename)
<em><u>read</u></em>, <em><u>update</u></em> and <em><u>delete</u></em> documents:
and _attachments_ (optional content, for example a base64 encoded image).
```
jIO exposes the following methods to _create_, _read_, _update_ and _delete_ documents
// create and store new document
(for more information, including revision management and available options for
jio.post({"title":"some title"}, function (err, response) {
each method, please refer to the documentation):
// create and store new document
jio.post({"title": "some title"}, function (err, response) {
// console.log(response):
// console.log(response):
// {"ok":"true", "id":"cabc9...826" }
// {"ok": "true", "id": "cabc9...826" }
});
});
// create or update an existing document
// create or update an existing document
jio.put({"_id":"demoID", "title":"new title"}, function (err, response) {
jio.put({"_id": "my_document", "title": "New Title"}, function (err, response) {
// console.log(response):
// console.log(response):
// {"ok":"true", "id":"demoID" }
// {"ok": "true", "id": "my_document"}
});
});
// add an attachement to a document (Note: no underscore on id!)
For more information on the methods and additional options (e.g. revision management, please refer to the documentation).
## Example
Example
This is an example of how to store a video file with one attachment in local
-------------------------------------------------
storage . Note that attachments should best be added inside one of the available
This is an example of how to store a video file with an attachment in
document callback methods (success & error or callback)
local storage. Note that attachments should best be added inside one of the available document callback methods (success & error or callback).
```
// create a new localStorage
// create a new localStorage
var jio = JIO.newJio({
var jio = JIO.newJio({
"type":"local",
"type":"local",
"username":"user",
"username":"user",
"application_name":"app"
"application_name":"app"
});
});
// post the document
// post the document
jio.post(
jio.post({
{
"_id" : "myVideo",
"_id" : "myVideo",
"title" : "My Video",
"title" : "My Video",
"videoCodec" : "vorbis",
"videoCodec" : "vorbis",
"language" : "en",
"language" : "en",
"description" : "Images Compilation"
"description" : "Images Compilation"
},
}, function (err, response) {
function (err, response) {
if (err) {
if (err) {
alert('Error when posting the document description');
alert('Error when posting the document description');
} else {
} else {
// if successful, add video attachment (base64 encoded)
// if successful, add video attachment (base64 encoded)
jio.putAttachment(
jio.putAttachment({
{
"_id": "myVideo/video",
"id": "myVideo/video",
"_data": Base64(my_video),
"data": Base64(my_video),
"_mimetype":"video/ogg"
"mimetype":"video/ogg"
}, function (err, response) {
},
function (err, response) {
if (err) {
if (err) {
alert('Error when attaching the video');
alert('Error when attaching the video');
} else {
} else {
alert('Video Stored');
alert('Video Stored');
}
}
});
}
}
);
});
}
}
## Storage Locations
);
```
jIO allows to build "storage trees" consisting of connectors to multiple
Storage Locations
storages (webDav, xWiki, S3, localStorage) and use type-storages to add features
-------------------------------------------------
like revision management or indices to a child storage (sub_storage).
jIO allows to build "storage trees" consisting of connectors to multiple storages (webDav, xWiki, S3, localStorage) and use storage handlers to add features like revision management or indices to a child storage (sub_storage).
The following storages are currently supported:
The following storages are currently supported:
**DummyStorage (custom storage prototype)**
DummyStorage (custom storage prototype)
```
// initialize a dummy storage
// initialize a dummy storage
var jio = JIO.newJio({
var jio = JIO.newJio({
"type": <string>
"type": <string>
});
});
```
**LocalStorage (browser local storage)**
LocalStorage (browser local storage)
```
// initialize a local storage
// initialize a local storage
var jio = JIO.newJio({
var jio = JIO.newJio({
"type" : "local",
"type" : "local",
"username" : <string>,
"username" : <string>,
"application_name" : <string>
"application_name" : <string>
});
});
```
**DAVStorage (connect to webDAV)**
DAVStorage (connect to webDAV)
```
// initialize a webDAV storage
// initialize a webDAV storage
var jio = JIO.newJio({
var jio = JIO.newJio({
"type" : "dav",
"type" : "dav",
"username" : <string>,
"username" : <string>,
"password" : <string>,
"password" : <string>,
"application_name" : <string>,
"url" : <string>
"url" : <string>
});
});
```
**xWiki storage (connect to xWiki)**
xWiki storage (connect to xWiki)
```
// initialize a connection to xWiki storage
// initialize a connection to xWiki storage
coming soon
coming soon
```
**S3 storage (connect to S3)**
S3 storage (connect to S3)
```
// initialize a connection to S3 storage
// initialize a connection to S3 storage
coming soon
coming soon
```
**IndexStorage (maintains indices of documents in a substorage)**
IndexStorage (maintains indices of documents in a substorage)
```
// initialize an indexStorage (for a local storage)
// initialize an indexStorage (for a local storage)
var jio = JIO.newJio({
var jio = JIO.newJio({
"type": "indexed",
"type": "indexed",
"sub_storage": {
"sub_storage": {
"type": "local",
"type": "local",
...
@@ -187,35 +198,35 @@ var jio = JIO.newJio({
...
@@ -187,35 +198,35 @@ var jio = JIO.newJio({
{"name":<string>, "fields":[<string A>]},
{"name":<string>, "fields":[<string A>]},
{"name":<string>, "fields":[<string A>, <string B>]}
{"name":<string>, "fields":[<string A>, <string B>]}
**Replicate Revision Storage (replicate documents across multiple storages)**
Replicate Revision Storage (replicate documents across multiple storages)
```
// initialize a replicate revision storage (with local, webDAV as substorages)
// initialize a replicate revision storage (with local and webDAV as substorages)
var jio = JIO.newJio({
var jio = JIO.newJio({
"type": "replicaterevision",
"type": "replicaterevision",
"storage_list": [{
"storage_list": [{
"type": "revision",
"type": "revision",
...
@@ -224,98 +235,83 @@ var jio = JIO.newJio({
...
@@ -224,98 +235,83 @@ var jio = JIO.newJio({
"username": <string>,
"username": <string>,
"application_name": <string>
"application_name": <string>
}
}
},{
}, {
"type": "revision",
"type": "revision",
"sub_storage": {
"sub_storage": {
"type" : "dav",
"type" : "dav",
"username" : <string>,
"username" : <string>,
"password" : <string>,
"password" : <string>,
"application_name" : <string>,
"url" : <string>
"url" : <string>
}
}
}]
}]
});
});
```
For more information on the specific storages including guidelines on how to create your own connector, please refer to the documentation.
For more information on the specific storages including guidelines on how to create your own connector, please also refer to the documentation.
Complex Queries
## Complex Queries
-------------------------------------------------
jIO includes a complex-queries manager, which can be run on top of the
jIO includes a complex-queries manager, which can be run on top of the allDocs()
<em>allDocs()</em> method to query documents in the storage tree. A
method to query documents in the storage tree. A sample query would look like
sample query would look like this (note, that <em>allDocs</em> and complex queries cannot be run on every storage and that pre-querying of documents on distant storages should best be done server-side):
this (note, that allDocs and complex queries cannot be run on every storage and
that pre-querying of documents on distant storages should best be done
```
server-side):
// run allDocs with query option on an existing jIO
jio.allDocs({
// run allDocs with query option on an existing jIO
jio.allDocs({
"query":{
"query":{
"query":'(fieldX: >= <string> AND fieldY: < <string>)',
"query": '(fieldX: >= <string> AND fieldY: < <string>)',
"filter": {
"filter": {
// records to display ("from to")
// records to display ("from to")
"limit":[0,5],
"limit": [0, 5],
// sort by
// sort by
"sort_on":[[<string A>,'descending']],
"sort_on": [[<string A>, 'descending']],
// fields to return in response
// fields to return in response
"select_list":[<string A>;,<string B>]
"select_list": [<string A>, <string B>]
},
},
"wildcard_character":'%'
"wildcard_character": '%'
}
}
},function(err, response){
}, function (err, response) {
// console.log(response):
// console.log(response):
// [{
// [{
// "id": <string>,
// "id": <string>,
// <string A>: <string>,
// <string A>: <string>,
// <string B>: <string>
// <string B>: <string>
// }]
// }]
}
});
});
```
To find out more about complex queries, please refer to the documentation
Task Management
-------------------------------------------------
### Task Management
jIO is running a task queue manager in the background which processes
incoming tasks according to set of defined rules. To find out
jIO is running a task queue manager in the background which processes incoming
more and including how to define your own execution rules, please refer to the documentation.
tasks according to set of defined rules. To find out more and including how to
define your own execution rules, please refer to the
As jIO allows to manage and share documents across multiple storage
### Conflict Management
locactions it is likely for conflicts to occur (= multiple versions of a single document existing in the storage tree). jIO manages conflicts by ensuring that every version of a document is available on every storage and that conflicts are accessible (and solvable) using the <em><u>conflicts:true</u></em> option when using the respective jIO methods. For more info on conflicts and available options, please refer to the documentation.
As jIO allows to manage and share documents across multiple storage locactions
Crash-Proof
it is likely for conflicts to occur (= multiple versions of a single document
-------------------------------------------------
existing in the storage tree). jIO manages conflicts by ensuring that every
All tasks are managed inside the browser local storage so no data is lost, as the task manager queue will persist through browser crashes and continues to run when the page is reloaded after a browser crash.
version of a document is available on every storage and that conflicts are
accessible (and solvable) using the `conflicts: true` option when using the
Authors
respective jIO methods. For more info on conflicts and available options, please
-------------------------------------------------
refer to the documentation.
+ Francois Billioud
+ Tristan Cavelier
### Crash-Proof
Copyright and license
All tasks are managed inside the browser local storage so no data is lost, as
-------------------------------------------------
the task manager queue will persist through browser crashes and continues to run
jIO is an open-source library and is licensed under the LGPL license. More information on LGPL can be found <ahref="http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License">here</a>.
when the page is reloaded after a browser crash.
Documentation
### Authors
=============
You can find the full documentation here: [jIO Documentation](http://www.j-io.org/documentation).
- Francois Billioud
- Tristan Cavelier
For developers
- Sven Franck
==============
Quick start
### Copyright and license
-------------------------------------------------
To get started with jIO, clone one of the repositories on
jIO is an open-source library and is licensed under the LGPL license. More
jIO uses a <ahref="http://git.erp5.org/gitweb/jio.git/blob_plain/HEAD:/Makefile?js=1">makeFile</a> to build and compress the necessary files (jIO.js and complex-queries.js). To run the makeFile you will require the following:
The repository also includes the built ready-to-use files, so in case you do not want to build jIO yourself, just use <em>jio.min.js</em> as well as <em>complex-queries.min.js</em> plus the storages and dependencies you need and you will be good to go.
You can also check out the jIO QUnit tests (jiotests_withoutrequirejs.html) for an overview on how to create a page
[setup](http://git.erp5.org/gitweb/jio.git/blob/HEAD:/test/jiotests_withoutrequirejs.html?js=1) with required scripts as well as setting up jIO itself
[setup](http://git.erp5.org/gitweb/jio.git/blob/HEAD:/test/jiotests.js?js=1). If you want to run the QUnit tests
locally after cloning the repo, please make sure you have the above minified files in your repository.
