A newer version of this documentation is available.

View Latest

Installing Couchbase Lite on .Net

      +

      Description — How to install Couchbase Lite on .Net
      Abstract — Using Nuget to install Couchbase Lite on csharp

      Quick Steps

      For experienced developers, this is all you need to add Couchbase Lite for C#.Net 3.1.9 to your application projects.

      1. Create or open an existing Visual Studio project

      2. Install either of the following packages from Nuget.

        • Community Edition — Couchbase.Lite package for 3.1.9

        • Enterprise Edition — Couchbase.Lite.Enterprise package for 3.1.9

      3. Within your app, include a call the relevant Activate() function inside of the class that is included in the support assembly.

      That’s it!
      You should be ready to build you app using this version. The rest of this content contains more detail, for those who want tp know more about the install or who encountered issues

      Install Methods

      Couchbase recommends installing Nuget packages via PackageReference.

      Package Reference

      This is the recommended method of dependency management because it supports the strict version requirement between the core Couchbase Lite for .Net package and its dependent Support library, which comprises:

      Couchbase.Lite.Enterprise
      • Couchbase.Lite.Enterprise.Support.UWP

      • Couchbase.Lite.Enterprise.Support.ios

      • Couchbase.Lite.Enterprise.Support.Android

      • Couchbase.Lite.Enterprise.Support.NetDesktop

      • Couchbase.Lite.Enterprise.Support.WinUI

      Couchbase.Lite
      • Couchbase.Lite.Support.UWP

      • Couchbase.Lite.Support.ios

      • Couchbase.Lite.Support.Android

      • Couchbase.Lite.Support.NetDesktop

      • Couchbase.Lite.Support.WinUI

      Activating (on Android platform only)

      Couchbase Lite must be activated before any other calls can be made.

      Within your Android app, include a call the relevant Activate() function inside of the class that is included in the support assembly.

      There is only one public class in each support assembly, and the support assembly itself is a nuget dependency.

      For example, UWP looks like:
      Couchbase.Lite.Support.UWP.Activate()

      Currently the support assemblies provide dependency injected mechanisms for default directory logic, and platform specific logging (So, C# will log to logcat with correct log levels and tags. No more "mono-stdout" always at info level.)

      Activating with MAUI

      To activate with .NET MAUI, you must override the OnCreate() method in the MainActivity.cs file to ensure activation at the beginning of the application lifecyle.

      Below is an example of how you can override the OnCreate() method.

      public class MainActivity : MauiAppCompatActivity
      {
          protected override void OnCreate(Bundle savedInstanceState)
          {
              base.OnCreate(savedInstanceState);
              Couchbase.Lite.Support.Droid.Activate(this);
          }
      }