RavenDB Documentation

A fully transactional ACID document database built for high performance and ease of use.

This documentation is your complete guide, from basics like installation, the client API, querying, and indexes to advanced topics like clustering, security, and administration, as well as modern & flexible RavenDB AI features.

Start with the starting points, explore features below, or dive into the guides section for how-tos and real-world use cases.

Starting points

Developer

Learn how to create a client, connect to the server, handle documents and more

DevOps

Learn how to install RavenDB, set up a cluster, maintain the database and more

Use cases

See more

Survive the AI tidal wave with RavenDB & GenAI

Learn how to harness the power of Generative AI by pairing it with a high-performance document database.

Processing invoices using Data Subscriptions in RavenDB

Learn how to process invoices in asynchronous manner using the data subscriptions feature

Browse by feature

AI

AI agents

Database-native agents that query & act safely

Vector search

Find contextually relevant data

GenAI tasks

Empower your application using intelligent tasks

Embeddings generation

Automatically turn your data into AI-ready vectors

Indexes

Static indexes

Complete control over precomputing & performance

Auto indexes

Self‑optimizing database with zero manual effort

Querying

Raven Query Language

Simple yet powerful SQL-style queries

Full-text search

Cutting‑edge integrated search engine

Patching

Transform documents at scale with a script

Facets

Slice and navigate through a large dataset

MoreLikeThis

Get similar documents based on content

Spatial

Search and sort by geographic location effortlessly

Document extensions

Revisions

Capture, track, and rewind any change

Time series

Store, query and aggregate timestamped data natively

Attachments

Attach binary files directly to documents - scalable, searchable

Documents compression

Automatically compress document content for storage savings

Counters

Simple, scalable, and conflict-free numeric counters

Remote Attachments

Offload large binaries to S3 or Azure Blob — zero code changes

JSON Schema Validation

Structural data guarantees using JSON Schema — flexible enforcement levels

Background tasks

Expiration

Automatically scheduled documents cleanup

Refresh

Automatically re-trigger your documents

Archival

Retain old documents access while boosting performance

Clusters

Sharding

Partition dozens of terabytes across nodes for extreme scale

Cluster-wide tasks

Cluster-wide, auto‑failover tasks (backup, ETL, subscriptions)

Cluster-wide transactions

Partition-tolerant ACID writes across a cluster

Ongoing tasks

Replication

Keeps your clusters in sync for high availability

Subscriptions

Subscribe to defined documents, trigger your worker routines on field updates

Periodic backups

Scheduled full & incremental backups

Security

Certificates

Secure your server with X.509 certificates and fine-grained access control

Encryption

Transparent at-rest & in-transit, data security without code changes

Audit Log

Record who connected and what they did - built-in audit trail.

Monitoring

Cluster dashboard

Customizable live view of your cluster's health and performance

SNMP monitoring

Easily expose RavenDB metrics to Zabbix/Datadog/PTRG

Telegraf and Grafana

Effortlessly push RavenDB metrics into your dashboards via plugin

Administration

Studio

State-of-the-art admin interface bundled in every RavenDB license

RavenCLI

Simple yet powerful shell tool for server admin

NLog

Seamless NLog integration to route RavenDB logs anywhere

Integration

RavenDB ETL

Move and transform data between RavenDB databases

OLAP ETL

Export data as ApacheParquet to your data lake for analytics

Elasticsearch ETL

Stream RavenDB data into Elasticsearch indices

SQL ETL

Send documents to SQL databases with schema transformation

Kafka ETL

Publish documents into Kafka topics for real-time event pipelines

RabbitMQ ETL

Send transformed RavenDB data directly to RabbitMQ exchanges

Snowflake ETL

Load and transform data directly into Snowflake for analytics

Amazon SQS ETL

Send CloudEvents messages to Amazon SQS

Azure Queue Storage ETL

Send CloudEvents messages to Azure Queue Storage

RabbitMQ Sink

Ingest messages from RabbitMQ directly into RavenDB documents

Kafka Sink

Receive data into RavenDB from Kafka streams as source event

PowerBI

Connect RavenDB to Power BI for live business intelligence reporting

Akka.NET

Use RavenDB as Akka.Persistence storage