ajrulez / sync-android

A JSON-based document datastore for Android applications

Cloudant Sync - Android Datastore

Applications use Cloudant Sync to store, index and query local JSON data on a device and to synchronise data between many devices. Synchronisation is under the control of the application, rather than being controlled by the underlying system. Conflicts are also easy to manage and resolve, either on the local device or in the remote database.

Cloudant Sync is an Apache CouchDB™ replication-protocol-compatible datastore for devices that don't want or need to run a full CouchDB instance. It's built by Cloudant, building on the work of many others, and is available under the Apache 2.0 licence.

The API is quite different from CouchDB's; we retain the MVCC data model but not the HTTP-centric API.

This library is for Android and Java SE; an iOS version is also available.

If you have questions, please join our mailing list and drop us a line.

Using in your project

Using the library in your project should be as simple as adding it as a dependency via maven or gradle.

There are currently four jar files for the datastore:

• cloudant-sync-datastore-core: the main datastore classes.
• cloudant-sync-datastore-android: Android specific classes.
• cloudant-sync-datastore-android-encryption: Android encryption specific classes.
• cloudant-sync-datastore-javase: Java SE specific classes.

Gradle

Add the maven repo and a compile time dependency on the datastore jar:

repositories {
    mavenLocal()
    maven { url "http://cloudant.github.io/cloudant-sync-eap/repository/" }
    mavenCentral()
}

dependencies {
    // Other dependencies
    compile group: 'com.cloudant', name: 'cloudant-sync-datastore-core', version:'0.13.4'
    // include this if you're targeting Android. If you also want datastore encryption
    // you will need to include cloudant-sync-datastore-android-encryption as well (see below).
    compile group: 'com.cloudant', name: 'cloudant-sync-datastore-android', version:'0.13.4'
    // include this if you're targeting Android and want datastore encryption. You will also need
    // cloudant-sync-datastore-android (see above).
    compile group: 'com.cloudant', name: 'cloudant-sync-datastore-android-encryption', version:'0.13.4'
    // include this if you're targeting Java SE
    compile group: 'com.cloudant', name: 'cloudant-sync-datastore-javase', version:'0.13.4'
}

You can see a fuller example in the sample application's build.gradle.

Maven

It's a similar story in maven, add the repo and the dependency:

<project>
  ...

  <repositories>
    ...
    <repository>
      <id>cloudant-sync-eap</id>
      <name>Cloudant Sync EAP</name>
      <url>http://cloudant.github.io/cloudant-sync-eap/repository/</url>
    </repository>
  </repositories>

  <dependencies>
    ...
    <dependency>
      <groupId>com.cloudant</groupId>
      <artifactId>cloudant-sync-datastore-core</artifactId>
      <version>0.13.4</version>
      <scope>compile</scope>
    </dependency>
    <!-- include this if you're targeting Android. If you also want datastore encryption
         you will need to include cloudant-sync-datastore-android-encryption as well (see below). -->
    <dependency>
      <groupId>com.cloudant</groupId>
      <artifactId>cloudant-sync-datastore-android</artifactId>
      <version>0.13.4</version>
      <scope>compile</scope>
    </dependency>
    <!-- include this if you're targeting Android and want datastore encryption. You will also need
         cloudant-sync-datastore-android (see above). -->
    <dependency>
      <groupId>com.cloudant</groupId>
      <artifactId>cloudant-sync-datastore-android-encryption</artifactId>
      <version>0.13.4</version>
      <scope>compile</scope>
    </dependency>
    <!-- include this if you're targeting Java SE -->
    <dependency>
      <groupId>com.cloudant</groupId>
      <artifactId>cloudant-sync-datastore-javase</artifactId>
      <version>0.13.4</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>

</project>

Note: Older versions than 0.3.0 had a separate Mazha jar. This was rolled into the main jar for distribution simplicity. The dependency needs removing from gradle and maven build files.

Tested Platforms

The library is regularly tested on the following platforms:

Android (via emulator):

• API Level 15
• API Level 16
• API Level 17
• API Level 18
• API Level 19
• API Level 21

Java:

• 1.8 (Java 8)

Example application

There is a sample application and a quickstart guide.

Overview of the library

Once the libraries are added to a project, the basics of adding and reading a document are:

import com.cloudant.sync.datastore.BasicDocumentRevision;
import com.cloudant.sync.datastore.DatastoreManager;
import com.cloudant.sync.datastore.Datastore;
import com.cloudant.sync.datastore.DatastoreNotCreatedException;
import com.cloudant.sync.datastore.DocumentBodyFactory;
import com.cloudant.sync.datastore.DocumentException;
import com.cloudant.sync.datastore.MutableDocumentRevision;
import com.cloudant.sync.datastore.UnsavedFileAttachment;

// Create a DatastoreManager using application internal storage path
File path = getApplicationContext().getDir("datastores", Context.MODE_PRIVATE);
DatastoreManager manager = new DatastoreManager(path.getAbsolutePath());

Datastore ds = manager.openDatastore("my_datastore");

// Create a document
MutableDocumentRevision revision = new MutableDocumentRevision();
Map<String, Object> body = new HashMap<String, Object>();
body.put("animal", "cat");
revision.body = DocumentBodyFactory.create(body);
BasicDocumentRevision saved = ds.createDocumentFromRevision(revision);

// Add an attachment -- binary data like a JPEG
MutableDocumentRevision update = saved.mutableCopy();  // BasicDocumentRevision is readonly
UnsavedFileAttachment att1 = new UnsavedFileAttachment(new File("/path/to/image.jpg"),
                                                       "image/jpeg");
update.attachments.put(att1.name, att1);
BasicDocumentRevision updated = ds.updateDocumentFromRevision(update);

// Read a document
BasicDocumentRevision aRevision = ds.getDocument(updated.getId());

Read more in the CRUD document.

You can also subscribe for notifications of changes in the database, which is described in the events documentation.

Replicating Data Between Many Devices

Replication is used to synchronise data between the local datastore and a remote database, either a CouchDB instance or a Cloudant database. Many datastores can replicate with the same remote database, meaning that cross-device synchronisation is achieved by setting up replications from each device the the remote database.

Replication is simple to get started in the common cases:

import com.cloudant.sync.replication.ReplicationFactory;
import com.cloudant.sync.replication.Replicator;

URI uri = new URI("https://apikey:[email protected]/my_database");
Datastore ds = manager.openDatastore("my_datastore");

// Replicate from the local to remote database
Replicator replicator = ReplicatorBuilder.push().from(ds).to(uri).build();

// Fire-and-forget (there are easy ways to monitor the state too)
replicator.start();

Read more in the replication docs.

Finding data

Once you have thousands of documents in a database, it's important to have efficient ways of finding them. We've added an easy-to-use querying API. Once the appropriate indexes are set up, querying is as follows:

Map<String, Object> query = new HashMap<String, Object>();
query.put("name", "mike");
query.put("pet", "cat");
QueryResult result = indexManager.find(query);

for (DocumentRevision revision : result) {
    // do something
}

See Index and Querying Data.

For information about migrating your legacy indexing/query code to the new Cloudant Query - Android implementation.

See Index and Querying Migration

Conflicts

An obvious repercussion of being able to replicate documents about the place is that sometimes you might edit them in more than one place at the same time. When the databases containing these concurrent edits replicate, there needs to be some way to bring these divergent documents back together. Cloudant's MVCC data-model is used to do this.

A document is really a tree of the document and its history. This is neat because it allows us to store multiple versions of a document. In the main, there's a single, linear tree -- just a single branch -- running from the creation of the document to the current revision. It's possible, however, to create further branches in the tree. At this point your document is conflicted and needs some surgery to resolve the conflicts and bring it back to full health.

Learn more about this essential process in the conflicts documentation.

Known Issues

Some users on certain older versions of Android have reported the following exception:

java.lang.NoClassDefFoundError: javax/annotation/Nullable

To fix this issue, add the following dependency to your application's build.gradle:

compile 'com.google.code.findbugs:jsr305:3.0.0'

Contributors

See CONTRIBUTORS.

Contributing to the project

See CONTRIBUTING.

License

See LICENSE.