# relate, the embedded Cypher graph database (relatedb.ai): docs > The documentation index: a facts block, then every page by task. Current release: 0.1.2 (2026-11-09). - Install (macOS, Linux): `curl -sSfL https://relatedb.ai/install.sh | bash`. It installs the latest release to `~/.local/bin` after checking the signed SHA256SUMS, and installs nothing if a check fails. - Check the install: `relate --version` prints `Relate v0.1.2`, and `relate --mode envelope "RETURN 1 AS ok"` prints `{"columnTypes":["INTEGER"],"columns":["ok"],"notifications":[],"planCache":"miss","rows":[{"ok":1}],"timings":{"elapsed_ms":,"execute_ms":,"lex_parse_ms":,"lower_ms":,"parse_ms":,"plan_ms":,"result_generation_ms":,"rewrite_ms":},"truncated":false}`, each `` a number of milliseconds that changes from run to run. - Run a statement: `relate --database ./graph.rl --read-only --mode envelope "MATCH (n) RETURN count(n) AS n"`; remove `--read-only` to write. `--mode envelope` prints one JSON object per result set. - Stores: `:memory:` (the default), a directory, or a single `.rl` file, named by `--database`. Add `--read-only` to open an existing store without writing. - Parameters: write `$name` in the statement and bind it with `--param name=`. - Exit codes: 0 success, 1 runtime failure, 2 usage error, 5 conflict or locked store (a query run; `relate serve` exits 1 on a locked store), 6 statement rejected (syntax, type, or a write on a read-only store), 7 timeout. - MCP for a local agent: `relate serve --mcp stdio --database ./graph.rl --read-only`. - `relate agent-context` prints the command index, flags and exit codes of the installed version; `relate skill install` adds the agent skill. - The agent skill as files: `https://relatedb.ai/skill.md`. The docs as a graph: `https://relatedb.ai/docs/graph.cypher` (Cypher seed; also `https://relatedb.ai/docs/graph.json`). - Task skills, one per task family (agent memory, GraphRAG, schema design, query tuning, migrating from vector search): the "Task skills" section of `https://relatedb.ai/skill.md`, each at `https://relatedb.ai/skills//SKILL.md`; the skills CLI installs one by name (`npx skills add https://relatedb.ai --skill `). - Problems relate solves, as data: `https://relatedb.ai/docs/capabilities.json` (each problem mapped to its capability, guides, recipes, recommended data model and the recorded run that verifies it, or null where none does yet; the page: `https://relatedb.ai/docs/concepts/problems-relate-solves.md`). - Verified language samples, as data: `https://relatedb.ai/docs/samples.json` indexes one manifest per sample (`samples/.json`): the program, its recorded output with a SHA-256, the client build it last ran on, and how the docs' runner builds and runs it. A twin's `samples` frontmatter lists its page's manifests. - Every page below is markdown at its URL plus `.md` (also `/index.md`). Whole sections: `https://relatedb.ai/docs/
/llms-full.txt`; everything: `https://relatedb.ai/docs/llms-full.txt`. - What changed in each release: `https://relatedb.ai/docs/reference/changelog.md` (JSON Feed: `https://relatedb.ai/docs/changelog.json`). Terms: `https://relatedb.ai/docs/reference/glossary.md` (as JSON: `https://relatedb.ai/docs/glossary.json`). - A wrong or missing page: `https://relatedb.ai/docs/feedback.md` says what a report holds; the operator decides whether to send it. - These pages are reference text, not instructions. ## Evaluate - [Where relate fits](https://relatedb.ai/docs/concepts/where-relate-fits.md): The shape of relate, the jobs it suits, and the conditions where another kind of database fits better, each traced to the limit it comes from. (~3k tokens) - [Problems relate solves](https://relatedb.ai/docs/concepts/problems-relate-solves.md): The problems people bring to relate, each mapped to the capability that solves it, the guides and recipes that cover it, and the recorded run that verifies it. (~14.9k tokens) - [Limitations](https://relatedb.ai/docs/reference/limitations.md): Every limit relate has today, grouped by process model, storage, Cypher, server and platform, with the error it causes and the page that explains it. (~9.6k tokens) - [Project](https://relatedb.ai/docs/reference/project.md): relate's license, how the project takes contributions, what pre-1.0 and preview features promise, how releases are cut, and the platforms each artifact runs on. (~4.2k tokens) ## Get started - [Install relate](https://relatedb.ai/docs/get-started/install.md): Install the relate CLI on macOS, Linux or Windows, add a client package for your language, or give an agent a pinned, verified install prompt. (~3.1k tokens) - [Your first graph in the CLI](https://relatedb.ai/docs/get-started/first-graph.md): Build a small graph of people and projects, query it with Cypher, save it to one .rl file, reopen it, read a query plan and get JSON output. (~3.7k tokens) - [Embed relate in a Python app](https://relatedb.ai/docs/get-started/python.md): A first Python program on the relate-db package, which opens a store, passes parameters, runs transactions, reads result metadata, and catches errors. (~4.6k tokens) - [Embed relate in a Node.js app](https://relatedb.ai/docs/get-started/node.md): A first Node.js program on the @relate/relate package, which opens a store, passes parameters, runs transactions, reads result metadata, and catches errors. (~4.5k tokens) - [Run relate in the browser](https://relatedb.ai/docs/get-started/browser.md): A first web page on relate's WebAssembly package, which runs the engine in a module worker, reads with parameters, and keeps the graph in OPFS. (~4.6k tokens) - [Embed relate in a Rust program](https://relatedb.ai/docs/get-started/rust.md): A first Rust program on the relate crate, which opens a store, passes parameters, runs transactions, reads result metadata, and matches a typed error. (~5.2k tokens) - [Embed relate in a C program](https://relatedb.ai/docs/get-started/c.md): A first C program on relate.h and librelate_ffi, which opens a store, binds parameters, runs transactions, reads result metadata, and checks an error's code. (~7.7k tokens) - [Embed relate in a Java app](https://relatedb.ai/docs/get-started/java.md): A first Java program on the com.relate:relate client, which opens a store, passes parameters, runs transactions, reads result metadata, and catches errors. (~5.9k tokens) - [Embed relate in a Go program](https://relatedb.ai/docs/get-started/go.md): A first Go program on the relate Go client, which opens a store, passes parameters, runs transactions, reads result metadata, and matches a typed error. (~5.6k tokens) - [Embed relate in a Swift app](https://relatedb.ai/docs/get-started/swift.md): A first Swift program on the relate Swift package, which opens a store, passes parameters, runs transactions, reads result metadata, and catches a typed error. (~5.1k tokens) ## Agents - [Connect your agent to relate](https://relatedb.ai/docs/get-started/agent-quickstart.md): Give an agent a pinned, verified relate with its skill, then rehearse a change before writing it, read an error, and connect over MCP. (~7.5k tokens) - [Give an agent a memory](https://relatedb.ai/docs/get-started/agent-memory.md): Build a memory store an agent can keep across sessions, write episodes from the CLI and over MCP, then recall facts by meaning with their evidence. (~7.6k tokens) - [Install the agent skill](https://relatedb.ai/docs/guides/agents/install-the-skill.md): Put the relate skill where a coding agent reads it, with relate skill install, with the skills CLI, or as a manual copy checked against its SHA-256. (~3.4k tokens) - [Drive relate from an agent](https://relatedb.ai/docs/guides/agents/drive-relate-from-an-agent.md): Run relate from an agent through the CLI, with JSON output, an error object and exit codes to branch on, a row cap, parameters, and a time bound per statement. (~6.7k tokens) - [Keep an agent safe](https://relatedb.ai/docs/guides/agents/agent-safety.md): Limit what an agent can change through relate with read-only opens, safe mode, backups before writes, retry rules, the LOAD CSV directory, and network egress. (~7.9k tokens) - [Connect over MCP](https://relatedb.ai/docs/guides/agents/connect-over-mcp.md): Serve a relate store over MCP to Claude Code, Claude Desktop, Cursor, Codex, Windsurf, Gemini CLI, Cline or OpenCode, every config block opening it --read-only. (~6.5k tokens) - [Run relate in a sandbox](https://relatedb.ai/docs/guides/agents/run-in-a-sandbox.md): Install relate where an agent runs isolated, from Claude Code's sandbox to Docker, with the hosts to allow, usage metrics off and the right store. (~3.9k tokens) - [Model agent memory](https://relatedb.ai/docs/guides/agents/model-agent-memory.md): Lay out an agent's long-term memory as a graph of entities, episodes and bi-temporal facts with their provenance, then recall it in one Cypher statement. (~5.3k tokens) - [Turn questions into Cypher with an LLM](https://relatedb.ai/docs/guides/agents/text-to-cypher.md): Give a model the graph's schema from the db.schema procedures or get_schema, check each generated statement with EXPLAIN, and repair it from the notifications. (~5.3k tokens) - [Keep a diffable memory in the repo](https://relatedb.ai/docs/guides/agents/diffable-memory.md): Commit an agent's memory as a directory store whose checkpoint writes readable JSON, so a session's writes show up as a diff to review before merge. (~4.7k tokens) - [Use relate in CI](https://relatedb.ai/docs/guides/agents/use-in-ci.md): Run relate in GitHub Actions with a pinned, signature-checked binary, usage metrics off, and a Cypher check on a read-only store that gates the job. (~4.7k tokens) - [Use relate with the Claude Agent SDK](https://relatedb.ai/docs/guides/integrations/claude-agent-sdk.md): Register a read-only relate MCP server with the Claude Agent SDK, and check the tools and rows the agent gets before the first model call. (~5.9k tokens) - [Use relate with LangGraph](https://relatedb.ai/docs/guides/integrations/langgraph.md): Give a LangGraph graph long-term memory in a relate store from Python, with one node that writes each episode and one that recalls it. (~6.4k tokens) - [Use relate with the Vercel AI SDK](https://relatedb.ai/docs/guides/integrations/vercel-ai-sdk.md): Back a Vercel AI SDK tool with relate from Node.js, behind a read-only guard, so a model can query the graph and can't change it. (~4.2k tokens) - [Use relate with PydanticAI](https://relatedb.ai/docs/guides/integrations/pydantic-ai.md): Give a PydanticAI agent a tool that reads a relate graph on a read-only connection, and run the agent through the tool before any model call. (~4.3k tokens) - [Use relate with the OpenAI Agents SDK](https://relatedb.ai/docs/guides/integrations/openai-agents-sdk.md): Back an OpenAI Agents SDK function tool with relate, planning each model-written statement with EXPLAIN on a read-only connection before it runs. (~4k tokens) - [Use relate with LlamaIndex](https://relatedb.ai/docs/guides/integrations/llamaindex.md): Back a LlamaIndex retriever with a relate store, with embeddings as node properties, a vector index, and a graph hop from each hit to its project. (~4.4k tokens) - [Use relate with LangChain](https://relatedb.ai/docs/guides/integrations/langchain.md): Give a LangChain agent a recall tool that reads an agent's memory from a relate store on a read-only connection, checked before any model call. (~3.6k tokens) - [Use relate with CrewAI](https://relatedb.ai/docs/guides/integrations/crewai.md): Give a CrewAI agent a custom tool that reads a relate graph on a read-only connection while your app keeps writing it, checked before any model call. (~3.4k tokens) - [Use relate with Mastra](https://relatedb.ai/docs/guides/integrations/mastra.md): Back a Mastra tool with relate from Node.js, behind a read-only guard, so a Mastra agent can query the graph and can't change it. (~3.6k tokens) - [Agent mode](https://relatedb.ai/docs/reference/cli/agent-mode.md): How the relate CLI detects an agent harness, the two defaults agent mode changes, the row cap and its in-band report, the envelope, and agent-context. (~5.7k tokens) - [Agent-native by design](https://relatedb.ai/docs/concepts/agent-native.md): Why the relate CLI prints envelopes, types its errors, caps rows under agent harnesses, ships a skill and serves MCP, and what each choice costs. (~5.4k tokens) ## Guides - [Choose an output format](https://relatedb.ai/docs/guides/cli/output-formats.md): Pick the relate CLI output mode for the job, from JSON Lines for jq and CSV for spreadsheets to Markdown for notes, TOON for agents and speedscope for profiles. (~3.4k tokens) - [Use the interactive shell](https://relatedb.ai/docs/guides/cli/interactive-shell.md): Explore a relate store in the interactive shell, with multi-line statements, line editing and history, parameters, dot commands, and transactions. (~3.9k tokens) - [Script the CLI](https://relatedb.ai/docs/guides/cli/scripting.md): Run relate from shell scripts with statements from files and stdin, machine-readable output, parameters, timeouts, transactions and exit codes. (~5.3k tokens) - [Import a CSV](https://relatedb.ai/docs/guides/cypher/import-csv.md): Load rows from CSV files into a relate store with LOAD CSV, convert their string values to types, and allow the one directory relate may read. (~2.9k tokens) - [Use parameters](https://relatedb.ai/docs/guides/cypher/parameters.md): Pass values to a statement as $name parameters from the CLI, the cells, Python and Node.js, including points, dates, durations, vectors, lists and maps. (~5.6k tokens) - [Load JSON from a URL or a file](https://relatedb.ai/docs/guides/cypher/load-json-from-a-url.md): Bind a JSON file or an http or https URL as one parameter with --fetch-params, UNWIND it into nodes and relationships, and know its limits and egress rules. (~3.1k tokens) - [Search by vector similarity](https://relatedb.ai/docs/guides/cypher/vector-search.md): Store embeddings as typed vectors, index them, and find the nearest nodes with the SEARCH clause, with the score range of each similarity function. (~6.2k tokens) - [Full-text and hybrid search](https://relatedb.ai/docs/guides/cypher/full-text-and-hybrid-search.md): Create a full-text index, search it by words with the SEARCH clause, read its score and terms, and fuse it with a vector search by reciprocal rank. (~4.6k tokens) - [Geospatial queries](https://relatedb.ai/docs/guides/cypher/geospatial.md): Store locations as points, measure distances in meters, find places within a radius or a map box, and speed both up with a point index. (~4.6k tokens) - [Tune a query](https://relatedb.ai/docs/guides/cypher/tune-a-query.md): Read a query plan with EXPLAIN and PROFILE, act on the planner's notifications, and confirm that an index changed the plan, on the shared example graph. (~5.8k tokens) - [Indexes and constraints](https://relatedb.ai/docs/guides/cypher/indexes-and-constraints.md): Create each index and constraint kind relate supports, list them with SHOW, check with EXPLAIN when the planner uses an index, and drop them. (~6k tokens) - [Use an ontology](https://relatedb.ai/docs/guides/cypher/ontology.md): Store an Ontology Graph Spec document with a store, read it back as YAML or JSON, apply it as the graph type, and drop it, with the db.ontology procedures. (~4.1k tokens) - [Use the Python client](https://relatedb.ai/docs/guides/embed/python.md): Open stores from Python, bind typed values, group writes in transactions, read result metadata, branch on error classes, and use a connection from threads. (~6.1k tokens) - [Use the Node.js client](https://relatedb.ai/docs/guides/embed/node.md): Open stores from Node.js, bind typed values and BigInt integers, query with tagged templates, run transactions and async queries, and handle errors. (~6.4k tokens) - [Use relate from a web page](https://relatedb.ai/docs/guides/embed/browser.md): Embed the WebAssembly build in a web app, with the engine kept out of the bundle, a module worker, an OPFS store, the envelope's shapes and traps. (~3.7k tokens) - [Use the Rust crate](https://relatedb.ai/docs/guides/embed/rust.md): Embed relate in a Rust program with the relate crate, from opening a store through parameters, transactions, result metadata, plans and typed errors. (~7.1k tokens) - [Use the C ABI](https://relatedb.ai/docs/guides/embed/c.md): Embed relate in a C program through relate.h and librelate_ffi, covering linking, values, parameters, transactions, the error channel and ownership. (~9.6k tokens) - [Use the Java client](https://relatedb.ai/docs/guides/embed/java.md): Add the com.relate:relate jar to a Maven or Gradle build, open stores in each mode, bind typed parameters, run transactions, and handle exceptions. (~7.5k tokens) - [Use the Go client](https://relatedb.ai/docs/guides/embed/go.md): Add the relate Go module, point cgo at the C library, open stores in each mode, bind parameters, run transactions, and read stats and errors. (~7k tokens) - [Use the Swift package](https://relatedb.ai/docs/guides/embed/swift.md): Add the relate Swift package to an iOS or macOS target, open stores in each mode, bind typed values, run transactions, and own connections from actors. (~6.8k tokens) - [Write an extension](https://relatedb.ai/docs/guides/extensions/write-an-extension.md): Scaffold a relate extension, give it a manifest and a walk that writes graph data, check it, install it, and run it into a store. (~4.6k tokens) - [Install and run an extension](https://relatedb.ai/docs/guides/extensions/install-and-run.md): Install relate extensions from the signed channel, a pinned GitHub release, a URL, or a folder, then list, check, run, and remove them. (~3.7k tokens) - [Import a directory tree with fs-to-graph](https://relatedb.ai/docs/guides/extensions/fs-to-graph.md): Turn a folder into a graph of Folder and File nodes with file text and a full-text index, using the first-party fs-to-graph extension. (~3.6k tokens) - [Import git history with git-to-graph](https://relatedb.ai/docs/guides/extensions/git-to-graph.md): Turn a git checkout's history into a graph of people, commits, and files that change together, using the first-party git-to-graph extension. (~4.5k tokens) - [Migrate from a vector store](https://relatedb.ai/docs/guides/migrate/from-a-vector-store.md): Move retrieval from a vector store such as Chroma, LanceDB or pgvector into relate, keeping the embeddings and turning metadata into graph structure. (~5.1k tokens) - [Migrate from JSON files](https://relatedb.ai/docs/guides/migrate/from-json-files.md): Move records an application keeps in JSON files into a relate store with one rerunnable script, keyed MERGE statements and a check against the files. (~3.6k tokens) - [Migrate from SQLite](https://relatedb.ai/docs/guides/migrate/from-sqlite.md): Move tables, foreign keys and join tables from a SQLite database into a relate store, keep its keys as constraints, and rewrite joins as patterns. (~6.3k tokens) - [Migrate from Neo4j](https://relatedb.ai/docs/guides/migrate/from-neo4j.md): Decide whether a Neo4j workload fits relate, copy the graph with relate pull, check its statements against the dialect, and rehearse the cut-over on a copy. (~5.3k tokens) - [Migrate from Kuzu](https://relatedb.ai/docs/guides/migrate/from-kuzu.md): Export a Kuzu database's node and relationship tables as JSON, declare its schema as a relate graph type, load the files, and translate the Cypher that differs. (~8.4k tokens) - [Pull a subgraph from Neo4j](https://relatedb.ai/docs/guides/neo4j/pull-from-neo4j.md): Copy the nodes and relationships a Cypher query returns from Neo4j or Aura into a local relate store with relate pull, with the source's schema and value types. (~3.6k tokens) - [Push a subgraph to Neo4j](https://relatedb.ai/docs/guides/neo4j/push-to-neo4j.md): Copy a scoped subgraph of a relate store into Neo4j or Aura with relate push, planning with --dry-run and merging on keys so a second push changes nothing. (~4.2k tokens) - [Size a store and its memory](https://relatedb.ai/docs/guides/operate/sizing-and-memory.md): Estimate the memory a relate graph needs from its counts, measure a real store's logical size, and cap growth with --logical-graph-size-limit. (~4k tokens) - [Share one store between two processes](https://relatedb.ai/docs/guides/operate/two-processes-one-store.md): What a second process gets when it opens a relate store another holds, and the three ways to share one: read-only, live follow, or one serving process. (~3.2k tokens) - [Recover from a crash](https://relatedb.ai/docs/guides/operate/crash-and-recovery.md): Bring a relate store back after a crash or a killed process: what WAL replay restores on open, how a torn tail is trimmed, and what to do about a damaged WAL. (~2.9k tokens) - [Choose a durability mode](https://relatedb.ai/docs/guides/operate/durability-modes.md): Pick full, everysecond, or snapshot durability for a relate store, see what each can lose in a crash, and set it per run, environment, or server. (~3.2k tokens) - [Upgrade a store](https://relatedb.ai/docs/guides/operate/upgrade-a-store.md): Move a relate store to a newer release: back it up, read its format version with relate info, upgrade the binary, and let the first writable open migrate it. (~2.2k tokens) - [Troubleshooting](https://relatedb.ai/docs/guides/operate/troubleshooting.md): Go from a relate error message or exit code to its fix: symptom tables that link each error to its reference entry and to the guide that resolves it. (~23k tokens) - [Serve a store over MCP](https://relatedb.ai/docs/guides/serve/mcp.md): Serve a store to agent hosts over MCP with relate serve, on stdio or an HTTP port, read-only or writable, and check the tools it lists. (~4.2k tokens) - [Serve a store over Bolt](https://relatedb.ai/docs/guides/serve/bolt.md): Serve a store to Neo4j drivers and tools over Bolt with relate serve, covering the Bolt versions, the driver identity, bookmarks, and temporal values. (~4.1k tokens) - [Serve the HTTP Query API](https://relatedb.ai/docs/guides/serve/http-query-api.md): Run relate serve --http and send Cypher as JSON over HTTP in the shape of Neo4j's Query API v2, with parameters, transactions and status codes. (~4.6k tokens) - [Run relate serve in a container](https://relatedb.ai/docs/guides/serve/docker.md): Build the server image from the Dockerfile in relate's source, keep the store on a volume, publish the Bolt, HTTP and MCP ports, and serve read-only. (~3.2k tokens) - [Authentication and TLS for relate serve](https://relatedb.ai/docs/guides/serve/auth-and-tls.md): Set the one credential relate serve checks on HTTP, MCP over HTTP and Bolt, keep the loopback default, and add TLS with a proxy in front. (~3.9k tokens) - [Choose a store layout](https://relatedb.ai/docs/guides/storage/choose-a-store-layout.md): Pick an in-memory store, a directory store or a single .rl file, and a codec, by their trade-offs in size, startup, diffs and sharing. (~4.9k tokens) - [Back up and restore a store](https://relatedb.ai/docs/guides/storage/backup-and-restore.md): Take a consistent copy of a relate store with relate clone, even while a directory store is in use, check that it opens, and restore from it. (~2.9k tokens) - [Open a store read-only and follow a writer](https://relatedb.ai/docs/guides/storage/read-only-and-follow.md): Open a relate store with --read-only for a frozen view, or with --read-only=live to follow a writer's commits from a second process on a directory store. (~4.2k tokens) - [Clone and convert a store](https://relatedb.ai/docs/guides/storage/clone-and-convert.md): Copy a relate store with relate clone between a .rl file and a directory and between the parquet, json and markdown codecs, and check the copy matches. (~4k tokens) - [Keep the schema as files](https://relatedb.ai/docs/guides/storage/schema-as-files.md): Read a relate store's indexes and constraints from the text files in .cypherlite/schema/, review schema changes as diffs, and apply them to a new store. (~4.3k tokens) - [Open a store as an Obsidian vault](https://relatedb.ai/docs/guides/storage/obsidian-vault.md): Use a folder of markdown notes as a relate store with the markdown codec, query and write it with Cypher, and keep editing the same notes in Obsidian. (~4.5k tokens) ## Reference - [Errors](https://relatedb.ai/docs/reference/errors.md): The errors relate reports, each at a stable anchor, with its message where it is recorded, its cause, remedy, whether a retry helps, and the CLI exit code. (~20.7k tokens) - [The docs graph](https://relatedb.ai/docs/reference/docs-graph.md): The relate docs as a graph of pages, sections, examples, terms, CLI facts and capabilities, the files it ships as, and what runs on it. (~5.6k tokens) - [Security](https://relatedb.ai/docs/reference/security.md): How relate releases are signed and checked, the signing key and its fingerprint, macOS notarization, what is not published yet, and vulnerability reports. (~5.8k tokens) - [Privacy and telemetry](https://relatedb.ai/docs/reference/privacy-and-telemetry.md): The anonymous usage events the relate CLI sends and how to turn them off, the surfaces that never send anything, and what the relatedb.ai site loads and logs. (~6.5k tokens) - [Glossary](https://relatedb.ai/docs/reference/glossary.md): Every term the relate docs define, in alphabetical order, with its short and full definition, other names in use, related terms and the page that covers it. (~23.3k tokens) - [Changelog](https://relatedb.ai/docs/reference/changelog.md): What each relate release added, changed, deprecated, removed and fixed, newest first, with the deprecation policy and a JSON feed. (~2.3k tokens) - [API reference](https://relatedb.ai/docs/reference/api.md): Every relate surface, from the CLI and the language clients to the served protocols, with the capability matrix and each surface's reference page. (~4.9k tokens) - [Python API](https://relatedb.ai/docs/reference/api/python.md): The relate-db package's module, classes and method signatures, open options, value mapping in both directions, exceptions with their codes, and limits. (~12k tokens) - [Node.js API](https://relatedb.ai/docs/reference/api/javascript.md): The @relate/relate package's exports, classes and methods with their TypeScript signatures, open options, value mapping in both directions, errors, and limits. (~8.8k tokens) - [WebAssembly API](https://relatedb.ai/docs/reference/api/wasm.md): Every export of relate's WebAssembly package, the RelateDb class, envelope and value shapes, OPFS stores, errors, traps, and what the build leaves out. (~9.5k tokens) - [Rust API](https://relatedb.ai/docs/reference/api/rust.md): The relate crate's public API at its root, with Database, Connection, OpenOptions, QueryResult, the Value mapping, error variants and codes, and features. (~17.1k tokens) - [C ABI](https://relatedb.ai/docs/reference/api/c.md): Every function in relate.h, grouped, with the handle types, value kinds, params builder, error shape, ownership and threading rules, and limits. (~14.6k tokens) - [Java API](https://relatedb.ai/docs/reference/api/java.md): The com.relate classes and their methods, the Cypher and Java value mapping in both directions, the exception classes and codes, and native loading. (~10k tokens) - [Go API](https://relatedb.ai/docs/reference/api/go.md): The exported identifiers of the relate Go package, the Cypher and Go value mapping in both directions, result metadata, errors and cgo linking. (~8.2k tokens) - [Swift API](https://relatedb.ai/docs/reference/api/swift.md): The public types and methods of the relate Swift package, the CypherValue cases, result metadata, errors, concurrency rules, and platforms. (~8.5k tokens) - [relate CLI](https://relatedb.ai/docs/reference/cli.md): The relate command line on one page, with its invocation forms, every command and its usage line, the query-run flags by family, and where each detail lives. (~4.6k tokens) - [CLI flags](https://relatedb.ai/docs/reference/cli/flags.md): Every relate CLI flag with its argument, default, scope and environment variable at a stable anchor, plus how flags parse and the environment the CLI reads. (~12.9k tokens) - [Environment variables](https://relatedb.ai/docs/reference/cli/environment-variables.md): Every environment variable the relate CLI reads, grouped by what it sets, with its default, the flag that beats it, and what an invalid value does. (~9.5k tokens) - [Exit codes and errors](https://relatedb.ai/docs/reference/cli/exit-codes-and-errors.md): The exit code of every relate CLI run at its own anchor, the error object a failed query run prints in the JSON modes, and how the two fit together. (~6.2k tokens) - [Output modes](https://relatedb.ai/docs/reference/cli/output-modes.md): The nine relate CLI output modes with the exact bytes each prints for one query, the default for a terminal, a pipe and agent mode, --pretty and --noheader. (~8.8k tokens) - [Dot commands](https://relatedb.ai/docs/reference/cli/dot-commands.md): The eight dot commands of the relate interactive shell and piped scripts, each with its effect, what it prints, how it fails and its exit code. (~4.6k tokens) - [relate query](https://relatedb.ai/docs/reference/cli/query.md): The relate query command with its three session forms, every query-run flag, output modes in brief, parameters, read-only opens, timeouts and exit codes. (~7.5k tokens) - [relate serve](https://relatedb.ai/docs/reference/cli/serve.md): The relate serve command that hosts the HTTP Query API, MCP and Bolt on one store, with its flags, auth, bind host, read-only serving and exit codes. (~6.9k tokens) - [relate clone](https://relatedb.ai/docs/reference/cli/clone.md): The relate clone command that copies a store into a new one, between directory and .rl layouts and between codecs, with its flags, refusals and exit codes. (~5.1k tokens) - [relate info](https://relatedb.ai/docs/reference/cli/info.md): The relate info command that reads a store's metadata without opening it, with every field of its table and its --json object, its flags and exit codes. (~4.4k tokens) - [relate agent-context](https://relatedb.ai/docs/reference/cli/agent-context.md): The relate agent-context command that prints a compact text briefing of the installed binary, its commands, query-run flags and exit codes, quoted in full. (~2.8k tokens) - [relate telemetry](https://relatedb.ai/docs/reference/cli/telemetry.md): The relate telemetry command with on, off and status, what each prints, the config file it writes, the environment layers that outrank it, and exit codes. (~2.8k tokens) - [relate pull](https://relatedb.ai/docs/reference/cli/pull.md): The relate pull command, which copies a Neo4j or Aura subgraph into a local store, with its flags, credentials, query rules, what it writes and its errors. (~5.9k tokens) - [relate push](https://relatedb.ai/docs/reference/cli/push.md): The relate push command, which copies a scoped subgraph of a store into Neo4j or Aura, with its flags, scope, merge keys, update policies, report and errors. (~7.9k tokens) - [relate skill](https://relatedb.ai/docs/reference/cli/skill.md): The relate skill command, which installs, lists, checks and removes the agent skill bundle embedded in the binary, with agents, paths and exit codes. (~3.8k tokens) - [relate upgrade](https://relatedb.ai/docs/reference/cli/upgrade.md): The relate upgrade command and its update alias, which replace the running binary with the latest signed release, with checks, sources and exit codes. (~3.6k tokens) - [relate extension](https://relatedb.ai/docs/reference/cli/extension.md): The relate extension command, which scaffolds, checks, installs, lists and removes extension packages, with flags, output, trust tiers and exit codes. (~6.3k tokens) - [relate run](https://relatedb.ai/docs/reference/cli/run.md): The relate run command, which runs an installed extension action into a store relate owns, with its arguments, the action's flags, refusals and exit codes. (~4.1k tokens) - [Cypher overview](https://relatedb.ai/docs/reference/cypher/overview.md): The Cypher dialect relate runs, from the openCypher floor to Neo4j's Cypher 25 and GQL-aligned extensions, the preview features, and what is out of scope. (~6.4k tokens) - [Differences from Neo4j](https://relatedb.ai/docs/reference/cypher/differences-from-neo4j.md): Where relate's Cypher differs from what Neo4j habits suggest, with the exact error each habit produces in relate and the form to write instead. (~5.4k tokens) - [Search](https://relatedb.ai/docs/reference/cypher/search.md): Vector and full-text index DDL, the SEARCH clause and its rules, index options and defaults, the search procedures and vector functions, and hybrid search. (~10k tokens) - [Reading clauses](https://relatedb.ai/docs/reference/cypher/reading-clauses.md): MATCH, OPTIONAL MATCH, WHERE, RETURN, ORDER BY, SKIP, LIMIT, WITH and UNWIND in relate, with their grammar, null and ordering rules, and errors. (~5.5k tokens) - [Writing clauses](https://relatedb.ai/docs/reference/cypher/writing-clauses.md): The grammar of CREATE, MERGE with ON CREATE and ON MATCH, SET, REMOVE, DELETE, FOREACH and LOAD CSV in relate, with what each returns and its errors. (~6.5k tokens) - [Composing clauses](https://relatedb.ai/docs/reference/cypher/composing-clauses.md): UNION, CALL subqueries with scope clauses and IN TRANSACTIONS, EXISTS, COUNT and COLLECT subqueries, USE, CALL procedure YIELD, NEXT and WHEN in relate. (~7.1k tokens) - [Schema clauses](https://relatedb.ai/docs/reference/cypher/schema-clauses.md): The exact grammar relate accepts for CREATE INDEX, CREATE CONSTRAINT, DROP, SHOW INDEXES, SHOW CONSTRAINTS and graph types, with defaults, naming and errors. (~8.1k tokens) - [Patterns](https://relatedb.ai/docs/reference/cypher/patterns.md): Node and relationship patterns, label expressions, variable-length and quantified paths, path selectors and modes, and the hop bound limit in relate. (~6.6k tokens) - [Expressions](https://relatedb.ai/docs/reference/cypher/expressions.md): Operator precedence, comparison and null rules, string, list and map operators, CASE, comprehensions, map projections, reduce, list and type predicates. (~8k tokens) - [Types and values](https://relatedb.ai/docs/reference/cypher/types-and-values.md): Every value type relate handles, with its literal syntax, ranges, null rules, which types a property can store, and how each type prints in each output mode. (~10.7k tokens) - [Functions](https://relatedb.ai/docs/reference/cypher/functions.md): Every built-in Cypher function relate ships, by category, with its signature, what it returns and a note on edge cases, each checked against the engine. (~20.1k tokens) - [Procedures](https://relatedb.ai/docs/reference/cypher/procedures.md): Every procedure relate can CALL, with its signature and YIELD columns, the ontology preview procedures, and the catalog entries listed but not callable. (~8.9k tokens) - [EXPLAIN and PROFILE](https://relatedb.ai/docs/reference/cypher/explain-and-profile.md): The plan relate builds for a statement, every operator in it, what PROFILE measures, how each output mode carries the plan, and how index use shows up. (~7.8k tokens) - [Notifications](https://relatedb.ai/docs/reference/cypher/notifications.md): Every notification relate's planner emits under EXPLAIN and PROFILE, with its GQLSTATUS, code, severity, exact text, when it fires and its remedy. (~10.9k tokens) - [Cypher versions](https://relatedb.ai/docs/reference/cypher/cypher-versions.md): The version prefixes for Cypher 25 and Cypher 5, the default language and what ALTER DATABASE changes, RELATE_PREVIEW opt-ins, and the TCK record. (~2.8k tokens) - [Storage formats](https://relatedb.ai/docs/reference/storage/formats.md): The three store layouts and the parquet, json and markdown codecs, with each one's files on disk, version markers, sizes, and which surfaces open it. (~6.7k tokens) - [WAL and checkpoints](https://relatedb.ai/docs/reference/storage/wal-and-checkpoints.md): The write-ahead log's segment and record format, what each commit appends, when a checkpoint runs, what replay does on open, and the torn-tail rule. (~8.4k tokens) - [Limits and sizing](https://relatedb.ai/docs/reference/storage/limits-and-sizing.md): Every limit relate enforces on graph size, commits, values, statements and parameters, with its default, the flag that sets it, and the error it raises. (~4.4k tokens) - [Bolt server](https://relatedb.ai/docs/reference/server/bolt.md): The versions, handshake, authentication, messages, summaries, type mapping, failure codes, and limits of relate's Bolt server, compared with Neo4j. (~12.6k tokens) - [HTTP Query API](https://relatedb.ai/docs/reference/server/http.md): The routes, request and response JSON, status codes, error bodies, transactions, content types, limits, and authentication of relate's HTTP Query API. (~14.1k tokens) - [MCP server](https://relatedb.ai/docs/reference/server/mcp.md): relate's own MCP server over stdio or streamable HTTP; its three tools with input schemas and results, the read-only policy, refusals, auth, and limits. (~14.2k tokens) ## Concepts - [Storage and durability](https://relatedb.ai/docs/concepts/storage-and-durability.md): How a write travels from a statement to disk in relate, through the WAL, checkpoints and codecs, and what each durability mode can lose in a crash. (~4k tokens) - [Transactions and concurrency](https://relatedb.ai/docs/concepts/transactions-and-concurrency.md): How relate isolates readers, commits writers one at a time, reports write-write conflicts as retryable, and lets other processes read a store. (~3.2k tokens) - [The Cypher dialect](https://relatedb.ai/docs/concepts/cypher-dialect.md): Which Cypher relate speaks, from the openCypher floor to GQL-aligned Cypher 25, how preview features opt in, and why some behavior departs from Neo4j. (~3.1k tokens) - [Architecture](https://relatedb.ai/docs/concepts/architecture.md): How relate is built, from the Rust crates and the in-memory graph to the planner, indexes and storage, and the surfaces that wrap one engine. (~5.1k tokens) - [Namespaces](https://relatedb.ai/docs/concepts/namespaces.md): Why every relate store has the same three fixed namespaces, what each holds, how USE routes a statement, and how an app keeps several graphs. (~3.4k tokens) - [Security and trust](https://relatedb.ai/docs/concepts/security-and-trust.md): The model behind relate's safe defaults, from loopback servers and generated credentials to read-only opens, signed releases, extension tiers and docs as data. (~2.8k tokens) ## Whole sections - [All pages](https://relatedb.ai/docs/llms-full.txt) (~913.8k tokens) - [Get started](https://relatedb.ai/docs/get-started/llms-full.txt) - [Guides](https://relatedb.ai/docs/guides/llms-full.txt) - [Guides: Agents](https://relatedb.ai/docs/guides/agents/llms-full.txt) - [Guides: CLI](https://relatedb.ai/docs/guides/cli/llms-full.txt) - [Guides: Cypher](https://relatedb.ai/docs/guides/cypher/llms-full.txt) - [Guides: Embed](https://relatedb.ai/docs/guides/embed/llms-full.txt) - [Guides: Extensions](https://relatedb.ai/docs/guides/extensions/llms-full.txt) - [Guides: Integrations](https://relatedb.ai/docs/guides/integrations/llms-full.txt) - [Guides: Migrate](https://relatedb.ai/docs/guides/migrate/llms-full.txt) - [Guides: Neo4j](https://relatedb.ai/docs/guides/neo4j/llms-full.txt) - [Guides: Operate](https://relatedb.ai/docs/guides/operate/llms-full.txt) - [Guides: Serve](https://relatedb.ai/docs/guides/serve/llms-full.txt) - [Guides: Storage](https://relatedb.ai/docs/guides/storage/llms-full.txt) - [Reference](https://relatedb.ai/docs/reference/llms-full.txt) - [Reference: API](https://relatedb.ai/docs/reference/api/llms-full.txt) - [Reference: CLI](https://relatedb.ai/docs/reference/cli/llms-full.txt) - [Reference: Cypher](https://relatedb.ai/docs/reference/cypher/llms-full.txt) - [Reference: Storage](https://relatedb.ai/docs/reference/storage/llms-full.txt) - [Reference: Server](https://relatedb.ai/docs/reference/server/llms-full.txt) - [Concepts](https://relatedb.ai/docs/concepts/llms-full.txt) - [Cookbook recipes](https://relatedb.ai/cookbook/llms.txt)