/ Version 3.0 CURRENT Version 4.2 Version 4.1 Version 3.5 LEGACY Version 4.0 Version 3.0 Version 2.5 Version 2.0 Version 1.0 Search instead for LANGUAGE General C# Java HTTP Start Getting Started Getting started What's new Playground Server About examples Indexes Querying Basics Filtering Paging Sorting Handling document relationships Projections Searching Intersection Suggestions Highlights Spatial Faceted search Dynamic aggregation Query vs DocumentQuery Full query syntax What are indexes? Creating and deploying indexes Indexing basics Map indexes Multi-Map indexes Map-Reduce indexes Stale indexes Fanout indexes Customizing results order 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 Testing indexes Side-by-Side indexes Troubleshooting Debugging index errors Transformers What are transformers? Creating and deploying transformers Basic transformations Loading documents Including documents Passing parameters Nesting transformers Transforming hierarchical data Converting to JSON and accessing Metadata Dealing with subcollections Client API What is a document store? Creating document store Setting up default database Setting up connection string What is a public API? Commands What are commands? Documents Put Get Delete Stream How to... ...get document metadata only ...delete/update documents using index Indexes Put Get Delete How to... ...reset index ...get index terms ...get index merge suggestions ...check if index has changed ...change index lock mode ...change index priority Attachments Put Get Delete How to... ...get attachment metadata only ...update attachment metadata only Querying How to query a database? How to stream query results? How to work with Facet query? How to work with Suggestion query? How to work with MoreLikeThis query? Transformers Put Get Delete How to... ...transform query results ...change transformer lock mode Batches How to send multiple commands using a batch? Patches How to work with patch requests How to use JavaScript to patch your documents How to... ...switch commands to a different database ...switch commands credentials ...disable caching ...start or stop indexing and get indexing status ...start or stop reducing ...create or delete database ...compact database ...get database and server statistics ...get database configuration ...start backup or restore operations ...get full url for a document ...get server build number ...get names of all databases on a server Session What is a session and how does it work? Opening a session Storing entities Deleting entities Loading entities Saving changes Querying Lucene How to use Lucene in queries? How to use NOT operator? How to query? How to stream query results? How to customize query? How to use transformers in queries? How to perform a faceted search? How to perform a multifaceted search? How to query a spatial index? How to perform dynamic aggregation? How to get query statistics? How to perform projection? How to use intersect? How to perform queries lazily? How to work with suggestions? How to use search? How to use highlighting? Transaction support Standard transactions DTC transactions Configuration How to change maximum number of requests per session? How to customize key generation for entities? How to customize collection assignment for entities? How to customize identity property lookup for entities? How to enable optimistic concurrency? How to... ...defer operations ...perform operations lazily ...clear a session ...evict entity from a session ...refresh entity ...get entity id ...get entity metadata ...get entity etag ...get entity url ...check if entity has changed ...check if there are any changes on a session ...mark entity as readonly ...use MoreLikeThis? Document identifiers Working with document ids HiLo algorithm Beware of ... Handling case sensitive document IDs Bulk Insert How to work with bulk insert operation? Changes API What is Changes API? How to subscribe to document changes? How to subscribe to index changes? How to subscribe to bulk insert operation changes? How to subscribe to transformer changes? How to subscribe to replication conflicts? How to subscribe to data subscription changes? Listeners What are listeners? Store listeners Delete listeners Conversion listeners Conflict listeners Query listeners Data Subscriptions What are data subscriptions? How to create a data subscription? How to open a data subscription? How to delete a data subscription? How to release a data subscription? How to get all subscriptions? Events Bundles How client integrates with replication bundle? How to work with authorization bundle? How to work with unique constraints bundle? Concurrency Revisions and concurrency with ETags Using optimistic concurrency in real world scenarios Configuration Conventions What are conventions? Identifier generation Global Type-specific Querying Caching Replication Request handling Misc How to... ...work with authentication ...setup aggressive caching ...send custom request ...integrate with Excel ...enable profiling ...store dates ...create a custom message handler FAQ What is a collection? Transaction support Backward compatibility Server Installation System requirements Windows Service IIS application Deployment considerations Embedded Using installer Upgrading to a new version Configuration Windows Clustering Windows Server 2008 Windows Server 2012 Enabling SSL Enabling FIPS compliant encryption Authentication & Authorization License registration Configuration options Storage Engines Administration Administration 101 Multiple databases Statistics Backup & Restore Exporting & Importing data Differences between backup and export Migrating attachments into RavenFS Index administration Monitoring Pandora FMS Request Tracking Scaling out Replication How replication works? Replication conflicts Replication and Embedded instance Write assurance Sharding How to setup sharding? Sharding Ops Replication with Sharding Bundles Authorization Cascade Delete Compression Encryption Expiration More Like This Periodic Export Quotas Replication Scripted Index Results SQL Replication Basics PostgreSQL Unique Constraints Versioning Plugins What are plugins? Triggers Codecs Tasks Compilation Extensions Analyzer Generators Database Configuration Troubleshooting Debug endpoints Enabling logging Running in debug mode Sending support ticket Knowledge Base Document key generation Bundles : Authorization bundle design notes Replication : Advanced replication details Server : Long shutdown times Studio Accessing Studio Overview Documents Documents View Document Edit View Patch View Conflicts View Indexes Indexes View Index Edit View Transformers View Transformer Edit View Query Query View Reporting View Tasks Import & Export Database Toggle Indexing Create Sample Data CSV Import Settings Database Settings Quotas Replication SQL Replication Versioning Periodic Export Custom Functions Status Stats Indexing Indexing performance Index stats Index batch size and Prefetches Request Tracking Logs Running Tasks Alerts Index Errors Replication Stats Sql Replication Stats User Info Map-Reduce Visualizer Debug Overview Explain replication Storage Gather Debug Info Management API Keys Windows Authentication Backup & Restore Compact Admin Logs Traffic Watch License information Gather Debug Info IO Test Studio Config Walkthroughs How to setup replication? How to setup encryption? How to setup compression? Samples MVC Starter Kit Glossary AdminStatistics AttachmentInformation Attachment BatchResult BulkOperationOptions BulkInsertChangeNotification BulkInsertOperation BulkInsertOptions ChunkedBulkOperationOptions ConfigurationChangeNotification ConfigurationSearchResults ConflictItem ConflictNotification DataSubscriptionChangeNotification DatabaseDocument DatabaseRestoreRequest DatabaseStatistics DeleteCommandData DocumentChangeNotification DynamicAggregationQuery Facet FacetQuery FacetResults FacetSetup FieldHighlightings FileChangeNotification FileHeader FileSystemBackupRequest FileSystemDocument FileSystemRestoreRequest IndexChangeNotification IndexDefinition IndexMergeResults IndexQuery IndexToAdd JsonDocumentMetadata JsonDocument MoreLikeThisQuery MultiLoadResult OpenSessionOptions Operation PatchCommandData PutCommandData QueryHeaderInformation QueryResult RavenQueryStatistics ReplicationConflictNotification ReplicationDestination ScriptedPatchCommandData SearchResults SpatialCriteriaFactory SpatialRelation StreamResult SuggestionQuery SuggestionQueryResult SynchronizationDestination SynchronizationDetails SynchronizationReport SynchronizationUpdateNotification TransformerChangeNotification TransformerDefinition File System What is RavenFS? Files Configurations Indexing Client API What is a files store? Creating a files store Commands What are commands? Files Upload Download Rename Delete Metadata GetMetadata UpdateMetadata Browse Browse Get StartsWith StreamFileHeaders GetDirectories Search Search SearchOnDirectory GetSearchFields Configurations SetKey GetKey DeleteKey GetKeyNames Search Synchronization Start Destinations GetDestinations SetDestinations Monitoring GetSynchronizationStatusFor GetFinished GetActive GetPending Conflicts GetConflicts ResolveConflict Storage CleanUp RetryRenaming Admin Manage file systems Backup and restore Compaction Index reset Statistics Session What is a file session? Opening a session Loading files Uploading files Downloading files Renaming files Deleting files Changing metadata Saving changes Querying Basics Filtering Sorting Paging Configuration How to change maximum number of requests per session? How to enable optimistic concurrency? Changes API How to subscribe to file changes? How to subscribe to synchronization notifications? How to subscribe to synchronization conflicts? How to subscribe to configuration changes? Listeners What are listeners? Delete listeners Metadata change listeners Conflict listeners Sharding Synchronization How synchronization works? Synchronization types Conflicts Configurations Server Enabling Remote Differential Compression Background tasks Exporting and importing files Bundles Encryption Versioning Studio Files Files view File edit view Search view Synchronization Conflicts view Destinations view Configuration view Tasks Export and import Configurations view How to ... How to setup encryption? How to setup versioning? Users Issues Azure Router Timeout TCP Offloading Recovering from Esent errors Understanding eventual consistency You are currently browsing legacy 3.0 version of documentation. Click here to switch to the newest 4.2 version. We can help you with migration to the latest RavenDB Contact Us Now 3.0 Toggle Dropdown 4.2 4.1 4.0 3.5 see on GitHub Glossary: PutCommandData Properties Name Type Description Key string Document key Method string The HTTP method (PUT) Etag Etag Document etag (used for concurrency checking) Document RavenJObject Document to put TransactionInformation TransactionInformation Transactional information Metadata RavenJObject Document metadata AdditionalData RavenJObject Additional metadata Methods Signature Description RavenJObject ToJson() Translate this instance to a Json object. Please enable JavaScript to view the comments powered by Disqus.