CouchDB Java

A CouchDB Java library that is (mostly) uncoupled from any particular JSON library.

There are many outdated CouchDB libraries, and some more up to date CouchDB libraries for Java. Some of these libraries are tightly coupled to JSON libraries such as GSON or Jackson. This library uses Jackson internally, but you can interact with this library using strings representing JSON values. The only library this library is tightly coupled to is Okio, which is used in place of InputStreams in some places

This library encourages the use of immutable objects as much as possible and doesn't force you to put _id and _rev on your objects like many other libraries do.

This library works great with Kotlin. Much of the code is annotated with annotations to denote nullability.

Features

• Decoupled from JSON library
• Encourages use of immutable objects
• _id and _rev parameters are not required on your POJOs
• Password auth, cookie auth, and no auth support
• Uses OkHttp, but has possibility for many implementations using different HTTP libraries
• Checked exceptions (all inherit from CouchDbException)
• Integration tested! (This should mean fewer bugs in this library)

Couchbase, Cloudant, PouchDB support

The primary goal of this project is to support CouchDB. Many features of this library likely work fine with these others databases, but it is not guaranteed to work.

Using library:

allprojects {
  repositories {
    maven { url 'https://www.jitpack.io' }
  }
}
dependencies {
  implementation "com.github.retrodaredevil:couchdb-java:$couchdbJavaVersion"
}

Running Tests:

Running test and building:

./gradlew build

Running integration tests:

docker compose --file testing/docker-compose.yml pull
./gradlew integration

Other CouchDB libraries for Java

• Cloudant Java SDK
  • Up to date
  • Designed to fully support Cloudant and CouchDB
  • Uses GSON internally, but GSON doesn't seem to be exposed to the public API.
  • Tightly coupled to custom Document class
• LightCouch
  • Uses GSON and is tightly coupled to GSON
  • Uses inheritance rather than composition to support alternative HTTP libraries on Android
• Ektorp
  • Uses Jackson and is tightly coupled to Jackson
    • Allows a single ObjectMapper to be configured for all serialization and deserialization
  • Updating objects without _id and _rev on them is awkward
• couchdb4j