Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
J
jio-main
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Hardik Juneja
jio-main
Commits
1a445a10
Commit
1a445a10
authored
Dec 27, 2013
by
Marco Mariani
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
minor fixes
parent
ce7d0972
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
20 additions
and
12 deletions
+20
-12
docs/complex_queries.rst
docs/complex_queries.rst
+3
-2
docs/getting_started.rst
docs/getting_started.rst
+10
-2
docs/index.rst
docs/index.rst
+0
-4
docs/manage_documents.rst
docs/manage_documents.rst
+6
-3
docs/metadata.rst
docs/metadata.rst
+1
-1
No files found.
docs/complex_queries.rst
View file @
1a445a10
jIO Complex Queries
===================
...
...
@@ -7,7 +8,7 @@ What are Complex Queries?
In jIO, a complex query can ask a storage server to select, filter, sort, or
limit a document list before sending it back. If the server is not able to do
so, the complex query tool can do the filtering by itself on the client. Only the
``allDocs()`` method can use complex queries.
``
.
allDocs()`` method can use complex queries.
A query can either be a string (using a specific language useful for writing
queries), or it can be a tree of objects (useful to browse queries). To handle
...
...
@@ -33,7 +34,7 @@ to run the query on the index before querying documents itself.
How to use Complex Queries with jIO?
------------------------------------
Complex queries can be triggered by including the option named **query** in the ``allDocs()`` method call.
Complex queries can be triggered by including the option named **query** in the ``
.
allDocs()`` method call.
Example:
...
...
docs/getting_started.rst
View file @
1a445a10
...
...
@@ -45,15 +45,23 @@ Getting started
You can use both handlers and available storages to build a storage
tree across which all documents will be maintained and managed by jIO.
See :ref:`List of Available Storages <list-of-available-storages>`.
.. code-block:: javascript
// create your jio instance
var my_jio = jIO.createJIO(storage_description);
You have to provide a ``storage_description`` object, providing location
and credentials.
Its format depends on the type of storage,
see :ref:`List of Available Storages <list-of-available-storages>`.
#. The jIO API provides ten main methods to manage documents across the storage(s) specified in your jIO storage tree.
For details on the ``document`` and ``attachment`` objects, see :ref:`What is a document? <what-is-a-document>`
======================= ======================================================
Method Example
======================= ======================================================
...
...
docs/index.rst
View file @
1a445a10
.. jIO documentation master file, created by
sphinx-quickstart on Fri Nov 15 11:55:08 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to jIO
==============
...
...
docs/manage_documents.rst
View file @
1a445a10
...
...
@@ -12,6 +12,9 @@ CouchDB provides a RESTful HTTP/JSON API accessible by many programming
libraries and tools (like `curl <http://curl.haxx.se/>`_ or `Pouchdb <http://pouchdb.com/>`_)
and has its own conflict management system.
.. _what-is-a-document:
What is a document?
-------------------
...
...
@@ -63,7 +66,7 @@ see how method calls should be made with either of these storages.
.. code-block:: javascript
// Create a new jIO instance
var jio_instance = jIO.createJIO(storage
tree
description);
var jio_instance = jIO.createJIO(storage
_
description);
// create and store new document
jio_instance.post({title: 'some title'}).
...
...
@@ -256,8 +259,8 @@ In case of error, the ``errorCallback`` first parameter will look like:
How to store
a video on localStorage
------------------------
------------
How to store
binary data
------------------------
The following example creates a new jIO in localStorage and then posts a document with two attachments.
...
...
docs/metadata.rst
View file @
1a445a10
...
...
@@ -11,7 +11,7 @@ The word "metadata" means "data about data". Metadata articulates a context for
objects of interest -- "resources" such as MP3 files, library books, or
satellite images -- in the form of "resource descriptions". As a tradition,
resource description dates back to the earliest archives and library catalogs.
During the Web revolution of the mid-1990s, `Dubli
c
Core <http://dublincore.org/metadata-basics/>`_
During the Web revolution of the mid-1990s, `Dubli
n
Core <http://dublincore.org/metadata-basics/>`_
has emerged as one of the prominent metadata standards.
Why use metadata?
...
...
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