src/mycouch/api

    Dark Mode
Search:
Group by:

https://docs.couchdb.org/en/latest/api/server/common.html#get--_cluster_setup https://docs.couchdb.org/en/latest/api/server/common.html#post--_cluster_setupTODO: https://docs.couchdb.org/en/latest/api/server/common.html#search-analyzefor local APIs, append doc_id to_local : "_local/{doc_id}"https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#get--db-_partition-partition-_all_docs

Types

CouchDBClient = object
  hc*: HttpClient
  baseUrl*: string
Attachment = object
  etag*: string
  contentEncoding*: string
  content*: string
FeedVariants = enum
  FVNormal = "normal", FVLongPoll = "longpoll", FVContinuous = "continuous",
  FVEventSource = "eventsource"
BatchVariants = enum
  BVNon = "", BVOk = "ok"
UpdateVariants = enum
  UVTrue = "true", UVFalse = "false", UVLazy = "lazy"
ReshardStates = enum
  RSstopped = "stopped", RSrunning = "running"

Procs

proc newCouchDBClient(host: string = "http://localhost"; port = 5984): CouchDBClient {.
    ...raises: [KeyError, ValueError], tags: [].}
creates new couchdb client - used for APIs
proc serverInfo(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#api-server-root
proc activeTasks(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#active-tasks
proc allDBs(self; descending = false; limit, skip = 0;
            startkey, endKey = newJObject()): seq[string] {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#all-dbs
proc DBsInfo(self; keys: openArray[string]): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#dbs-info
proc DBupdates(self; feed: string; timeout = 60; heartbeat = 60000; since = ""): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#db-updates
proc membership(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#membership
proc replicate(self; source, target: string;
               cancel, continuous, create_target = false;
               create_target_params: JsonNode = newJObject();
               doc_ids = newSeq[string](); filter: string = "";
               source_proxy, target_proxy: string = ""): JsonNode {....raises: [],
    tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#replicate
proc schedulerJobs(self; limit, skip = 0): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#scheduler-jobs
proc schedulerDocs(self; replicatorDB, doc_id = ""; limit, skip = 0): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#scheduler-docs https://docs.couchdb.org/en/latest/api/server/common.html#get--_scheduler-docs-replicator_db
proc getSchedulerDoc(self; replicatorDB, docid: string): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#get--_scheduler-docs-replicator_db-docid
proc nodeInfo(self; node = "_local"): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#node-node-name
proc nodeStats(self; node = "_local"): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#node-node-name
proc nodeSystem(self; node = "_local"): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#get--_node-node-name-_system
proc nodeRestart(self; node = "_local") {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#node-node-name-restart
proc up(self): bool {....raises: [ValueError, HttpRequestError, Exception,
                               LibraryError, SslError, OSError, IOError,
                               TimeoutError, ProtocolError, KeyError], tags: [
    RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#up
proc uuids(self; count = 1): seq[string] {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#uuids
proc getReshards(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#reshard
proc reshardState(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#get--_reshard-state
proc changeReshardState(self; state: ReshardStates; state_reason = "") {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#put--_reshard-state
proc reshardJobs(self; jobId = ""): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#get--_reshard-jobs https://docs.couchdb.org/en/latest/api/server/common.html#get--_reshard-jobs-jobid
proc createReshardJob(self, db; type = "split"; node, range, shard, error = ""): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#post--_reshard-jobs
proc deleteReshadJob(self; jobId: string) {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#delete--_reshard-jobs-jobid
proc getReshardJobState(self; jobId: string): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/common.html#get--_reshard-jobs-jobid-state
proc changeReshardJobState(self; jobId, state: string; state_reason = "") {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/server/common.html#put--_reshard-state
proc getCurrentSession(self): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/authn.html#get--_session
proc cookieAuthenticate(self; name, password: string): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/authn.html#post--_session
proc deleteCookieSession(self) {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/authn.html#delete--_session
proc getNodeConfig(self, node): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#get--_node-node-name-_config
proc getNodeSectionConfig(self, node, section): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#node-node-name-config-section
proc getNodeSectionKeyConfig(self, node, section; key: string): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#get--_node-node-name-_config-section-key
proc updateNodeSectionKeyConfig(self, node, section; key: string;
                                newval: JsonNode): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#get--_node-node-name-_config-section-key
proc deleteNodeSectionKeyConfig(self, node, section; key: string): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#delete--_node-node-name-_config-section-key
proc reloadConfigs(self, node) {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/server/configuration.html#get--_node-node-name-_config-section-key
proc isDBexists(self, db): bool {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError], tags: [RootEffect, ReadIOEffect, WriteIOEffect,
                                     TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/common.html#head--db
proc getDBinfo(self, db): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/common.html#get--db
proc createDB(self, db; q, n = -1; partitioned = false) {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/common.html#put--db
proc deleteDB(self, db) {....raises: [ValueError, HttpRequestError, Exception,
                                   LibraryError, SslError, OSError, IOError,
                                   TimeoutError, ProtocolError, KeyError,
                                   JsonParsingError], tags: [RootEffect,
    ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/common.html#delete--db
proc createDoc(self, db; doc: JsonNode; batch = BVNon): JsonNode {....raises: [],
    tags: [].}
https://docs.couchdb.org/en/latest/api/database/common.html#post--db
proc designDocs(self, db; conflicts, descending = false; startkey, endkey = "";
                startkey_docid, endkey_docid = ""; include_docs = false;
                inclusive_end = true; key = ""; keys = newSeq[string]();
                limit, skip = 0; update_seq = false): JsonNode {....raises: [],
    tags: [].}
https://docs.couchdb.org/en/latest/api/database/bulk-api.html#db-design-docs
proc bulkGet(self, db; docs: JsonNode; revs = false): JsonNode {....raises: [],
    tags: [].}
https://docs.couchdb.org/en/latest/api/database/bulk-api.html#db-bulk-get
proc bulkDocs(self, db; docs: JsonNode; new_edits = true): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/bulk-api.html#db-bulk-docs
proc find(self, db; selector: JsonNode; limit = 0; skip = 0;
          sort = newJObject(); fields = newSeq[string](); use_index = "";
          use_indexes = newSeq[string](); conflicts = false; r = 1;
          bookmark = ""; update = true; stable = false; execution_stats = false;
          explain = false): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/find.html#db-find https://docs.couchdb.org/en/latest/api/database/find.html#post--db-_explain
proc createIndex(self, db; index: JsonNode; ddoc, name, type = "";
                 partitioned = false): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/find.html#db-index
proc getIndexes(self, db): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/find.html#get--db-_index
proc deleteIndex(self, db, ddoc; name: string) {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/find.html#delete--db-_index,ddoc;json-name
proc getshards(self, db): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/shard.html
proc shardsDoc(self, db, docId): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/shard.html#db-shards-doc
proc syncShards(self, db) {....raises: [ValueError, HttpRequestError, Exception,
                                     LibraryError, SslError, OSError, IOError,
                                     TimeoutError, ProtocolError, KeyError,
                                     JsonParsingError], tags: [RootEffect,
    ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/shard.html#db-sync-shards
proc changes(self, db; handleChanges: proc (data: JsonNode);
             doc_ids = newSeq[string](); conflicts, descending = false;
             feed, filter = ""; heartbeat = 60000;
             include_docs, attachments, att_encoding_info = false;
             last-event-id = 0; limit = 1; since = 0; style: string;
             timeout = 60000; view = ""; seq_interval = 0): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/shard.html#db-sync-shards
proc compact(self, db) {....raises: [ValueError, HttpRequestError, Exception,
                                  LibraryError, SslError, OSError, IOError,
                                  TimeoutError, ProtocolError, KeyError,
                                  JsonParsingError], tags: [RootEffect,
    ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/compact.html#db-compact
proc compactDesignDoc(self, db, ddoc) {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/compact.html#db-compact-design-doc
proc viewCleanup(self, db) {....raises: [ValueError, HttpRequestError, Exception,
                                      LibraryError, SslError, OSError, IOError,
                                      TimeoutError, ProtocolError, KeyError,
                                      JsonParsingError], tags: [RootEffect,
    ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/compact.html#db-view-cleanup
proc getSecurity(self, db): JsonNode {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/security.html#get--db-_security
proc setSecurity(self, db; admins, members: JsonNode) {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/security.html#put--db-_security
proc purge(self, db; obj: JsonNode): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#db-purge
proc getPurgedInfosLimit(self, db): int {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#get--db-_purged_infos_limit
proc setPurgedInfosLimit(self, db; limit: int) {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#put--db-_purged_infos_limit
proc missingRevs(self, db; obj: JsonNode): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#db-missing-revs
proc revsDiff(self, db; obj: JsonNode): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#post--db-_revs_diff
proc getRevsLimit(self, db): int {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#get--db-_revs_limit
proc setRevsLimit(self, db; limit: int) {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/database/misc.html#put--db-_revs_limit
proc getLocalDocs(self, db; conflicts, descending = false;
                  startkey, endkey = ""; startkey_docid, endkey_docid = "";
                  include_docs = false; inclusive_end = true; key = "";
                  keys = newSeq[string](); limit, skip = 0; update_seq = false): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/local.html#db-local-docs
proc getDoc(self, db, docid; rev = ""; headOnly: bool = false;
            attachments, att_encoding_info = false;
            atts_since = newSeq[string](); conflicts, deleted_conflicts = false;
            latest, local_seq, meta = false; open_revs = newSeq[string]();
            revs, revs_info = false): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid https://docs.couchdb.org/en/latest/api/document/common.html#head--db-docid https://docs.couchdb.org/en/latest/api/local.html#get--db-_local-docid
proc createOrUpdateDoc(self, db, docid; rev: string; obj: JsonNode): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/document/common.html#put--db-docid https://docs.couchdb.org/en/latest/api/local.html#put--db-_local-docid
proc deleteDoc(self, db, docid; rev: string; batch = BVNon; new_edits = false) {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/common.html#delete--db-docid https://docs.couchdb.org/en/latest/api/local.html#delete--db-_local-docid
proc copyDoc(self, db, docid; destination: string; rev = ""; batch = BVNon): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/common.html#copy--db-docid https://docs.couchdb.org/en/latest/api/local.html#copy--db-_local-docid
proc getDocAtt(self, db, docid, attname; headOnly = false; rev = ""): Attachment {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/attachments.html#head--db-docid-attname https://docs.couchdb.org/en/latest/api/document/attachments.html#get--db-docid-attname https://docs.couchdb.org/en/latest/api/ddoc/common.html#head--db-_design-ddoc-attname https://docs.couchdb.org/en/latest/api/ddoc/common.html#get--db-_design-ddoc-attname
proc uploadDocAtt(self, db, docid, attname; contentType, content: string;
                  rev = ""): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/attachments.html#put--db-docid-attname https://docs.couchdb.org/en/latest/api/ddoc/common.html#put--db-_design-ddoc-attname
proc deleteDocAtt(self, db, docid, attname; rev: string; batch = BVNon): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/document/attachments.html#delete--db-docid-attname https://docs.couchdb.org/en/latest/api/ddoc/common.html#delete--db-_design-ddoc-attname
proc getDesignDoc(self, db, ddoc; headOnly: bool = false): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/common.html#head--db-_design-ddoc
proc createOrUpdateDesignDoc(self, db; ddoc: string; language: string;
                             options: JsonNode; filters: seq[string];
                             updates: JsonNode; validate_doc_update: string;
                             views: JsonNode; autoupdate = true): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/ddoc/common.html#put--db-_design-ddoc
proc deleteDesignDoc(self, db, ddoc) {....raises: [ValueError, HttpRequestError,
    Exception, LibraryError, SslError, OSError, IOError, TimeoutError,
    ProtocolError, KeyError, JsonParsingError], tags: [RootEffect, ReadIOEffect,
    WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/common.html#delete--db-_design-ddoc
proc getDesignDocInfo(self, db, ddoc): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/common.html#get--db-_design-ddoc-_info
proc getView(self, db, ddoc, view; queryObj: JsonNode): JsonNode {....raises: [
    ValueError, HttpRequestError, Exception, LibraryError, SslError, OSError,
    IOError, TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/views.html#get--db-_design-ddoc-_view-view
proc allDocs(self, db; queryObj: JsonNode): JsonNode {....raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs
proc searchByIndex(self, db, ddoc; index: string; query: string; bookmark = "";
                   counts = newJObject(); drilldown = newJObject();
                   group_field = ""; group_sort = newJObject();
                   highlight_fields = newJObject(); highlight_pre_tag = "";
                   highlight_post_tag = ""; highlight_number = 0;
                   highlight_size = 0; include_docs = false;
                   include_fields = newJObject(); limit = 0;
                   ranges = newJObject(); sort = newJObject(); stale = ""): JsonNode {.
    ...raises: [], tags: [].}
https://docs.couchdb.org/en/latest/api/ddoc/search.html#get--db-_design-ddoc-_search-index
proc searchInfo(self, db, ddoc; index: string): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/search.html#get--db-_design-ddoc-_search_info-index
proc execUpdateFunc(self, db, ddoc; func: string; body: JsonNode = newJNull();
                    docid = ""): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/ddoc/render.html#post--db-_design-ddoc-_update-func https://docs.couchdb.org/en/latest/api/ddoc/render.html#put--db-_design-ddoc-_update-func-docid
proc getPartitionInfo(self, db, partition): JsonNode {....raises: [ValueError,
    HttpRequestError, Exception, LibraryError, SslError, OSError, IOError,
    TimeoutError, ProtocolError, KeyError, JsonParsingError],
    tags: [RootEffect, ReadIOEffect, WriteIOEffect, TimeEffect].}
https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#get--db-_partition-partition