Package com.azure.data.cosmos

Class ConflictResolutionPolicy

  • public class ConflictResolutionPolicy
extends JsonSerializable
    Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on documents in the collection in the Azure Cosmos DB service. A collection with custom conflict resolution with no user-registered stored procedure. 
    
 DocumentCollection collectionSpec = new DocumentCollection();
 collectionSpec.id("Multi-master collection");

 ConflictResolutionPolicy policy = ConflictResolutionPolicy.createCustomPolicy();
 collectionSpec.conflictResolutionPolicy(policy);

 DocumentCollection collection = client.createCollection(databaseLink, collectionSpec, null)
         .toBlocking().single().getResource();
    A collection with custom conflict resolution with a user-registered stored procedure. 
    
 DocumentCollection collectionSpec = new DocumentCollection();
 collectionSpec.id("Multi-master collection");

 ConflictResolutionPolicy policy = ConflictResolutionPolicy.createCustomPolicy(conflictResolutionSprocName);
 collectionSpec.conflictResolutionPolicy(policy);

 DocumentCollection collection = client.createCollection(databaseLink, collectionSpec, null)
         .toBlocking().single().getResource();
    A collection with last writer wins conflict resolution, based on a path in the conflicting documents. A collection with custom conflict resolution with a user-registered stored procedure. 
    
 DocumentCollection collectionSpec = new DocumentCollection();
 collectionSpec.id("Multi-master collection");

 ConflictResolutionPolicy policy = ConflictResolutionPolicy.createLastWriterWinsPolicy("/path/for/conflict/resolution");
 collectionSpec.conflictResolutionPolicy(policy);

 DocumentCollection collection = client.createCollection(databaseLink, collectionSpec, null)
         .toBlocking().single().getResource();

    • Constructor Detail

      • ConflictResolutionPolicy

        public ConflictResolutionPolicy​(String jsonString)

    • Method Detail

      • createLastWriterWinsPolicy

        public static ConflictResolutionPolicy createLastWriterWinsPolicy()
        Creates a LAST_WRITER_WINS ConflictResolutionPolicy with "/_ts" as the resolution path. In case of a conflict occurring on a document, the document with the higher integer value in the default path Resource.timestamp(), i.e., "/_ts" will be used.
        Returns:
        ConflictResolutionPolicy.

      • createLastWriterWinsPolicy

        public static ConflictResolutionPolicy createLastWriterWinsPolicy​(String conflictResolutionPath)
        Creates a LAST_WRITER_WINS ConflictResolutionPolicy with path as the resolution path. The specified path must be present in each document and must be an integer value. In case of a conflict occurring on a document, the document with the higher integer value in the specified path will be picked.
        Parameters:
        conflictResolutionPath - The path to check values for last-writer wins conflict resolution. That path is a rooted path of the property in the document, such as "/name/first".
        Returns:
        ConflictResolutionPolicy.

      • createCustomPolicy

        public static ConflictResolutionPolicy createCustomPolicy​(String conflictResolutionSprocName)
        Creates a CUSTOM ConflictResolutionPolicy which uses the specified stored procedure to perform conflict resolution This stored procedure may be created after the DocumentCollection is created and can be changed as required.
        • In case the stored procedure fails or throws an exception, the conflict resolution will default to registering conflicts in the conflicts feed
        • The user can provide the stored procedure @see Resource.id()
        Parameters:
        conflictResolutionSprocName - stored procedure to perform conflict resolution.
        Returns:
        ConflictResolutionPolicy.

      • createCustomPolicy

        public static ConflictResolutionPolicy createCustomPolicy()
        Creates a CUSTOM ConflictResolutionPolicy without any StoredProcedure. User manually should resolve conflicts. The conflicts will be registered in the conflicts feed and the user should manually resolve them.
        Returns:
        ConflictResolutionPolicy.

      • conflictResolutionPath

        public String conflictResolutionPath()
        Gets the path which is present in each document in the Azure Cosmos DB service for last writer wins conflict-resolution. This path must be present in each document and must be an integer value. In case of a conflict occurring on a document, the document with the higher integer value in the specified path will be picked. If the path is unspecified, by default the Resource.timestamp() path will be used. This value should only be set when using ConflictResolutionMode.LAST_WRITER_WINS
        Returns:
        The path to check values for last-writer wins conflict resolution. That path is a rooted path of the property in the document, such as "/name/first".

      • conflictResolutionProcedure

        public String conflictResolutionProcedure()
        Gets the StoredProcedure which is used for conflict resolution in the Azure Cosmos DB service. This stored procedure may be created after the DocumentCollection is created and can be changed as required.
        • This value should only be set when using ConflictResolutionMode.CUSTOM
        • In case the stored procedure fails or throws an exception, the conflict resolution will default to registering conflicts in the conflicts feed
        • The user can provide the stored procedure @see Resource.id()
        Returns:
        the stored procedure to perform conflict resolution.]