Commands: Documents: How to delete or update documents using index?

To issue a batch-delete command you need to specify an index and a query to be sent to it. To minimize the chances of stale results coming back, bulk operations should only be performed on static indexes.

Syntax

Operation DeleteByIndex(
	string indexName,
	IndexQuery queryToDelete,
	BulkOperationOptions options = null);

Remarks

Example

// remove all documents from 'Employees' collection
Operation operation = store
	.DatabaseCommands
	.DeleteByIndex(
		"Raven/DocumentsByEntityName",
		new IndexQuery
		{
			Query = "Tag:Employees"
		},
		new BulkOperationOptions
		{
			AllowStale = false
		});

operation.WaitForCompletion();

Performing a mass-update is exactly the same as making a mass-delete, but this time it uses the Patching API to make it easy for us to define what to do with the documents matching our query.

Syntax

Operation UpdateByIndex(
	string indexName,
	IndexQuery queryToUpdate,
	PatchRequest[] patchRequests,
	BulkOperationOptions options = null);

Example

// Set property 'FirstName' for all documents in collection 'Employees' to 'Patched Name'
Operation operation = store
	.DatabaseCommands
	.UpdateByIndex(
		"Raven/DocumentsByEntityName",
		new IndexQuery
		{
			Query = "Tag:Employees"
		},
		new[]
		{
			new PatchRequest
			{
				Type = PatchCommandType.Set, 
				Name = "FirstName", 
				Value = "Patched Name"
			}
		},
		new BulkOperationOptions
		{
			AllowStale = false
		});

operation.WaitForCompletion();

Mass-update can also be executed with JavaScript patch.

Syntax

Operation UpdateByIndex(
	string indexName,
	IndexQuery queryToUpdate,
	ScriptedPatchRequest patch,
	BulkOperationOptions options = null);

Example

// Set property 'FirstName' for all documents in collection 'Employees' to 'Patched Name'
Operation operation = store
	.DatabaseCommands
	.UpdateByIndex(
		"Raven/DocumentsByEntityName",
		new IndexQuery
		{
			Query = "Tag:Employees"
		},
		new ScriptedPatchRequest
		{
			Script = @"this.FirstName = 'Patched Name';"
		},
		new BulkOperationOptions
		{
			AllowStale = false
		});

operation.WaitForCompletion();