https://github.com/joelnb/sofa

Golang bindings for CouchDB API
https://github.com/joelnb/sofa

couchdb database go golang

Last synced: 3 months ago
JSON representation

Golang bindings for CouchDB API

• Host: GitHub
• URL: https://github.com/joelnb/sofa
• Owner: joelnb
• License: mit
• Created: 2017-05-04T22:10:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T09:12:00.000Z (6 months ago)
• Last Synced: 2024-10-17T18:03:47.213Z (3 months ago)
• Topics: couchdb, database, go, golang
• Language: Go
• Homepage: https://pkg.go.dev/github.com/joelnb/sofa
• Size: 271 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sofa

Simply connect to CouchDB database servers using Go.

## Documentation

View the [full documentation](https://pkg.go.dev/github.com/joelnb/sofa?tab=doc) which includes examples.

## Limitations

Large parts of the [CouchDB API](http://docs.couchdb.org/en/2.0.0/api/) are covered but not all functionality is currently implemented. Pull requests for any missing functionality would be welcomed!

## Contributing

Contributions of all sizes are welcomed. Simply make a pull request and I will be happy to discuss. If you don't have time to write the code please consider at least creating an issue so that I can ensure the issue gets sorted eventually.

### Running tests

The basic tests can be run using a simple `go test '-run=^Test'` (this ensures that the examples are skipped because they require a CouchDB connection). To run a more complete set of tests which access a real database you will need a temporary CouchDB instance. The simplest way to create this is using docker:

    docker run -d --name sofa_couchdb1 -p 5984:5984 couchdb:1

To run all the tests you will also need a version 2 server:

    docker run -d --name sofa_couchdb2 -p 5985:5984 couchdb:2

...and a version 3 server with specific insecure credentials:

    docker run -d --name sofa_couchdb3 -p 5986:5984 -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=adm1nP4rty couchdb:3

There is a simple script provided which can be used to start all three versions:

    ./.scripts/start_test_docker_containers.sh

You can then set `SOFA_TEST_HOST_1`, `SOFA_TEST_HOST_2` and `SOFA_TEST_HOST_3` to set the connection to each server:

    SOFA_TEST_HOST_1=http://127.0.0.1:5984 SOFA_TEST_HOST_2=http://127.0.0.1:5985 SOFA_TEST_HOST_3=http://127.0.0.1:5986 go test -v

If you have chosen to only start a single version then only include the appropriate environment variable to ensure tests for the other version are not run.