Couchbase.Lite.Support.NetDesktop 3.2.0-beta.2

Prefix Reserved
This is a prerelease version of Couchbase.Lite.Support.NetDesktop.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Couchbase.Lite.Support.NetDesktop --version 3.2.0-beta.2                
NuGet\Install-Package Couchbase.Lite.Support.NetDesktop -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.Support.NetDesktop" 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.Support.NetDesktop --version 3.2.0-beta.2                
#r "nuget: Couchbase.Lite.Support.NetDesktop, 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.Support.NetDesktop as a Cake Addin
#addin nuget:?package=Couchbase.Lite.Support.NetDesktop&version=3.2.0-beta.2&prerelease

// Install Couchbase.Lite.Support.NetDesktop as a Cake Tool
#tool nuget:?package=Couchbase.Lite.Support.NetDesktop&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 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-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Couchbase.Lite.Support.NetDesktop:

Package Downloads
Couchbase.Lite

A lightweight, document-oriented (NoSQL), syncable database engine for .NET

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.2.0 6,827 8/30/2024
3.2.0-beta.2 300 5/16/2024
3.1.9 2,503 8/9/2024
3.1.7 1,407 5/1/2024
3.1.6 10,554 3/6/2024
3.1.3 33,227 11/16/2023
3.1.1 3,880 7/18/2023
3.1.0 3,518 4/27/2023
3.0.15 1,158 11/6/2023
3.0.12 2,008 6/26/2023
3.0.8 6,983 2/8/2023
3.0.2 17,533 8/2/2022
3.0.0 52,364 2/22/2022
3.0.0-beta02 1,592 10/19/2021
3.0.0-beta01 1,421 9/21/2021
2.8.6 15,584 8/3/2021 2.8.6 is deprecated because it is no longer maintained.
2.8.4 21,406 3/2/2021 2.8.4 is deprecated because it is no longer maintained.
2.8.2 12,443 11/20/2020 2.8.2 is deprecated because it is no longer maintained.
2.8.0 10,104 9/30/2020 2.8.0 is deprecated because it is no longer maintained.
2.7.1 26,938 4/17/2020 2.7.1 is deprecated because it is no longer maintained.
2.7.0 5,890 1/16/2020 2.7.0 is deprecated because it is no longer maintained.
2.6.4 2,021 2/11/2020 2.6.4 is deprecated because it is no longer maintained.
2.6.0 20,538 8/27/2019 2.6.0 is deprecated because it is no longer maintained.
2.5.3 2,659 7/31/2019 2.5.3 is deprecated because it is no longer maintained.
2.5.2 2,694 7/3/2019 2.5.2 is deprecated because it is no longer maintained.
2.5.0 29,015 4/30/2019 2.5.0 is deprecated because it is no longer maintained.
2.1.5 1,999 5/23/2019 2.1.5 is deprecated because it is no longer maintained.
2.1.2 35,730 11/16/2018 2.1.2 is deprecated because it is no longer maintained.
2.1.1 5,214 10/5/2018 2.1.1 is deprecated because it is no longer maintained.
2.1.0 3,361 8/30/2018 2.1.0 is deprecated because it is no longer maintained.
2.0.3 30,391 6/5/2018 2.0.3 is deprecated because it is no longer maintained.
2.0.2 2,314 6/1/2018 2.0.2 is deprecated because it is no longer maintained.
2.0.0.1 3,759 4/12/2018 2.0.0.1 is deprecated because it is no longer maintained.
2.0.0 4,185 4/12/2018 2.0.0 is deprecated because it is no longer maintained.