A newer version of this documentation is available.

View Latest

Upgrade Couchbase Lite


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

      3.0.0 Upgrade

      This upgrade requires all 2.x databases be reindexed on initial open.

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

      In addition, if you are syncing with a 3.0.0 Sync Gateway, you should be aware of the significant configuration enhancements introduced and their impact. This is a one-way conversion.

      API Changes

      Removed APIs

      `[replicator startWithReset:];`
      [replicator resetCheckpoint];
      [replicator start];
      [replicator startWithReset: YES];


      [CBLDatabase setLogLevel:kCBLLogLevelVerbose domain: kCBLLogDomainAll];
      CBLDatabase.log.console.level = kCBLLogLevelVerbose;
      CBLDatabase.log.console.domains = kCBLLogDomainAll;

      [db performMaintenance:error:]

      [testdb compact: &error];
      [testdb performMaintenance:kCBLMaintenanceTypeCompact error:&error];

      Deprecated API


      [CBLQueryFullTextFunction matchWithIndexName: query:]

      CBLQueryFullTextExpression* index = [CBLQueryFullTextExpression indexWithName: @"indexName"];
      q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                              from: [CBLQueryDataSource database: self.database]
                              where: [index match: @"'queryString'"]];
          q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                                 from: [CBLQueryDataSource database: self.database]
                                where: [CBLQueryFullTextFunction matchWithIndexName: @"indexName"
                                                                              query: @"'queryString'"]];
      isNullOrMissing and notNullOrMissing
      [exp isValued];
      [exp isNotValued];
          q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                                 from: [CBLQueryDataSource database: self.database]
                                where: [[CBLQueryExpression property: @"missingProp"] isNullOrMissing]];
          q2 = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                                  from: [CBLQueryDataSource database: self.database]
                                 where: [[CBLQueryExpression property: @"notMissingProp"] notNullOrMissing]];
          q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                                 from: [CBLQueryDataSource database: self.database]
                                where: [[CBLQueryExpression property: @"missingProp"] isNotValued]];
          q2 = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryMeta id]]]
                                  from: [CBLQueryDataSource database: self.database]
                                 where: [[CBLQueryExpression property: @"notMissingProp"] isValued]];

      Updated API

      Breaking change

      ATAN2(x, y) now becomes ATAN2(y, x)

      q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryFunction atan2: p y: [CBLQueryExpression integer: 90]]]]
                                  from: [CBLQueryDataSource database: self.database]];
      q = [CBLQueryBuilder select: @[[CBLQuerySelectResult expression: [CBLQueryFunction atan2: [CBLQueryExpression integer: 90] x: p]]]
                                 from: [CBLQueryDataSource database: self.database]];

      1.x Databases Upgrades to 2.x

      Databases created using Couchbase Lite 1.2 or later can still be used with Couchbase Lite 2.x; but will be automatically updated to the current 2.x version. This feature is only available for the default storage type (i.e., not a ForestDB database).

      Encrypted Databases

      The automatic migration feature does not support encrypted databases. So if the 1.x database is encrypted you will first need to disable encryption using the Couchbase Lite 1.x API (see the 1.x Database Guide).

      Thus, to upgrade an encrypted 1.x database, you should do the following:

      Upgrading Encrypted Databases
      1. Disable encryption using the Couchbase Lite 1.x framework (see 1.x encryption guide)

      2. Open the database file with encryption enabled using the Couchbase Lite 2.x framework.

      Since it is not possible to package Couchbase Lite 1.x and Couchbase Lite 2.x in the same application this upgrade path would require two successive upgrades.

      If you are using Sync Gateway to synchronize the database content, it may be preferable to run a pull replication from a new 2.x database with encryption enabled and delete the 1.x local database.

      Handling of Existing Conflicts

      If there are existing conflicts in the 1.x database, the automatic upgrade process copies the default winning revision to the new database and does NOT copy any conflicting revisions.

      This functionality is related to the way conflicts are now being handled in Couchbase Lite — see Handling Data Conflicts.

      Optionally, existing conflicts in the 1.x database can be resolved with the 1.x API prior to the database being upgraded.

      Handling of Existing Attachments

      Attachments persisted in a 1.x database are copied to the new database. NOTE: The relevant Couchbase Lite API is now called the Blob API not the Attachments API.

      The functionally is identical but the internal schema for attachments has changed.

      Blobs are stored anywhere in the document, just like other value types. Whereas in 1.x they were stored under the _attachments field.

      The automatic upgrade functionality does not update the internal schema for attachments, so they remain accessible under the _attachments field. See Example 1 for how to retrieve an attachment that was created in a 1.x database with a 2.x API.

      Example 1. Retrieve 1.x Attachment
      CBLDictionary *attachments = [document dictionaryForKey:@"_attachments"];
      CBLBlob *avatar = [attachments blobForKey:@"avatar"];
      NSData *content = [avatar content];

      Replication Compatibility

      The current replication protocol is not backwards compatible with the 1.x replication protocol. Therefore, to use replication with Couchbase Lite 2.x, the target Sync Gateway instance must also be upgraded to 2.x.

      Sync Gateway 2.x will continue to accept clients that connect through the 1.x protocol. It will automatically use the 1.x replication protocol when a Couchbase Lite 1.x client connects through http://localhost:4984/db and the 2.0 replication protocol when a Couchbase Lite 2.0 client connects through ws://localhost:4984/db. This allows for a smoother transition to get all your user base onto a version of your application built with Couchbase Lite 2.x.


      The API has changed in Couchbase Lite 2.0 and will require porting an application that is using Couchbase Lite 1.x API to the Couchbase Lite 2.0 API. To update an Xcode project built with Couchbase Lite 1.x:

      • Remove the existing CouchbaseLite.framework dependency from the Xcode 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. Refer to the examples on this page to learn about the new API.

      • Build & run your application.