Home / Golang / Database Drivers

Yet another CouchDB HTTP API wrapper for Go

What's this? go-couchdb is yet another CouchDB client written in Go. It was written because all the other ones didn't provide functionality that I need. The API is not fully baked at this time and may change. This project conta
Information
Category: Golang / Database Drivers
Watchers: 7
Star: 57
Fork: 37
Last update: May 26, 2023
Resource links
https://github.com/fjl/go-couchdb

What's this?

go-couchdb is yet another CouchDB client written in Go. It was written because all the other ones didn't provide functionality that I need.

The API is not fully baked at this time and may change.

This project contains three Go packages:

package couchdb GoDoc

import "github.com/fjl/go-couchdb"

This wraps the CouchDB HTTP API.

package couchapp GoDoc

import "github.com/fjl/go-couchdb/couchapp"

This provides functionality similar to the original couchapp tool, namely compiling a filesystem directory into a JSON object and storing the object as a CouchDB design document.

package couchdaemon GoDoc

import "github.com/fjl/go-couchdb/couchdaemon"

This package contains some functions that help you write Go programs that run as a daemon started by CouchDB, e.g. fetching values from the CouchDB config.

Tests

You can run the unit tests with go test.

Build Status

1 Open More issues
Closed

Sequence IDs are no longer integers

As of CouchDB 2.0, Sequence IDs are no longer integers, and can be any valid JSON object. As far as I know, the only place this is exposed in this library is in the ChangesFeed. I suggest changing the SeqID to a json.RawMessage type to accommodate this change.

Another option might be to expose the raw Seq value as a separate field (and set Seq to 0 when it's not an integer). This would allow CouchDB 1.6 users to continue using this library with no changes.

opened Jan 6, 2017 by flimzy 4
Closed

Add apache oss license

Adding an oss license to this upstream due to the various forks pointing here.

opened Sep 4, 2018 by renier 3
Closed

Slashes in IDs not encoded

I'm doing Db.Get("user/foo"), but the slash isn't encoded, resulting in requesting /db/user/foo from CouchDB (the slash should be encoded to %2F).

opened Dec 31, 2013 by mmalecki 3
Closed

Future of this library

Hi Felix. I'm curious how you envisage the future of this library. There are a couple of golang Couch DB clients on Github but this one has the most stars and probably the best code too.

Unfortunately there are some good open pull requests against this library that are not taken care off. Also it seems like there wasn't any other activity in this repo for about 2 years.

I have forked this repo and have incorporated most of the pull requests. I'm happy to continue to maintain the code but would need to know what your take on it is as we would need to figure out how we want to handle it going forward.

Cheers Tim

opened Aug 18, 2016 by timjacobi 2
Closed

Don't escape ddocs

The actual fix is quite small and trivial. Writing tests to prove the fix was a bit more of a chore, as it involved reorganizing all of the existing tests to run in the same package as couchdb itself.

If you don't like this reorganization, it should be easy enough to apply just the necessary fix--and maybe you can come up with some way to write tests for the unexported path() method that fits within your existing test configuration.

This fixes #6.

opened Sep 1, 2015 by flimzy 2
Closed

fixes issue #1: slashes in IDs not encoded.

This was a moderately complicated fix. The old CouchDB wiki has this to say about slashes in document IDs:

You can have / as part of the document ID but if you refer to a document in a URL you must always encode it as %2F. One special case is _design/ documents, those accept either / or %2F for the / after _design, although / is preferred and %2F is still needed for the rest of the DocID.

(https://wiki.apache.org/couchdb/HTTP_Document_API#line-75)

I initially modified couchdb.go to break up the document ID on slash characters and reassemble it with %2F separators, with a special case for IDs that start with _design, where I prefixed _design/ and assembled the rest of the ID with escaped slashes. Here are some examples of the transformed IDs:

user/34734612 -> user%2F34734612
AC/DC/240V -> AC%2FDC%2F240V
_design/lookup/users -> _design/lookup%2Fusers

I added new unit tests to couchdb_test.go with handlers that responded to the escaped document IDs and found that these tests failed. After some investigation, I found issue #5684 in the golang repo, which was filed because url.URL was decoding escape sequences in URL paths. My encoding code converted slashes to %2F but url.URL converted them back to slashes, which caused the test to fail.

The documentation for url.URL contained a workaround for this issue: the Opaque field of a URL struct can be set with the value of the encoded URL path, and that encoded value will be used in http.Request as the request path. Unfortunately, this involved replacing the call to http.NewRequest in the newRequest function with code that constructs a Request structure manually. This is the part of the PR that should be reviewed most strictly to make sure I didn't inadvertently miss anything in the request construction. All the unit tests, including my new ones that test getting document IDs containing slashes, are passing.

Let me know what you think or if there is anything I can do to improve this code.

opened Apr 15, 2015 by pegli 2
Open

added DB.Post() function for creating docs in the database with generated document IDs

I almost always let CouchDB generate my document IDs for me, so I've added a function to the DB type that sends the doc as a post as per http://couchdb.readthedocs.org/en/1.6.1/api/database/common.html#post--db.

opened Apr 9, 2015 by pegli 0

v0.1.0(Nov 8, 2020)

This release fixes all compatibility issues reported in the last 6 years:

  • Slashes in document and database IDs are now URL-encoded properly.
  • The type of the Seq field of DBUpdatesFeed and ChangesFeed is now interface{}. This makes go-couchdb compatible with CouchDB 2.0 and beyond.
  • ChangesFeed now handles the include_docs option properly and populates the Doc field.
  • The Content-Type HTTP header is now set for all requests containing an entity (i.e. POST and PUT requests).
  • go-couchdb is now a Go module.

v0.0.1(Nov 8, 2020)

This just tags the old version of go-couchdb from 2014 so that people can refer to it, should they still depend on it for whatever reason.

Contents

    apache Nano is now part of Apache CouchDB. Repo moved to https://GitHub.com/apache/couchdb-nano
    redgeoff A fault-tolerant way to replicate an entire CouchDB cluster
    keroxp 🦕CouchDB client for Deno built top of fetch 🛋
    couchapp Utilities to make standalone CouchDB application development simple
    apache Nano: The official Apache CouchDB library for Node.js
    66Origin Sofa — an interface to CouchDB HTTP REST API for stable rust
    chill-rs Chill — A Rust client for the CouchDB REST API
    spencerwooo Yet another-another OneDrive index, powered by Vercel and Next.js
    uobikiemukot yet another framebuffer terminal
    Kyubyong A TensorFlow Implementation of DC-TTS: yet another text-to-speech model
    stardust-enterprises Yet Another Native Loader for the JVM.
    nock HTTP server mocking and expectations library for Node.js
    yagdal Yet another GDAL python wrapper
    caibirdme yet another query language for rule engine in golang
    jiacai2050 Yet another shell can run anywhere Python exists.
    starlight36 A http client wrapper for fetch api with middleware support.
    geekdada Yet another Surge Dashboard
    intel-ai OOX: Out-of-Order Executor library. Yet another approach to efficient and scalable tasking API and task scheduling.
    Pincer-org 🚀 An asynchronous python API wrapper meant to replace discord.py - Snappy discord api wrapper written with aiohttp & websockets
    pyloque yet another python client for ssdb
    vanderlee Yet another jQuery Coverflow widget. Support for mousehweel, touch, reflections and complex CSS animation. Events for pretty much everything. Controllable using various methods. Options to change pretty much everything, but works fine without any options.
    Share this repo

    Related Repos


    Database Drivers
    8
    A mysql crud code generate tool from table DDL sql file
    hongshengjie A mysql crud code generate tool from table DDL sql file
     
    Database Drivers
    10
    Collection of reference single-table models for DynamoDB helping you design your models an...
    Dynobase Single-table Models Collection of reference single-table models for DynamoDB helping you design your models and access patterns. All models published
     
    Database Drivers
    5
    Reverse engineered and C ported 'MT15.DRV' (MT32-Sound-Driver) of Stunts 1.0 and 1.1 in on...
    LowLevelMahn UnifiedMT15 Reverse engineered and C ported MT15.DRV (MT32-Sound-Driver) of Stunts 1.0 and 1.1 in one source Assembler source can be rebuild to 100% b
     
    Database Drivers
    4
    SQLite extension for accessing other SQL databases
    mergestat dblite SQLite extension for accessing other SQL databases, in SQLite. Similar to how Postgres Foreign Data Wrappers enable access to other databases i
     
    Database Drivers
    468
    Nagios check_postgres plugin for checking status of PostgreSQL databases
    bucardo check_postgres This is check_postgres, a monitoring tool for Postgres. The most complete and up to date information about this script can be found at:
     
    Database Drivers
    3.7k
    Migrate to PostgreSQL in a single command!
    dimitri PGLoader pgloader is a data loading tool for PostgreSQL, using the COPY command. Its main advantage over just using COPY or \copy, and over using a Fo
     
    Database Drivers
    881
    PostgreSQL driver for Elixir
    elixir-ecto Postgrex PostgreSQL driver for Elixir. Documentation: http://hexdocs.pm/postgrex/ Examples iex> {:ok, pid} = Postgrex.start_link(hostname: "localhost"
     
    Database Drivers
    208
    Sample databases for postgres
    morenoh149 Postres Database Samples copy of http://pgfoundry.org/projects/dbsamples/ A collection of sample databases for PostgreSQL. Adventureworks - OLTP datab
     
    Database Drivers
    443
    Data Migration Platform
    pingcap ⚠️ Project moved ⚠️ This repository has been moved to https://github.com/pingcap/ticdc/tree/master/dm. Discussions before: https://internals.tidb.io/t
     
    Database Drivers
    720
    Mixer is a MySQL proxy powered by Go which aims to supply a simple solution for MySQL shar...
    siddontang Mixer Mixer is a MySQL proxy powered by Go which aims to supply a simple solution for MySQL sharding. Features Supports basic SQL statements (select,
     
    Database Drivers
    9.5k
    GitHub's Online Schema Migrations for MySQL
    github gh-ost GitHub's online schema migration for MySQL gh-ost is a triggerless online schema migration solution for MySQL. It is testable and provides paus
     
    Database Drivers
    3.4k
    a powerful mysql toolset with Go
    go-mysql-org go-mysql A pure go library to handle MySQL network protocol and replication. How to migrate to this repo To change the used package in your repo it's
     
    Database Drivers
    91
    Web-Based SQLite database browser
    hypebeast sqliteweb sqliteweb is a web-based SQLite database browser. It's written in Go. It's inspired and influenced by pgweb and sqlite-browser. Overview sql
     
    Database Drivers
    103
    Simple, visual command line tool for redis
    kyai redis-cui Simple, visual command line tool for redis. Feature Simple and visual Server friendly Supported vim keys Same arguments as redis-cli Install
     
    Database Drivers
    3
    Experimental implementation of a SQLite backend for go-mysql-server
    mergestat go-mysql-sqlite-server This is an experimental implementation of a SQLite backend for go-mysql-server from DoltHub. The go-mysql-server is a "frontend