class CouchDB::Adapter::SQLite

• CouchDB::Adapter::SQLite
• Reference
• Object

Overview

Local-storage adapter backed by SQLite3.

All reads and writes go to a single SQLite file, making the database available without any network connection. Use ":memory:" for a transient in-memory database (useful for testing).

Four tables underpin the adapter:

• docs — every revision of every document (enables #revs_diff)
• revs — parent-revision linkage tree
• local_docs — _local/ documents (checkpoints, never replicated)
• update_seq — append-only sequence log; ROWID is the update_seq

The winning revision for a given document is the one with the highest seq value. Deleted documents are soft-deleted (a deleted=1 row is stored) so their revision history remains available for replication.

Included Modules

• CouchDB::Adapter

Defined in:

Constant Summary

SCHEMA = " CREATE TABLE IF NOT EXISTS docs (\n id TEXT NOT NULL,\n rev TEXT NOT NULL,\n seq INTEGER NOT NULL,\n deleted INTEGER NOT NULL DEFAULT 0,\n body TEXT NOT NULL,\n PRIMARY KEY (id, rev)\n );\n CREATE INDEX IF NOT EXISTS idx_docs_id_seq ON docs(id, seq DESC);\n\n CREATE TABLE IF NOT EXISTS revs (\n id TEXT NOT NULL,\n rev TEXT NOT NULL,\n parent_rev TEXT,\n PRIMARY KEY (id, rev)\n );\n\n CREATE TABLE IF NOT EXISTS local_docs (\n id TEXT PRIMARY KEY,\n body TEXT NOT NULL\n );\n\n CREATE TABLE IF NOT EXISTS update_seq (\n seq INTEGER PRIMARY KEY AUTOINCREMENT,\n doc_id TEXT NOT NULL,\n doc_rev TEXT NOT NULL\n );\n\n CREATE TABLE IF NOT EXISTS attachments (\n doc_id TEXT NOT NULL,\n name TEXT NOT NULL,\n content_type TEXT NOT NULL DEFAULT 'application/octet-stream',\n data BLOB NOT NULL,\n PRIMARY KEY (doc_id, name)\n );"

Constructors

• .new(path : String)

  Opens (or creates) a SQLite3 database at path.

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))

  SQLite implementation of Adapter#all_docs.

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

  SQLite implementation of Adapter#bulk_docs.

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

  SQLite 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))

  SQLite implementation of Adapter#changes.

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

  SQLite implementation of Adapter#changes_feed.

• #close

  Closes the underlying database connection pool.

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

  SQLite implementation of Adapter#delete_attachment.

• #get(id : String) : Document

  SQLite implementation of Adapter#get.

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

  SQLite implementation of Adapter#get_attachment.

• #get_local(id : String) : Document

  SQLite implementation of Adapter#get_local.

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

  SQLite implementation of Adapter#info.

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

  SQLite implementation of Adapter#put.

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

  SQLite implementation of Adapter#put_attachment.

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

  SQLite implementation of Adapter#put_local.

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

  SQLite implementation of Adapter#remove.

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

  SQLite implementation of Adapter#revs_diff.

Constructor Detail

Instance Method Detail