See on GitHub

    How to Enable Optimistic Concurrency

    • By default, optimistic concurrency checks are disabled. Changes made outside of the session object will be overwritten. Concurrent changes to the same document will use the Last Write Wins strategy so a lost update anomaly is possible with the default configuration of the session.

    • Optimistic concurrency can be enabled for:

      • A specific document
      • A specific session (enable on a per-session basis)
      • All sessions (enable globally, at the document store level)

    • With optimistic concurrency enabled, RavenDB will generate a concurrency exception (and abort all modifications in the current transaction) when trying to save a document that has been modified on the server side after the client loaded and modified it.

    • The ConcurrencyException that might be thrown upon the saveChanges call needs to be handled by the caller. The operation can be retried (the document needs to be reloaded since it got changed meanwhile) or handle the error in a way that is suitable in a given scenario.

    • In this page:

    • Note that the UseOptimisticConcurrency setting only applies to documents that have been modified by the current session. E.g., if you load documents users/1-A and users/2-A in a session, make modifications only to users/1-A, and then call saveChanges, the operation will succeed regardless of the optimistic concurrency setting, even if users/2-A has been changed by another process in the meantime.

    • However, if you modify both documents and attempt to save changes with optimistic concurrency enabled, an exception will be raised if users/2-A has been modified externally.
      In this case, the updates to both users/1-A and users/2-A will be cancelled.

    A detailed description of transactions and concurrency control in RavenDB is available here: Transaction support in RavenDB

    Enable for specific session

    Enable optimistic concurrency for a session using the advanced session setUseOptimisticConcurrency method.

    $session = $store->openSession();
try {
    $session->advanced()->setUseOptimisticConcurrency(true);

    $product = new Product();
    $product->setName("Some Name");

    $session->store($product, "products/999");
    $session->saveChanges();

    $otherSession = $store->openSession();
    try {
        $otherProduct = $otherSession->load(Product::class, "products/999");
        $otherProduct->setName("Other Name");

        $otherSession->saveChanges();
    } finally {
        $otherSession->close();
    }

    $product->setName("Better Name");
    $session->saveChanges(); //  will throw ConcurrencyException
} finally {
    $session->close();
}

    • Enabling optimistic concurrency in a session will ensure that changes made to a document will only be persisted if the version of the document sent in the saveChanges call matches its version from the time it was initially read (loaded from the server).

    • Note that it's necessary to enable optimistic concurrency for ALL sessions that modify the documents for which you want to guarantee that no writes will be silently discarded.
      If optimistic concurrency is enabled in some sessions but not in others, and they modify the same documents, the risk of the lost update anomaly still exists.

    Enable globally

    • Optimistic concurrency can also be enabled for all sessions that are opened under a document store.

    • Use the store setUseOptimisticConcurrency method to enable globally.

    $store->getConventions()->setUseOptimisticConcurrency(true);

$session = $store->openSession();
try {
    $isSessionUsingOptimisticConcurrency = $session->advanced()->isUseOptimisticConcurrency(); // will return true
} finally {
    $session->close();
}

    Disable for specific document (when enabled on session)

    • Optimistic concurrency can be disabled when storing a specific document,
      even when it is enabled for an entire session (or globally).

    • This is done by passing None as a change vector value to the store method.

    $session = $store->openSession();
try {
    $product = new Product();
    $product->setName("Some Name");

    $session->store(product, "products/999");
    $session->saveChanges();
} finally {
    $session->close();
}

$session = $store->openSession();
try {
    $session->advanced()->setUseOptimisticConcurrency(true);

    $product = new Product();
    $product->setName("Some Other Name");

    $session->store(product, null, "products/999");
    $session->saveChanges(); // will NOT throw Concurrency exception
} finally {
    $session->close();
}

    Enable for specific document (when disabled on session)

    • Optimistic concurrency can be enabled when storing a specific document,
      even when it is disabled for an entire session (or globally).

    • This is done by passing an empty string as the change vector value to the store method.
      Setting the change vector to an empty string will cause RavenDB to ensure that this document is a new one and doesn't already exist.
      A ConcurrencyException will be thrown if the document already exists.

    • If you do not provide a change vector or if the change vector is None, optimistic concurrency will be disabled.

    • Setting optimistic concurrency for a specific document overrides the advanced session setUseOptimisticConcurrency operation. 

    $session = $store->openSession();
try {
    $product = new Product();
    $product->setName("Some Name");
    $session->store($product, "products/999");
    $session->saveChanges();
} finally {
    $session->close();
}

$session = $store->openSession();
try {
    $session->advanced()->setUseOptimisticConcurrency(false); // default value

    $product = new Product();
    $product->setName("Some Other Name");

    $session->store(product, "", "products/999");
    $session->saveChanges(); // will throw Concurrency exception
} finally {
    $session->close();
}

    related articlesRelated Articles

    Configuration

    FAQ

    Home / Docs / Client Api / Session / Configuration / How To Enable Optimistic Concurrency