CouchDB with DBine

How to connect DBine to CouchDB and what you can do once it's connected. This page is written from what the CouchDB driver says about itself, so it matches the version of DBine you download.

Connect

  1. In DBine, open New connection.
  2. Pick CouchDB in the list of engines.
  3. Fill in the fields below, press Test connection and then Save.

Default port: 5984.

General

FieldDescription
Server requiredA host name or a full URL (https://server:6984).
Example: localhost
Port
Database
User
PasswordKept in the system keychain, never in DBine's files.
Read-onlyOn or off.

SSH tunnel. The connection can go through an SSH server, even through a chain of bastions, with a password, a private key or the SSH agent. The server's fingerprint is checked against known_hosts or confirmed the first time.

SSL/TLS

FieldDescription
Encrypt the connection (TLS)Use https.
On or off.
Trust the server certificateOn or off.

What the explorer shows

Under the connection: Databases. Inside each one:

Query editor

The editor uses CouchDB's own query syntax, in JSON, with completion for the connection's objects. Statements and commands run against the database selected in the tab.

What the editor accepts:

Mango queries in JSON (sent to POST /db/_find):
{ "selector": { "age": { "$gt": 30 } }, "fields": ["name"], "limit": 20 }
Or HTTP console lines, with the JSON body on the same line or on the following ones:
GET /db/_all_docs?include_docs=true&limit=10
POST /db/_find { "selector": {} }
GET _design/app/_view/by_name?limit=5   (no leading «/», relative to the current database)
PUT _design/app { "views": { … } } · POST _index { "index": { "fields": ["field"] } } · POST _bulk_docs { "docs": [ … ] }
PUT /new_db · DELETE /db (create and delete databases)

Ready-made templates for new objects:

Tools for CouchDB

Available

  • Graphical execution plans
  • Server monitor
  • Sessions and running queries
  • Cancel another session's query from the sessions list
  • Index usage
  • Create databases
  • Drop databases
  • Database properties
  • Compare and sync schemas
  • Native bulk load when migrating data
  • Users and permissions

Not available for CouchDB

  • Live query profiler
  • End a session
  • Locks: who blocks whom
  • Manual transactions (commit and rollback)
  • Relations in the ER diagram
  • Visual designer for new objects
  • Rename objects
  • Clone tables
  • Backups

Why a tool doesn't apply to an engine, and the details of each one, are in the engine support reference.

Generated from the CouchDB driver 0.1.11, which DBine downloads the first time you connect to CouchDB.

Download DBineAll engines