Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Upgrade

      +

      On upgrading from a 3.x release, all Couchbase Lite databases automatically re-index on initial database open.
      This can result in a delay before the database is usable.

      4.0.0 Upgrade

      Couchbase Lite 4.0 introduces significant architectural changes, most notably the migration from revision trees to version vectors for document versioning. This upgrade requires understanding of the compatibility requirements.

      The action takes place automatically and can lead to some delay in the database becoming available for use in your application.

      In addition, if you’re syncing with a 4.0.0 Sync Gateway, you should be aware of the significant configuration enhancements introduced and their effects. See Upgrading Sync Gateway for more details. This is a one-way conversion.

      Major Changes in 4.0.0

      Version Vector Architecture: CBL 4.0.0 replaces the revision tree system with version vectors, providing improved performance, scalability, and conflict resolution. Documents now use version-based revision IDs in the format <timestamp>@<source-id> instead of the previous <generation>-<document-hash> format.

      Enhanced Conflict Resolution: The default conflict resolution strategy changes from most active wins to last write wins based on hybrid logical timestamps, providing more intuitive and predictable conflict resolution behavior.

      New Document Properties: a new Timestamp property is available on Document objects, providing direct access to the document’s logical timestamp as a ulong value representing nanoseconds since the Unix epoch.

      Database Compatibility

      Automatic Upgrade from 3.x: CBL 4.0.0 databases are compatible with CBL 3.1 and 3.2 databases. When opening a 3.1 or 3.2 database with CBL 4.0.0, documents are automatically upgraded to use version vectors when they’re updated and saved.

      No Configuration Required: CBL 4.0.0 enables version vectors by default - the feature requires no API configuration.

      Synchronization Compatibility

      Sync Gateway Requirements: CBL 4.0.0 requires Sync Gateway 4.x or later for synchronization. Attempting to sync with Sync Gateway versions prior to 4.x results in replication errors with appropriate error messages indicating the incompatibility.

      Peer-to-Peer Compatibility: CBL 4.0.0 can only perform peer-to-peer synchronization with other CBL 4.x instances using either URLEndpointListener or MessageEndpointListener. Sync attempts with CBL 3.x peers fail with appropriate error messages.

      Replication Compatibility

      CBL 4.0 introduces strict replication compatibility requirements due to the version vector architecture changes.

      Sync Gateway Compatibility: CBL 4.0 requires Sync Gateway 4.0 or later for synchronization. Attempting to sync with Sync Gateway versions prior to 4.0 results in replication errors with appropriate error messages indicating the incompatibility.

      Peer-to-Peer Compatibility: CBL 4.0 can only perform peer-to-peer synchronization with other CBL 4.0+ instances. Sync attempts with CBL 3.x or earlier peers fails with appropriate error messages.

      No Backward Compatibility: unlike previous CBL versions, CBL 4.0 cannot sync with earlier versions of either Sync Gateway or other CBL instances due to the fundamental changes in document versioning architecture.

      ReplicatorConfiguration

      Couchbase Lite 4.0 introduces changes to the ReplicatorConfiguration class to improve API consistency across all Couchbase Lite platforms. The API no longer supports legacy collection management methods.

      Removed APIs: * addCollection(s) / removeCollection(s) / getCollectionConfig() methods * ReplicatorConfiguration(Database, Endpoint) constructor that uses default collection

      Before (.NET 3.x)
      var collConfig = new CollectionConfiguration();
collConfig.Channels = new[] { "a", "b", "c" };

var replicatorConfig = new ReplicatorConfiguration(target: endpoint);
replicatorConfig.AddCollection(collectionA, collConfig);
      After (.NET 4.0.0)
      var collConfig = new CollectionConfiguration(collection: collectionA);
collConfig.Channels = new[] { "a", "b", "c" };

var replicatorConfig = new ReplicatorConfiguration(collections: new[] { collConfig }, target: endpoint);
      This change provides API consistency across all CBL platforms and simplifies the implementation by requiring collections and configurations at construction time.

      API Changes

      This content introduces the changes made to the Couchbase Lite for C#.Net API for release 4.0.0.

      Breaking Change

      The function ATAN2(x, y), which returns the principal value of the arc tangent of y/x, now becomes ATAN2(y, x); that’s, the arguments reverses in line with common notation.

      Removed

      Activate

      The method Activate() has been removed from all platform support libraries except Support.Android (Xamarin Android)

      EnableTextLogging()

      The obsolete method EnableTextLogging() is no longer supported in any platform support libraries.

      ResetCheckpoint

      The method ResetCheckpoint() has been removed. Use the reset: argument when starting the replicator instead.

      Before
      replicator.ResetCheckpoint();
replicator.Start();
      After
      replicator.Start(true) (1)
      1 Set the reset: argument true to initiate a replicator checkpoint reset
      SetLogLevel()

      We have removed the method Database.setLogLevel()
      Use Database.log.console instead:

      Before
      Database.SetLogLevel(LogDomain.Replicator, LogLevel.Verbose);
Database.SetLogLevel(LogDomain.Query, LogLevel.Verbose);
      After
      Database.Log.Console.Domains = LogDomain.All;
Database.Log.Console.LogLevel = LogLevel.Verbose;

      Database.Compact

      We have removed the method Database.compact().
      Use the method Database.PerformMaintenance() and the enum MaintenanceType instead

      Before
      var db = new Database("thisdb");
db.Compact()
      After
      var db = new Database("thisdb");

db.PerformMaintenance(MaintenanceType.Compact)

      Deprecated API

      Match

      We’re removing Match at the next major release.
      You should plan to switch to using the alternative FullTextFunction.match(indexName:) at the earliest opportunity.

      Before
      var whereClause =
        FullTextExpression.Index("nameFTSIndex").Match("'querystring'");
using (var query = QueryBuilder.Select(SelectResult.Expression(Meta.ID))
    .From(DataSource.Database(db))
    .Where(whereClause)) {
    foreach (var result in query.Execute()) {
        Console.WriteLine($"Document id {result.GetString(0)}");
    }
}
      After
      var whereClause =
      FullTextFunction.Match("nameFTSIndex"),"'querystring'"); (1)
using (var query =
    QueryBuilder.Select(SelectResult.Expression(Meta.ID))
      .From(DataSource.Database(db))
      .Where(whereClause)) {
      foreach (var result in query.Execute()) {
        Console.WriteLine($"Document id {result.GetString(0)}");
      }
  }
      1 Here we use FullTextFunction.match(indexName:) to build the query
      IsNullOrMissing

      We’re removing isNullOrMissing
      You should plan to switch to using the alternative IsNotValued()

      at the earliest opportunity.

      Before
      var query = QueryBuilder.Select(SelectResult.All())
    .From(DataSource.Database(db))
    .Where(Expression.Property("missingprop").IsNullOrMissing())
      After
      var query = QueryBuilder.Select(SelectResult.All())
    .From(DataSource.Database(db))
    .Where(Expression.Property("missingprop").IsNotValued())
      NotNullOrMissing

      We are removing notNullOrMissing.
      You should plan to switch to using the alternative isValued() at the earliest opportunity.

      | isNotValued()

      Before
      var query = QueryBuilder.Select(SelectResult.All())
    .From(DataSource.Database(db))
    .Where(Expression.Property("notmissingprop").NotNullOrMissing())
      After
      var query = QueryBuilder.Select(SelectResult.All())
    .From(DataSource.Database(db))
    .Where(Expression.Property("notmissingprop").IsValued())

      Visual Studio

      The public facing API has completely changed in Couchbase Lite 2.0 and will require a re-write to upgrade an application that is using Couchbase Lite 1.x. To update an Xcode project built with Couchbase Lite 1.x:

      • Remove the existing Couchbase Lite nuget package from the Visual Studio project.

      • Remove all the Couchbase Lite 1.x dependencies — see the 1.x installation guide.

      • Install the Couchbase Lite 2.0 framework in your project  — see Install. At this point, there will be many compiler warnings. See the examples on this page to learn about the new API.

      • Build & run your application.

      Downgrading Couchbase Lite

      Downgrading Between Major Releases

      No Downgrade Support - Couchbase Lite (CBL) does not support downgrades between major versions. Once you upgrade to a new major version, attempting to downgrade to a previous major version creates incompatibility issues. For example, upgrading from CBL 3.x.x to CBL 4.x.x does not allow you to revert to CBL 3.x.x.

      Downgrading Between Minor Releases

      Conditional Downgrade Support - Downgrade support for minor releases is considered on a case-by-case basis. The release notes for each minor version clarify whether downgrades receive support.

      For example, when a new minor version such as CBL 3.1.0 becomes available, the release notes specify whether reverting to CBL 3.0.x receives support.

      Downgrading Between Patch Releases

      Full Downgrade Support - Downgrades between patch releases are supported. Users can safely downgrade between different patch versions within the same minor release.

      For example, if you’re running CBL 3.1.6 you can downgrade to CBL 3.1.4 or CBL 3.1.3 without issues.

      Related Content

      How to

      .

      Learn more

      .

      Dive Deeper

      Mobile Forum | Blog | Tutorials

      .