Patching: How to Perform Set Based Operations on Documents

Sending a Patch Request

Operation Send(PatchByQueryOperation operation);

PatchByQueryOperation

public PatchByQueryOperation(string queryToUpdate)

public PatchByQueryOperation(IndexQuery queryToUpdate, QueryOperationOptions options = null)

Update whole collection

// increase by 10 Freight field in all orders
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(@"from Orders as o
                                      update
                                      {
                                          o.Freight +=10;
                                      }"));
// Wait for the operation to be complete on the server side.
// Not waiting for completion will not harm the patch process and it will continue running to completion.
operation.WaitForCompletion();

Update by dynamic query

// set discount to all orders that was processed by a specific employee
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(@"from Orders as o
                                      where o.Employee = 'employees/4-A'
                                      update
                                      {
                                          o.Lines.forEach(line=> line.Discount = 0.3);
                                      }"));
operation.WaitForCompletion();

Update by static index query result

// switch all products with supplier 'suppliers/12-A' with 'suppliers/13-A'
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from index 'Product/Search' as p
                  where p.Supplier = 'suppliers/12-A'
                  update
                  {
                      p.Supplier = 'suppliers/13-A'
                  }"
    }));

operation.WaitForCompletion();

Updating a collection name

// delete the document before recreating it with a different collection name
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from Orders as c
                  update
                  {
                      del(id(c));
                      this[""@metadata""][""@collection""] = ""New_Orders"";
                      put(id(c), this);
                  }"
    }));

operation.WaitForCompletion();

Updating by document ID

// perform a patch by document ID
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from @all_docs as d
                  where id() in ('orders/1-A', 'companies/1-A')
                  update
                  {
                      d.Updated = true;
                  }"
    }));

operation.WaitForCompletion();

Updating by document ID using parameters

// perform a patch by document ID
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        QueryParameters = new Parameters
        {
            {"ids", new[] {"orders/1-A", "companies/1-A"}}
        },
        Query = @"from @all_docs as d
                  where id() in ($ids)
                  update
                  {
                      d.Updated = true;
                  }"
    }));

operation.WaitForCompletion();

Updating all documents

// perform a patch on all documents using @all_docs keyword
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from @all_docs
                  update
                  {
                      this.Updated = true;
                  }"
    }));

operation.WaitForCompletion();

Patch on stale results

// patch on stale results
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from Orders as o
                  where o.Company = 'companies/12-A'
                  update
                  {
                      o.Company = 'companies/13-A'
                  }"
    },
    new QueryOperationOptions
    {
        AllowStale = true
    }));

operation.WaitForCompletion();

Report progress on patch

// report progress during patch processing
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from Orders as o
                  where o.Company = 'companies/12-A'
                  update
                  {
                      o.Company = 'companies/13-A'
                  }"
    },
    new QueryOperationOptions
    {
        AllowStale = true
    }));

operation.OnProgressChanged = x =>
{
    DeterminateProgress progress = (DeterminateProgress)x;
    Console.WriteLine($"Progress: Processed: {progress.Processed}; Total: {progress.Total}");
};

operation.WaitForCompletion();

Process patch results details

// perform patch and create summary of processing statuses
var operation = store
    .Operations
    .Send(new PatchByQueryOperation(new IndexQuery
    {
        Query = @"from Orders as o
                  where o.Company = 'companies/12-A'
                  update
                  {
                      o.Company = 'companies/13-A'
                  }"
    },
    new QueryOperationOptions
    {
        RetrieveDetails = true
    }));

var result = operation.WaitForCompletion<BulkOperationResult>();
var formattedResults =
    result.Details
    .Select(x => (BulkOperationResult.PatchDetails)x)
    .GroupBy(x => x.Status)
    .Select(x => $"{x.Key}: {x.Count()}").ToList();

formattedResults.ForEach(Console.WriteLine);