class CouchDB::Adapter::HTTP

• CouchDB::Adapter::HTTP
• Reference
• Object

Overview

Remote-CouchDB adapter that proxies all operations over HTTP/HTTPS.

Instantiate via CouchDB::Database.new("http://...") — the Database facade auto-selects this adapter when the location starts with http:// or https://.

URL format: http[s]://[user:password@]host[:port]/dbname Credentials embedded in the URL are sent as HTTP Basic authentication.

Included Modules

• CouchDB::Adapter

Defined in:

Constructors

• .bearer(url : String, token : String) : self

  Named constructor for Bearer-token-authenticated databases.

• .new(url : String)

  Parses a CouchDB URL and configures the adapter.

Instance Method Summary

• #all_docs(include_docs : Bool = false, limit : Int32 | Nil = nil, skip : Int32 = 0, startkey : String | Nil = nil, endkey : String | Nil = nil) : NamedTuple(total_rows: Int64, offset: Int32, rows: Array(JSON::Any))

  HTTP implementation of Adapter#all_docs.

• #bearer_token=(token : String)

  Sets Bearer token authentication, replacing any previously configured credentials.

• #bulk_docs(docs : Array(Document), new_edits : Bool = true) : Array(NamedTuple(id: String, rev: String, ok: Bool))

  HTTP implementation of Adapter#bulk_docs.

• #bulk_get(id_revs : Array(NamedTuple(id: String, rev: String))) : Array(Document)

  HTTP implementation of Adapter#bulk_get.

• #changes(since : String = "0", limit : Int32 | Nil = nil, include_docs : Bool = false) : NamedTuple(last_seq: String, results: Array(JSON::Any))

  HTTP implementation of Adapter#changes.

• #changes_feed(since : String = "0", heartbeat : Int32 = 1000, include_docs : Bool = false, & : JSON::Any -> _)

  HTTP implementation of Adapter#changes_feed.

• #close

  No-op: HTTP connections are request-scoped and have no persistent handle to close.

• #delete_attachment(id : String, attname : String, rev : String) : NamedTuple(ok: Bool, id: String, rev: String)

  HTTP implementation of Adapter#delete_attachment.

• #get(id : String) : Document

  HTTP implementation of Adapter#get.

• #get_attachment(id : String, attname : String) : NamedTuple(data: Bytes, content_type: String)

  HTTP implementation of Adapter#get_attachment.

• #get_local(id : String) : Document

  HTTP implementation of Adapter#get_local.

• #info : NamedTuple(db_name: String, doc_count: Int64, update_seq: Int64)

  HTTP implementation of Adapter#info.

• #on_request(&block : ::HTTP::Request -> Nil)

  Registers a block called before every HTTP request.

• #on_response(&block : ::HTTP::Client::Response -> ::HTTP::Client::Response)

  Registers a block called after every HTTP response.

• #put(doc : Document) : NamedTuple(ok: Bool, id: String, rev: String)

  HTTP implementation of Adapter#put.

• #put_attachment(id : String, attname : String, rev : String, data : Bytes, content_type : String) : NamedTuple(ok: Bool, id: String, rev: String)

  HTTP implementation of Adapter#put_attachment.

• #put_local(doc : Document) : NamedTuple(ok: Bool, id: String, rev: String)

  HTTP implementation of Adapter#put_local.

• #remove(id : String, rev : String) : NamedTuple(ok: Bool)

  HTTP implementation of Adapter#remove.

• #revs_diff(id_revs : Hash(String, Array(String))) : Hash(String, NamedTuple(missing: Array(String)))

  HTTP implementation of Adapter#revs_diff.

• #tls=(ctx : OpenSSL::SSL::Context::Client)

  Assigns a TLS client context for mutual TLS (mTLS) authentication.

Constructor Detail

adapter = CouchDB::Adapter::HTTP.bearer("https://db.example.com/mydb", token: "secret")
db = CouchDB::Database.new(adapter)

Instance Method Detail

ctx = OpenSSL::SSL::Context::Client.new
ctx.certificate_file = "client.crt"
ctx.private_key_file = "client.key"
adapter.tls = ctx