Toggle navigation
RavenDB
back to ravendb.net
/
Version 4.0
Version 3.5
Version 3.0
Version 2.5
Version 2.0
Version 1.0
Search instead for
Start
Getting started
Getting Started
What's New
Playground Server
About Examples
Unit Tests
Installation
Setup Wizard
Setup Examples
AWS Windows VM
AWS Linux VM
Docker on AWS EC2 Linux VM
Docker on AWS ECS
Azure Windows VM
Azure Linux VM
Manual Setup
Deployment Considerations
Running as a Service
Running in a Docker Container
Upgrading to a New Version
System Requirements
System Configuration Recommendations
Client API
What is a Document Store
Creating Document Store
Setting up Authentication and Authorization
Setting up Default Database
What is a Public API
.NET Client Versions
Session
What is a Session and How Does it Work
Opening a Session
Storing Entities
Deleting Entities
Loading Entities
Saving changes
Querying
DocumentQuery
What is a Document Query
How to Use NOT Operator
How to Use Lucene
How to Query
How to Stream Query Results
How to Customize Query
How to Project Query Results
How to Perform Group By Query
How to Perform a Faceted Search
How to Query a Spatial Index
How to Get Query Statistics
How to Use Intersect
How to Perform Queries Lazily
How to Work With Suggestions
How to Use MoreLikeThis
How to Use Search
How to Use Regex
How to Query With Exact Match
Configuration
How to Customize ID Generation for Entities
How to Customize Collection Assignment for Entities
How to Customize Identity Property Lookup For Entities
How to Change Maximum Number of Requests per Session
How to Enable Optimistic Concurrency
Attachments
What are Attachments
Storing
Loading
Deleting
Revisions
What are Revisions
Loading
How to...
...clear a session
...evict entity from a session
...refresh entity
...defer operations
...perform operations lazily
...subscribe to events
...get entity id
...get and modify entity metadata
...get entity change vector
...get entity last modified
...get current session node
...check if entity has changed
...check if there are any changes on a session
...check if document exists
...ignore entity changes
Operations
What are Operations
Delete By Query
Attachments
Get Attachment
Put Attachment
Delete Attachment
Patching
Single Document
Set Based
Compare Exchange
Overview
Put Compare Exchange Value
Get Compare Exchange Value
Get Compare Exchange Values
Delete Compare Exchange Value
Maintenance
Get Collection Statistics
Get Statistics
Configuration
Put Client Configuration
Get Client Configuration
Identities
Get Identities
Indexes
Delete Index
Disable Index
Enable Index
Reset Index
Set Index Lock
Set Index Priority
Start Index
Start Indexing
Stop Index
Stop Indexing
Get Index Errors
Get Index Names
Get Index
Get Indexes
Get Terms
Index Has Changed
Put Indexes
ETL
Reset ETL
Server-Wide
Add Database Node
Compact Database
Create Database
Delete Databases
Get Build Number
Get Database Names
Modify Conflict Solver
Promote Database Node
Restore Backup
Toggle Databases State
Certificates
Create Client Certificate
Get Certificate
Get Certificates
Delete Certificate
Put Client Certificate
Configuration
Get Server Wide Client Configuration
Put Server Wide Client Configuration
How to...
...switch operations to a different database
Bulk Insert
How to Work With Bulk Insert Operation
Data Subscriptions
What are Data Subscriptions
Creation
How to Create a Data Subscription
Examples
API Overview
Consumption
How to Consume a Data Subscription
Examples
API Overview
Advanced topics
Revisions Support
Maintenance Operations
Changes API
What is Changes API
How to Subscribe to Document Changes
How to Subscribe to Index Changes
How to Subscribe to Operation Changes
Commands
Documents
Get
Put
Delete
How to...
...get document metadata only
Batches
How to Send Multiple Commands Using a Batch
Document Identifiers
Working with Document Identifiers
HiLo Algorithm
Configuration
Conventions
Querying
Serialization
Cluster
Identifier generation
Global
Type-specific
Smuggler
What is Smuggler
Cluster Related
How Client Integrates With Replication and Cluster
Document Conflict Exceptions at Client-Side
Client Speed Test
Cluster Node Health Check
How to...
...setup aggressive caching
...store dates
...handle document relationships
...use low-level commands
...integrate with Excel
FAQ
What is a Collection
Transaction Support
Backward Compatibility
Indexes
Querying
What is RQL
Basics
Filtering
Paging
Sorting
Boosting
Projections
Distinct
Searching
Intersection
Suggestions
Spatial
Faceted search
MoreLikeThis
Query vs DocumentQuery
What are Indexes
Creating and Deploying Indexes
Indexing Basics
Map Indexes
Multi-Map Indexes
Map-Reduce Indexes
Stale Indexes
Fanout Indexes
Sorting & Collation
Indexing Related Documents
Indexing Hierarchical Data
Indexing Polymorphic Data
Indexing Spatial Data
Indexing LINQ Extensions
Converting to JSON and Accessing Metadata
Boosting
Analyzers
Storing Data in Index
Term Vectors
Dynamic Fields
Extending Indexes
Troubleshooting
Debugging Index Errors
Server
Administration
SNMP
What is SNMP
Zabbix
CLI (Command Line Interface)
Statistics
Index Administration
Clustering
Clustering Overview
Rachis
What Is Rachis
Cluster Topology
Consensus Operations
Replication
How Replication Works
Replication Conflicts
Change Vector
Distribution
Distributed Database
Database Tasks
Cluster Observer
Best Practice and Configuration
Troubleshooting
Configuration
Configuration Options
Command Line Arguments
Backup Options
Cluster Configuration
Core Configuration
Database Configuration
ETL Configuration
HTTP Configuration
Indexing Configuration
License Configuration
Logs Configuration
Memory Configuration
Monitoring Configuration
Patching Configuration
Performance Hints Configuration
Query Configuration
Replication Configuration
Security Configuration
Server Configuration
Storage Configuration
Studio Configuration
Subscription Configuration
Testing Configuration
Tombstone Configuration
Transaction Merger Configuration
Extensions
Expiration
Revisions
Security
Overview
Authentication
Manual Certificate Configuration
Certificate Management
Client Certificate Usage
Certificate Renewal & Rotation
Let's Encrypt Certificates
Authorization
Security Clearance and Permissions
Encryption
Encryption at Rest
Database Encryption
Server Store Encryption
Secret Key Management
Common Errors & FAQ
Storage
Storage Engine
Directory Structure
Transaction Mode
Ongoing Tasks
ETL
ETL Basics
RavenDB ETL
SQL ETL
External Replication
Troubleshooting
Sending support ticket
Logging
Voron Recovery Tool
Knowledge Base
Document identifier generation
JavaScript Engine
Numbers in RavenDB
Studio
Overview
Server Management
Server Dashboard
Client Configuration
Databases
List View
Create New Database
General Flow
Encrypted
From Backup
From Legacy Files
Cluster
Cluster View
Add Node to Cluster
Cluster Observer
Database Management
Documents
Documents and Collections
Create New Document
Document View
Conflicts View
Settings
Database Record
Conflict Resolution
Document Expiraton
Manage Database Group
Tasks
Ongoing Tasks
General Info
External Replication Task
RavenDB ETL Task
Backup Task
Create Sample Data
Migration
Client API
Introduction
Document Store
Conventions
Patching
Commands
Indexes
Changes API
List of Differences in Public API
Session
Basics
Advanced
Querying
Basics
Transformers
Spatial
Facets and Dynamic Aggregation
Suggestions
MoreLikeThis
DocumentQuery
Server
Data migration
Configuration options
Indexes
Bundles
Triggers
Authentication
SNMP
Glossary
BlittableJsonReaderObject
Node Tag
Database Id
Etag
Tombstone
Raft Consensus Algorithm
Raft Command
Replication Factor
Cluster Node
RavenDB Cluster
Database Group
DeleteCommandData
IndexQuery
QueryResult
StreamQueryStatistics
StreamResult
PatchCommandData
PutCommandData
Users Issues
Azure Router Timeout
TCP Offloading
Recovering from Voron errors
Understanding eventual consistency
Unfortunately this article does not exist.