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. Refer to the examples on this page to learn about the new API.
Build & run your application.
Databases that were created with Couchbase Lite 1.2 or later can be used with Couchbase Lite 2.0. Upon detecting it is a 1.x database file, Couchbase Lite will automatically upgrade it to 2.0. This feature is only available for the default storage type (i.e., not a ForestDB database). Additionally, 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).
For conflicts in the 1.x database, the automatic upgrade process copies the default winning revision to the new 2.0 database and does NOT copy any conflicting revisions. This functionality is related to the way conflicts are being handled in Couchbase Lite 2.0 — 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 to 2.0.
Attachments that were persisted in the 1.x database will be copied to the 2.0 database.
In Couchbase Lite 2.0, the
Attachment API has been renamed to
The functionally is identical but the internal schema for attachments has changed.
In 1.x they were stored under the
_attachments field and in Couchbase Lite 2.0 they are stored anywhere in the document like other value types.
The automatic upgrade functionality will not update the internal schema for attachments, so they will still be accessible under the
The following example shows how to retrieve an attachment that was created in a 1.x database with the 2.0 API.
var attachments = document.GetDictionary("_attachments"); var avatar = attachments.GetBlob("avatar"); var content = avatar?.Content;
The replication protocol used in Couchbase Lite 2.0 has been re-designed from the ground up and it 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.