Set-Based Patch Operations

Sending a Patch Request

Operation sendAsync(PatchByQueryOperation operation);

PatchByQueryOperation

public PatchByQueryOperation(String queryToUpdate)

public PatchByQueryOperation(IndexQuery queryToUpdate);

public PatchByQueryOperation(IndexQuery queryToUpdate, QueryOperationOptions options);

Update whole collection

// increase by 10 Freight field in all orders
Operation operation = store
    .operations()
    .sendAsync(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

Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation("from Orders as o" +
        " where o.Employee = 'employees/1-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'
Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(new IndexQuery("" +
        "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

Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(new IndexQuery(
        "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

Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(new IndexQuery(
        "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
IndexQuery indexQuery = new IndexQuery(
    "from @all_docs as d " +
        " where id() in ($ids)" +
        " update " +
        " {" +
        "    d.Updated = true; " +
        "} "
);
Parameters parameters = new Parameters();
parameters.put("ids", new String[]{"orders/1-A", "companies/1-A"});
indexQuery.setQueryParameters(parameters);
Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(indexQuery));

operation.waitForCompletion();

Updating all documents

// perform a patch on all documents using @all_docs keyword

Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(new IndexQuery(
        "from @all_docs " +
            " update " +
            "{ " +
            "  this.Updated = true;" +
            "}"
    )));

operation.waitForCompletion();

Patch on stale results

// patch on stale results

QueryOperationOptions options = new QueryOperationOptions();
options.setAllowStale(true);

Operation operation = store
    .operations()
    .sendAsync(new PatchByQueryOperation(new IndexQuery(
        "from Orders as o " +
            "where o.Company = 'companies/12-A' " +
            "update " +
            "{ " +
            "    o.Company = 'companies/13-A';" +
            "} "
    ), options));


operation.waitForCompletion();