tricoredb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 735d173a09ff6f3b5251bbade94d449f563aad10257266b7aaa6e15030ad2fe8
+  data.tar.gz: 93d4dc22f7e1c09b0617d1826b5f7037a4c4313b58afd6c2493216dde1714161
+SHA512:
+  metadata.gz: f55362c4d3caaec273f45bd09861a2ae5f3e6b47707914009828a20fc6be04d3a75e22fa5f6febe8857b4b106420dfe0ad7498b2fee00fbd92455ef8f6d4fda3
+  data.tar.gz: 88df99ed1634d7c5eacd010861dbc72bf690d96500e282d2daa89d35a46249151e9d66eaa8003f2a75460e84f558dadff235b369cb9bd20a07bbafc043fc499f

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to the `tricoredb` gem are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the gem uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-09-16
+
+First release.
+
+### Added
+
+- `TriCoreDB::Client`: the native `tricore` wire protocol over TCP or TLS, with
+  HELLO feature negotiation and password authentication. Ruby 3.1 and later, and
+  nothing outside the standard library.
+- SQL: `query` and `execute` with `?` placeholders bound **by the server**, plus
+  one-request scripts (`transaction`) and session transactions
+  (`begin_transaction`, `commit`, `rollback`).
+- `TriCoreDB::Pool`: a thread-safe pool that lends a connection to a block and never
+  returns one with a transaction still open.
+- Families for documents, cache (keys, lists, sets, hashes, streams), vectors,
+  graphs, LLM context export and the admin reads.
+- Builders for filters, aggregation stages, accumulators and LLM sources, so the
+  request JSON is never written by hand.
+- Typed failures under `TriCoreDB::Error`, each carrying the server's own `code`;
+  `redirect?` and `leader_hint` for a `not_leader` refusal.
+- `TriCoreDB::Binary` for values bound to a `BLOB` column, whatever the String's
+  encoding.
+
+### Security
+
+- A call that needs a capability the server did not grant — server-side parameters,
+  session transactions — raises `FeatureNotGranted` before anything is sent, rather
+  than falling back to a weaker behaviour.
+- Both directions enforce the protocol's frame ceilings, and a declared length is
+  checked before a payload byte is read, so a wrong or hostile peer cannot make the
+  driver allocate what it claimed.
+- A connection that timed out or lost frame alignment is dropped rather than reused:
+  a late reply can never be read as the answer to the next request.
+- A value with no SQL form is refused by name instead of being pushed through
+  `to_s`, and text that is not valid UTF-8 is refused rather than sent as mojibake.
+
+[Unreleased]: https://github.com/trinesh14/tricoredb-sdk-ruby/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/trinesh14/tricoredb-sdk-ruby/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2026 TriCoreDB Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,377 @@
+# tricoredb
+
+Official Ruby client for [TriCoreDB](https://hub.docker.com/r/trinesh14/tricoredb):
+SQL, documents, vectors, graphs and cache over one native connection.
+
+[![Gem Version](https://img.shields.io/gem/v/tricoredb?logo=rubygems&label=gem&color=blue&cacheSeconds=1800)](https://rubygems.org/gems/tricoredb)
+[![Downloads](https://img.shields.io/gem/dt/tricoredb?label=downloads&color=blue&cacheSeconds=1800)](https://rubygems.org/gems/tricoredb)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue?cacheSeconds=86400)](LICENSE)
+
+- **No dependencies** beyond the Ruby standard library.
+- **Server-side parameters.** Values never become part of the SQL text.
+- **Typed errors** you rescue by class and branch on by code.
+- **Transactions, a thread-safe pool, TLS and mutual TLS.**
+
+## Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Running a server](#running-a-server)
+- [Quick start](#quick-start)
+- [Connecting](#connecting)
+- [SQL](#sql)
+- [Transactions](#transactions)
+- [Connection pool](#connection-pool)
+- [Cache](#cache)
+- [Documents](#documents)
+- [Vectors](#vectors)
+- [Graphs](#graphs)
+- [LLM context](#llm-context)
+- [Admin](#admin)
+- [Errors](#errors)
+- [TLS](#tls)
+- [Testing](#testing)
+
+## Requirements
+
+- Ruby **3.1** or later
+- A TriCoreDB server speaking protocol 1.0 (`tricore-server` 0.1.0-rc.1 or later).
+  See [Running a server](#running-a-server).
+
+## Installation
+
+```bash
+gem install tricoredb
+```
+
+Or in a Gemfile:
+
+```ruby
+gem "tricoredb"
+```
+
+## Running a server
+
+The quickest way is the official Docker image,
+[`trinesh14/tricoredb`](https://hub.docker.com/r/trinesh14/tricoredb).
+
+**Local development** (no TLS and no encryption, for this machine only). Set
+`TRICORE_ADMIN_PASSWORD` in your shell first. Then create the admin and start the
+server:
+
+```bash
+docker run --rm -v tricoredb-dev:/var/lib/tricoredb -e TRICORE_ADMIN_PASSWORD --entrypoint /usr/local/bin/tricore trinesh14/tricoredb:0.1.0-rc.1-r2 auth init-admin --user admin --password-env TRICORE_ADMIN_PASSWORD --data-dir /var/lib/tricoredb/data
+docker run -d --name tricoredb-dev -p 127.0.0.1:8427:8427 -e TRICORE_TLS=off -e TRICORE_ENCRYPTION=off -e TRICORE_MODULES=all -v tricoredb-dev:/var/lib/tricoredb trinesh14/tricoredb:0.1.0-rc.1-r2
+```
+
+**Anything else:** by default the image runs with **TLS on** and an **encrypted data
+volume**. Follow the quick start on the
+[Docker Hub page](https://hub.docker.com/r/trinesh14/tricoredb) to create the
+certificate and key, then connect with [TLS](#tls).
+
+`TRICORE_MODULES=all` enables every data model. The image's default is `sql`,
+`document` and `cache`; a call to a disabled model raises `TriCoreDB::ServerError`
+whose `code` is `engine.disabled`.
+
+## Quick start
+
+```ruby
+require "tricoredb"
+
+db = TriCoreDB::Client.connect(host: "127.0.0.1", port: 8427, user: "admin", secret: "your-password")
+
+db.execute("CREATE TABLE IF NOT EXISTS users (id INT PRIMARY KEY, name TEXT)")
+db.execute("INSERT INTO users VALUES (?, ?)", [1, "O'Hara"])
+
+rows = db.query("SELECT id, name FROM users WHERE id = ?", [1])
+rows.first          # => ["1", "O'Hara"]
+rows.to_hashes      # => [{"id" => "1", "name" => "O'Hara"}]
+
+db.cache_set("sessions", "u1", "token")
+db.cache_get("sessions", "u1")   # => "token", or nil on a miss
+
+db.close
+```
+
+## Connecting
+
+`TriCoreDB::Client.connect` opens one authenticated connection.
+
+| Keyword | Default | Meaning |
+| --- | --- | --- |
+| `host` | `"127.0.0.1"` | Server host |
+| `port` | `8427` | Server port |
+| `user` | `nil` | Principal to authenticate as; `nil` skips authentication |
+| `secret` | `""` | Password or token |
+| `database` | `"main"` | Database named in every request |
+| `connect_timeout` | `10` | Seconds allowed for the connect, TLS and handshake |
+| `read_timeout` | `nil` | Seconds allowed for each reply |
+| `request_timeout_ms` | `nil` | Server-side deadline stamped on each request |
+| `tls` | `nil` | See [TLS](#tls) |
+| `client_name` | `"tricoredb-ruby/<version>"` | Name reported in the handshake |
+| `features` | every capability | Bitmap announced in the handshake |
+
+A connection is a single request/response stream, so one connection serves one
+thread. For concurrent work use a [pool](#connection-pool).
+
+## SQL
+
+`query` runs only `SELECT`. `execute` runs everything else. The server enforces the
+split: a write sent through `query` is refused.
+
+```ruby
+db.execute("INSERT INTO users VALUES (?, ?)", [2, "ada"])
+rows = db.query("SELECT id, name FROM users")
+
+rows.size           # => 2
+rows.each { |row| puts row.inspect }
+rows.to_hashes      # rows keyed by column name
+```
+
+Placeholders are bound **on the server**: the values travel next to the statement,
+so a value can never be read as SQL syntax, however it is spelled. How a Ruby value
+goes out:
+
+| Ruby value | Sent as |
+| --- | --- |
+| `nil`, `true`, `false` | themselves |
+| `Integer` | an exact number, Bignum included |
+| `Float` | a number; `NaN` and infinities are refused |
+| `BigDecimal` | plain digits, no exponent — for `DECIMAL` |
+| `String` (UTF-8) | text; invalid UTF-8 is refused |
+| `String` (ASCII-8BIT) or `TriCoreDB::Binary` | `0x`-prefixed hex, for `BLOB` |
+| `Time`, `Date`, `DateTime` | ISO-8601 text |
+
+Anything else is refused by name rather than pushed through `to_s`:
+
+```ruby
+db.execute("INSERT INTO files VALUES (?, ?)", [1, TriCoreDB::Binary.new(File.binread("a.png"))])
+db.execute("INSERT INTO t VALUES (?)", [[1, 2]])   # raises TriCoreDB::ParameterError
+```
+
+Binding needs the `SERVER_PARAMS` capability, agreed in the handshake
+(`db.features[:server_params]`). Against a server that did not grant it, a call with
+parameters raises `TriCoreDB::FeatureNotGranted` **before anything is sent** — it
+never falls back to pasting values into the statement text.
+
+## Transactions
+
+`transaction` sends a whole `BEGIN … COMMIT` script in **one request**, and rolls
+back if the block raises:
+
+```ruby
+db.transaction do
+  db.execute("UPDATE accounts SET balance = balance - ? WHERE id = ?", [10, 1])
+  db.execute("UPDATE accounts SET balance = balance + ? WHERE id = ?", [10, 2])
+end
+```
+
+`begin_transaction`, `commit` and `rollback` keep a transaction open **across
+requests on this connection**, so a later statement can depend on what an earlier
+one read. They need the `SESSION_TXN` capability; without it `begin_transaction`
+raises by name rather than running each statement on its own.
+
+```ruby
+db.begin_transaction
+begin
+  db.execute("INSERT INTO t VALUES (?, ?)", [1, "ada"])
+  db.commit
+rescue StandardError
+  db.rollback
+  raise
+end
+```
+
+The transaction belongs to this connection: another connection cannot commit it, and
+a dropped socket rolls it back. `db.in_transaction?` says whether one is open.
+
+## Connection pool
+
+```ruby
+pool = TriCoreDB::Pool.new(size: 8, host: "db.internal", user: "admin", secret: "your-password")
+
+threads = 8.times.map do |i|
+  Thread.new { pool.with { |db| db.execute("INSERT INTO users VALUES (?, ?)", [i, "grace"]) } }
+end
+threads.each(&:join)
+
+pool.stats   # => {size: 8, created: 8, idle: 8, in_use: 0, waiting: 0}
+pool.close
+```
+
+`pool.with` lends a connection for the duration of the block. A connection is never
+returned with a transaction still open, and a broken one is retired rather than
+handed to the next caller. When every connection is busy, a caller waits up to
+`checkout_timeout` seconds and then gets `TriCoreDB::PoolTimeout` — the pool never
+grows past `size`.
+
+## Cache
+
+Values are byte strings. `nil` is a miss, which is how a miss is told apart from a
+stored empty value.
+
+```ruby
+db.cache_set("sessions", "u1", "token")
+db.cache_set("sessions", "u2", "token", ttl_ms: 30_000)
+db.cache_get("sessions", "u1")          # => "token" | nil
+
+db.cache_incr("counters", "hits")
+db.cache_rpush("queue", "jobs", %w[a b])
+db.cache_sadd("tags", "post:1", %w[ruby db])
+db.cache_hset("user:1", "profile", [%w[name ada]])
+id = db.cache_xadd("events", "log", [%w[msg hi]])
+```
+
+| Family | Methods |
+| --- | --- |
+| Keys | `cache_get`, `cache_set`, `cache_set_nx`, `cache_delete`, `cache_exists?`, `cache_ttl`, `cache_expire`, `cache_persist`, `cache_incr`, `cache_keys`, `cache_clear_namespace`, `cache_ping` |
+| Lists | `cache_lpush`, `cache_rpush`, `cache_lpop`, `cache_rpop`, `cache_lrange`, `cache_llen`, `cache_lindex` |
+| Sets | `cache_sadd`, `cache_srem`, `cache_sismember?`, `cache_scard`, `cache_smembers` |
+| Hashes | `cache_hset`, `cache_hget`, `cache_hdel`, `cache_hgetall`, `cache_hexists?`, `cache_hlen` |
+| Streams | `cache_xadd`, `cache_xlen`, `cache_xrange`, `cache_xread`, `cache_xdel`, `cache_xtrim` |
+
+## Documents
+
+Filters and pipeline stages are built with `TriCoreDB::Filter`, `TriCoreDB::Stage`
+and `TriCoreDB::Acc`, so the request JSON is never written by hand.
+
+```ruby
+db.doc_create_collection("products")
+id = db.doc_insert("products", { "name" => "widget", "price" => 9 })
+db.doc_find("products", TriCoreDB::Filter.gt("price", 5))
+db.doc_update_one("products", id, inc: { "price" => 1 })
+
+totals = db.doc_aggregate("orders", [
+  TriCoreDB::Stage.match(TriCoreDB::Filter.eq("status", "paid")),
+  TriCoreDB::Stage.group(TriCoreDB::Stage.by_field("customer"), [TriCoreDB::Acc.sum("total", "amount")]),
+  TriCoreDB::Stage.sort([["total", true]]),
+  TriCoreDB::Stage.limit(10)
+])
+```
+
+Also available: `doc_get`, `doc_update`, `doc_update_many`, `doc_delete`,
+`doc_list_collections`, `doc_drop_collection`, `doc_create_index`, `doc_drop_index`,
+`doc_list_indexes` and `doc_analyze`.
+
+## Vectors
+
+```ruby
+db.vector_create_collection("embeddings", 3, metric: "cosine")
+db.vector_upsert("embeddings", "a", [0.1, 0.2, 0.3], metadata: { "kind" => "doc" })
+
+hits = db.vector_search("embeddings", [0.1, 0.2, 0.3], 5)
+hits.first["id"]      # the nearest vector comes first
+hits.first["score"]
+
+db.vector_search("embeddings", [0.1, 0.2, 0.3], 5, filter: { "kind" => "doc" })
+```
+
+The score is a **similarity**: higher is closer under every metric. L2 is the case
+worth knowing — the server negates the squared distance, so an L2 score is `<= 0`
+and `-0.02` is nearer than `-196.0`.
+
+## Graphs
+
+```ruby
+db.graph_create("social")
+db.graph_add_node("social", "u1", labels: ["User"], properties: { "name" => "ada" })
+db.graph_add_node("social", "u2", labels: ["User"])
+db.graph_add_edge("social", "e1", "u1", "u2", "FOLLOWS")
+
+db.graph_neighbors("social", "u1")
+path = db.graph_shortest_path("social", "u1", "u2")
+path["found"]      # => true
+path["node_path"]  # => ["u1", "u2"]
+```
+
+"No path" comes back as `found => false`, not as an error. Also available:
+`graph_get_node`, `graph_get_edge`, `graph_delete_node`, `graph_delete_edge`,
+`graph_list`, `graph_drop`, `graph_traverse`, `graph_weighted_shortest_path`,
+`graph_degree`, `graph_list_nodes`, `graph_list_edges` and `graph_query` for the
+read-only Cypher subset.
+
+## LLM context
+
+```ruby
+bundle = db.llm_context([
+  TriCoreDB::LlmSource.sql("SELECT id, name FROM users"),
+  TriCoreDB::LlmSource.documents("products", limit: 50)
+], format: "toon")
+
+schema = db.llm_schema(format: "markdown")
+```
+
+Sensitive fields are redacted by default (`redact_sensitive: true`).
+
+## Admin
+
+```ruby
+db.admin_ping
+db.admin_status
+```
+
+Admin calls need the cluster module enabled on the server, even on a single node.
+`db.ping` checks the connection itself and reaches no module.
+
+## Errors
+
+Every failure is a `TriCoreDB::Error`. Rescue the class you mean, and branch on
+`code` rather than on the message text:
+
+| Class | Means |
+| --- | --- |
+| `ServerError` | The request arrived and the operation failed. The connection stays usable. |
+| `AuthError` | The credentials were refused. |
+| `ProtocolError` | An ERROR frame, or a peer that broke the protocol. |
+| `ConnectionError` | The transport failed, or the connection was already closed. |
+| `ReadTimeout` | No reply in time; the connection is dropped, because the late reply must not be read as the next answer. |
+| `FeatureNotGranted` | The server lacks a capability this call needs, so nothing was sent. |
+| `ParameterError` | A value with no SQL form; nothing was sent. |
+| `PoolTimeout` | No pooled connection became free in time. |
+
+**Leader redirects.** In a cluster, a write that reaches a follower fails with
+`code == "not_leader"`, which `error.redirect?` and `response.redirect?` test. When
+the cluster knows the leader, `leader_hint` holds its `host:port`; a `nil` hint means
+the destination is unknown yet, so wait and retry — it does not mean the failure was
+something else. This driver does not follow the redirect for you.
+
+```ruby
+begin
+  db.execute("INSERT INTO t VALUES (1)")
+rescue TriCoreDB::ServerError => e
+  raise unless e.code == TriCoreDB::NOT_LEADER
+  retry_against(e.leader_hint) if e.leader_hint
+end
+```
+
+## TLS
+
+TLS is off until `tls:` is given.
+
+```ruby
+db = TriCoreDB::Client.connect(
+  host: "db.internal", user: "admin", secret: "your-password",
+  tls: { ca_file: "/etc/tricore/ca.pem", server_name: "db.internal" }
+)
+```
+
+`tls: true` uses the system trust store. The options are `ca_file`, `server_name`,
+`client_cert_file` and `client_key_file` (both or neither, for mutual TLS), and
+`danger_accept_invalid_certs` — **development only**, since it encrypts the traffic
+while authenticating nobody.
+
+## Testing
+
+```bash
+rake test              # unit tests and the scripted-peer tests; no server needed
+rake test:integration  # the live tests, against a private tricore-server
+```
+
+The scripted-peer tests play the answers a real cluster would send — a `not_leader`
+refusal, a refused handshake, a frame that declares more bytes than it sends — so
+they need no server. The live tests start their own `tricore-server` on an ephemeral
+port: point `TRICORE_SERVER_BIN` at the binary, and without one they skip.
+
+## License
+
+[Apache License 2.0](LICENSE)