All Guides

Point your coding agent at a running RavenDB cluster over MCP. Twenty-one read-only tools, one environment variable, and it reads the cluster instead of guessing.

Set up self-hosted Quill to put a conversational AI agent in front of your existing SQL database: run the Docker appliance, connect a database and a model, build the agent, and embed the chat widget.

Use the CDC Sink ongoing task to keep a live copy of PostgreSQL tables in RavenDB as documents, and learn how to reshape normalized rows into well-modeled documents by embedding, linking, or copying fields.

Use the RavenDB Debug Package Analyzer in the Studio to diagnose a misbehaving cluster you cannot connect to. Read the cluster, node, and database panels of a debug package to move from symptom to cause without handling production data.

Consolidate duplicate ETL, backup, and replication connection strings scattered across databases into a single server-wide definition, and migrate existing databases to it.

Set up a RavenDB Azure Service Bus Queue Sink that turns incoming Service Bus messages into documents, covering SAS, Entra ID, and passwordless authentication, configured either in the Studio or with the C# client API.

Register an SSO proxy's server certificate with RavenDB and map external identities to clearance levels and database permissions, in the Studio and through the API.

Learn how to use withContextPrefix() in RavenDB 7.2.3 to inject document-level context into every embedding chunk, improving vector search precision for large documents.

Learn how to use the RavenDB ETL Errors View in Studio to diagnose and fix ETL pipeline issues, including script errors, connection failures, and transformation problems.

Learn how to connect multiple RavenDB AI Agents into a multi-agent system, where specialized sub-agents handle focused tasks while a coordinator routes work between them.

Learn how to attach binary files such as PDFs and images to RavenDB AI Agent conversations, reducing token usage while keeping files accessible across the conversation lifecycle.

Learn how RavenDB backups work, when to use logical backups versus snapshots, and how to configure scheduled and server-wide backup tasks via Studio and C# code.

Learn how to use RavenDB Studio's Cluster Dashboard, Traffic Watch, Admin Logs, and other built-in tools to diagnose and investigate database performance issues.

Learn how to implement spatial search in RavenDB with Python. Covers radius queries, custom polygon shapes, WKT syntax, and reverse point-in-polygon lookup using the Flat Finder demo.

Set up Context7 MCP with OpenAI Codex in VS Code to give your AI direct access to RavenDB docs — faster, context-rich vibe coding with fewer interruptions.

Step-by-step guide to deploying a fully secured RavenDB cluster on Kubernetes using the RavenDB Operator, covering TLS, cert-manager, storage, and rolling upgrades.

Learn to implement the transactional outbox pattern in C# using RavenDB data subscriptions or Queue ETL, with RabbitMQ and Kafka code examples.

RavenDB client certificates that renew automatically without re-registration using vault-backed key reuse patterns.

Configure JSON schema validation in RavenDB to enforce data consistency across teams. Learn how to audit documents against a schema or block invalid writes at the database level.

Store RavenDB attachments in Amazon S3 or Azure Blob Storage to cut costs. Studio and C# setup guide with bulk migration of existing attachments.

Build an AI agent with RavenDB: create an Orders Manager in Studio, wire up Query and Action tools, and scope conversation data per user.

External

Read about Building a Beer Vending Machine with RavenDB Embedded on the RavenDB.net news section

Move operational data out of RavenDB and into an OLAP engine using OLAP ETL, shaping documents into Parquet and shipping them to local storage or Amazon S3 on a schedule you control.

Set up RavenDB's native Elasticsearch ETL to continuously extract, transform, and load your RavenDB collections into Elasticsearch indexes, with no custom pipelines or bespoke integration code.

Why RavenDB queries can return stale results, when that is perfectly fine, and how to force fresh results per query, per session, or across the whole document store.

External

Read about Deploying RavenDB with Helm Chart on the RavenDB.net news section

Use RavenDB Data Archival to exclude historical documents from indexes and queries, keeping performance high without deleting data you need to retain.

Deploy Zabbix with Docker, connect it to RavenDB Cloud via SNMPv3, and configure custom SNMP items to monitor ETL errors and AI task failures in real time.

Step-by-step walkthrough of deploying a RavenDB server on AWS Marketplace, covering EC2 instance configuration, security group rules, SSH port-forwarding, and initial RavenDB Studio access.

Run semantic searches over your documents with RavenDB 7.0 vector search: generate embeddings on the server with no external tools, and query them through static indexes or auto-indexes.

Trace live and historical requests to your RavenDB cluster with Traffic Watch, Admin Logs, Studio notifications, and Audit Logs to diagnose unexpected activity and performance issues.

Push RavenDB document changes onto Azure Queue Storage with an ETL task, then process them serverlessly with an Azure Function.

Feed PDFs, images, and logs straight into RavenDB's GenAI feature. Three worked examples: image vector search without an image model, attachment-aware support triage, and PDF resume screening.

Build a minimal ASP.NET Core 9 API that queries RavenDB documents, including optional LINQ-based filtering and Swagger-based testing.

Discover 7 common RavenDB index anti-patterns, including misusing LoadDocument and storing too many fields, and learn how to fix each one for better query performance.

Build text-to-image and image-to-image product search on top of RavenDB vector search, using CLIP embeddings stored in documents and the original images kept as attachments.

Track down the RavenDB index that's consuming your disk I/O using the Studio Indexing Performance view, iotop on Linux, and Resource Monitor on Windows, then optimize the culprit.

Build a persistent Akka.NET console app that stores its actor state in RavenDB through event sourcing and snapshots, so it can recover exactly where it left off after a crash or restart.

External

Read about GenAI: How We Make You Work Less on the RavenDB.net news section

How RavenDB projections return only the fields you need, why projected data comes from documents by default, and how to store fields in a static index and tune projection behavior for faster reads.

Build a semantic search API with RavenDB, Python, and FastAPI. Learn manual and automatic embedding generation with OpenAI, and run vector similarity search in under 50 lines of application code.

Learn how to use RavenDB's GenAI feature to automatically summarize, prioritize, and enrich documents. Step-by-step walkthrough with code examples and screenshots.

Automate RavenDB with the Ansible Collection: provision multi-node clusters over SSH, form clusters, and manage databases and indexes with repeatable playbooks.

Connect RavenDB to Datadog by running the Datadog Agent in Docker and enabling OpenTelemetry, then build a CPU usage dashboard and a high-CPU alert.

Three ways to move a RavenDB database between instances: a simple export and import, a direct import over a URL for large datasets, and live external replication with no downtime.

Match accented terms like Kraków against both Kraków and Krakow. Compares manual diacritics normalization with a custom ASCIIFoldingFilter analyzer for Lucene and Corax indexes.

Add AI-driven vector search to a Next.js app using RavenDB's embeddings generation AI Task and a single vector.search RQL query, almost like using a regular search API.

Enable OpenTelemetry in RavenDB, export its metrics to Grafana Cloud through the OTLP endpoint, and build a CPU usage dashboard in Grafana.

Diagnose and fix high memory usage in RavenDB: understand how RavenDB manages memory with memory-mapped files, spot trouble on Windows, Linux, and in the Studio, then trace the cause with admin logs, debug endpoints, and dotnet-dump.

Connect an AI provider like OpenAI, create an embeddings generation task, and query your documents by meaning with RavenDB vector search.

Learn how to scaffold a minimal API with ASP.NET Core 8 and wire up create, read, update, and delete document operations against a RavenDB database.

External

Read about Integrating RavenDB with .NET Aspire on the RavenDB.net news section

Connect RavenDB to Power BI through the PostgreSQL protocol integration, then build charts and filter your data with queries during import to visualize your documents.

Set up an ongoing Snowflake ETL task in RavenDB to continuously sync documents to your Snowflake data warehouse, using a worked traffic-sensor IoT example.

Deploy a 3-node RavenDB cluster with Docker Compose across three security levels: unsecured HTTP for local development, TLS with self-signed certificates for internal environments, and production-grade Let's Encrypt automation.

Step-by-step guide to deploying a production-ready RavenDB cluster on Amazon EKS, covering IAM roles, VPC networking, node groups, EBS storage provisioning, Load Balancer Controller, and ExternalDNS for stable external access.

Learn how to connect a C# console application to a RavenDB Cloud instance using the RavenDB Client package, a PFX certificate, and DocumentStore.

Step-by-step guide to creating a RavenDB Cloud account, provisioning a free instance, downloading the TLS certificate, and connecting a Node.js application using DocumentStore with PFX authentication.

External

Read about Connecting Node.JS web application to RavenDB on the RavenDB.net news section

Step-by-step guide to connecting an ASP.NET Core 8 web API to RavenDB Cloud, including certificate setup, DocumentStore initialization, and verifying the connection by loading a document.

Set up an ongoing Amazon SQS ETL task in RavenDB to stream documents into an SQS queue, then process them with an AWS Lambda function that emails speeding-ticket alerts through SES.

Route RavenDB 7.0 server logs to Grafana Cloud by configuring the NLog Loki target, then view and filter them in Grafana Explore.

Track down what drives RavenDB's CPU load. Tell Current CPU Usage from Total CPU Time, then diagnose it with top, htop, and RavenDB Studio.

Replicate production-quality data into staging on demand with RavenDB using External Replication, ETL with anonymization and filtering, or Export/Import.

Step-by-step guide to building a SvelteKit web application backed by RavenDB, covering project setup, document store configuration, CRUD operations with form actions, and streaming query results.

See how RavenDB Data Subscriptions let you offload invoice processing to a background worker in C#, with PDF generation and attachment storage included.

Learn how to run RavenDB in Docker with a self-signed TLS certificate using Docker Compose, including cert generation, volume setup, and environment variable configuration.

Extend RavenDB's indexing process with machine learning in C#: train an ML.NET model to flag toxic comments during indexing, and use a pre-trained Catalyst model to detect each document's language, all through AdditionalAssemblies and AdditionalSources.

How to use dynamic fields in RavenDB static indexes to query on properties that aren't defined at index-creation time, plus the pitfalls to watch for with duplicate field names and stored projections.

Learn how to set up the ravendb-test-driver Maven package for Java integration tests, run RavenDB in-memory per test, and use preInitialize, setupDatabase, and waitForIndexing to control test behavior.

Learn how to use RavenDB.TestDriver to run integration tests against a real in-memory RavenDB instance instead of mocks, with full support for indexing, Studio debugging, and CI/CD pipelines.

Build a full-stack Next.js app backed by RavenDB using the Node.js client, server actions for mutations, and server components for data fetching.

Learn how to use the ravendb-test-driver package to run Python integration tests against a real in-memory RavenDB instance, replacing mocks with a database environment that mirrors production.

Use RavenDB as the backend cache for PhpFastCache: install the Composer packages, configure the driver, and inspect cached documents in the RavenDB Studio.

Automate RavenDB backup and restore from the Node.js client: define backup destinations, schedule periodic tasks, trigger backups manually, restore databases, and monitor your backup tasks.

Query RavenDB through GraphQL using Hot Chocolate as a standalone ASP.NET Core server, translating paging, filtering, sorting, and projections into native RavenDB queries.