CBL-5711 : Add note that replicators cannot be started in a transaction

Added note that replicators cannot be started in a transaction.
couchbase · Jun 3, 2024 · b74c491 · b74c491
1 parent 475e06c
commit b74c491
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/include/cbl++/Replicator.hh b/include/cbl++/Replicator.hh
@@ -403,6 +403,7 @@ namespace cbl {
         }
 
         /** Starts a replicator, asynchronously. Does nothing if it's already started.
+            @note Replicators cannot be started from within a database's transaction.
             @param resetCheckpoint  If true, the persistent saved state ("checkpoint") for this replication
                                    will be discarded, causing it to re-scan all documents. This significantly
                                    increases time and bandwidth (redundant docs are not transferred, but their

diff --git a/include/cbl/CBLReplicator.h b/include/cbl/CBLReplicator.h
@@ -462,6 +462,7 @@ CBLReplicator* _cbl_nullable CBLReplicator_Create(const CBLReplicatorConfigurati
 const CBLReplicatorConfiguration* CBLReplicator_Config(CBLReplicator*) CBLAPI;
 
 /** Starts a replicator, asynchronously. Does nothing if it's already started.
+    @note Replicators cannot be started from within a database's transaction.
     @param replicator  The replicator instance.
     @param resetCheckpoint  If true, the persistent saved state ("checkpoint") for this replication
                         will be discarded, causing it to re-scan all documents. This significantly