Couchbase.Lite 3.2.0-beta.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Couchbase.Lite.
dotnet add package Couchbase.Lite --version 3.2.0-beta.2
NuGet\Install-Package Couchbase.Lite -Version 3.2.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Couchbase.Lite" Version="3.2.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Couchbase.Lite --version 3.2.0-beta.2
#r "nuget: Couchbase.Lite, 3.2.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Couchbase.Lite as a Cake Addin
#addin nuget:?package=Couchbase.Lite&version=3.2.0-beta.2&prerelease

// Install Couchbase.Lite as a Cake Tool
#tool nuget:?package=Couchbase.Lite&version=3.2.0-beta.2&prerelease

Couchbase Lite .NET

Couchbase Lite is a lightweight embedded NoSQL database that has built-in sync to larger backend structures, such as Couchbase Server.

This is the source repo of Couchbase Lite C#. The main supported platforms are .NET 6 Desktop (Linux will run anywhere, but is most tested on Ubuntu), .NET 8 iOS, .NET 8 Android, .NET 8 Mac Catalyst, .NET 8 WinUI, Xamarin iOS, and Xamarin Android.

Documentation Overview

Getting Started

The following starter code demonstrates the basic concepts of the library:


using System;
using Couchbase.Lite;
using Couchbase.Lite.Query;
using Couchbase.Lite.Sync;

// Get the database (and create it if it doesn't exist)
var database = new Database("mydb");
var collection = database.GetDefaultCollection();

// Create a new document (i.e. a record) in the database
var id = default(string);
using var createdDoc = new MutableDocument();
createdDoc.SetFloat("version", 2.0f)
    .SetString("type", "SDK");

// Save it to the database
collection.Save(createdDoc);
id = createdDoc.Id;

// Update a document
using var doc = collection.GetDocument(id);
using var mutableDoc = doc.ToMutable();
createdDoc.SetString("language", "C#");
collection.Save(createdDoc);

using var docAgain = collection.GetDocument(id);
Console.WriteLine($"Document ID :: {docAgain.Id}");
Console.WriteLine($"Learning {docAgain.GetString("language")}");


// Create a query to fetch documents of type SDK
// i.e. SELECT * FROM database WHERE type = "SDK"
using var query = QueryBuilder.Select(SelectResult.All())
    .From(DataSource.Collection(collection))
    .Where(Expression.Property("type").EqualTo(Expression.String("SDK")));

// Alternatively, using SQL++, with _ referring to the database
using var sqlppQuery = collection.CreateQuery("SELECT * FROM _ WHERE type = 'SDK'");

// Run the query
var result = query.Execute();
Console.WriteLine($"Number of rows :: {result.AllResults().Count}");

// Create replicator to push and pull changes to and from the cloud
var targetEndpoint = new URLEndpoint(new Uri("ws://localhost:4984/getting-started-db"));
var replConfig = new ReplicatorConfiguration(targetEndpoint);
replConfig.AddCollection(database.GetDefaultCollection());

// Add authentication
replConfig.Authenticator = new BasicAuthenticator("john", "pass");

// Create replicator
var replicator = new Replicator(replConfig);
replicator.AddChangeListener((sender, args) =>
{
    if (args.Status.Error != null) {
        Console.WriteLine($"Error :: {args.Status.Error}");
    }
});

replicator.Start();

// Later, stop and dispose the replicator *before* closing/disposing the database
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-android34.0 is compatible.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst17.2 is compatible.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows10.0.19041 is compatible. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed.  monoandroid10.0 is compatible. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed.  xamarinios10 is compatible. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Couchbase.Lite:

Package Downloads
MvvX.Plugins.CouchBaseLite

This package contains the 'CouchBaseLite' plugin for MvvmCross.

Couchbase.Lite.Listener The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides Couchbase Lite with a self-hosted REST API.

KidoZen

This package contains the KidoZen SDK assemblies.

NoSqlRepositories.CouchBaseLite

This package is designed for Couchbase lite

Linq2CouchBaseLiteExpression

This package let you create linq queries to querying a couchbase lite database

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Couchbase.Lite:

Repository Stars
stoveproject/Stove
Domain Driven Design oriented application framework, meets CRUD needs
cmendible/dotnetcore.samples
.NET Core Samples - Code it Yourself...
Version Downloads Last updated
3.2.0-beta.2 53 5/16/2024
3.1.7 258 5/1/2024
3.1.6 3,730 3/6/2024
3.1.3 11,931 11/16/2023
3.1.1 3,897 7/18/2023
3.1.0 2,481 4/27/2023
3.0.15 538 11/6/2023
3.0.12 922 6/26/2023
3.0.8 3,159 2/8/2023
3.0.2 14,483 8/2/2022
3.0.0 42,527 2/22/2022
3.0.0-beta02 1,028 10/19/2021
3.0.0-beta01 949 9/21/2021
2.8.6 15,981 8/3/2021
2.8.4 21,258 3/2/2021
2.8.2 12,232 11/20/2020
2.8.0 9,079 9/30/2020
2.7.1 24,910 4/17/2020
2.7.0 7,902 1/16/2020
2.6.4 1,509 2/11/2020
2.6.0 24,144 8/27/2019
2.5.3 2,980 7/31/2019
2.5.2 2,643 7/3/2019
2.5.0 27,082 4/30/2019
2.1.5 1,654 5/23/2019
2.1.2 35,619 11/16/2018
2.1.1 4,657 10/5/2018
2.1.0 3,022 8/30/2018
2.0.3 29,971 6/5/2018
2.0.2 2,011 6/1/2018
2.0.0.1 3,470 4/12/2018
2.0.0 4,276 4/11/2018
1.4.4 6,372 10/17/2018
1.4.1 40,206 11/15/2017
1.4.0 11,096 3/6/2017
1.3.1 8,736 9/13/2016
1.3.0 15,149 8/4/2016
1.2.1.1 6,419 4/26/2016
1.2.1 2,804 4/26/2016
1.2.0.3 6,253 2/9/2016
1.2.0 6,210 2/4/2016
1.1.2 5,661 10/2/2015
1.1.1.1 4,148 8/28/2015
1.1.0.1 3,058 6/18/2015
1.1.0 2,559 6/18/2015
1.1.0-pre1 1,816 5/12/2015
1.1.0-pre 1,890 5/12/2015
1.0.4.1 3,451 1/20/2015
1.0.0 2,882 10/9/2014
0.9.7.1 3,084 10/3/2014
0.9.7 1,982 10/3/2014
0.9.6 2,176 10/2/2014
0.9.5 2,215 9/23/2014
0.9.5-pre9 1,822 9/22/2014
0.9.5-pre8 1,819 9/21/2014
0.9.5-pre7 1,855 9/20/2014
0.9.5-pre6 1,803 9/20/2014
0.9.5-pre5 1,855 9/20/2014
0.9.5-pre4 1,858 9/20/2014
0.9.5-pre3 2,513 9/19/2014
0.9.5-pre2 1,918 9/16/2014
0.9.5-pre10 1,803 9/22/2014
0.9.5-pre 2,017 9/11/2014