package

github.com/shardscry/crybase

0.0.5 / published Jul 7, 2026 / repository

CouchBase client for Crystal language stack

  ______           ____
 / ____/______  __/ __ )____ _________
/ /   / ___/ / / / __  / __ `/ ___/ _ \
/ /___/ /  / /_/ / /_/ / /_/ (__  )  __/
\____/_/   \__, /_____/\__,_/____/\___/
          /____/

CryBase

Crystal Couchbase KV Couchbase Query

Crystal client primitives for Couchbase.

CryBase currently covers Couchbase endpoint discovery, the KV binary protocol with bucket vbucket-count discovery, and the Query HTTP service. Search, Analytics, Index, Eventing, Views, and Management protocol clients are not implemented yet.

Index

  1. Glossary
  2. Installation
  3. Quick start
  4. Key Value service
  5. Query service

Small Use Cases

kv = CryBase::CouchBase::KV::Client.from_string(
  "couchbase://Administrator:password@127.0.0.1/commerce",
)

kv.scope = "ecommerce_shop"
kv.collection = "users"
kv.set("user:1", %({"name":"Ada"}))
puts String.new(kv.get("user:1"))

admins = kv.collection("admins")
admins.set("admin:1", %({"name":"Grace"}))
query = CryBase::CouchBase::Query::Client.from_string(
  "couchbase://Administrator:password@127.0.0.1/commerce",
)

query.scope = "ecommerce_shop"

rows = query.query(
  "SELECT META(u).id AS doc_key, u.name FROM users AS u LIMIT 5",
)

API

  • CryBase

    Top-level namespace for the CryBase database client toolkit.