LiteSync

.NET

There are many options to use LiteSync on .NET

On this page there are instructions for Desktop (Windows, Mac and Linux). For mobile please check Xamarin

SQLite.NET

The SQLite.NET for LiteSync is a fork of SQLite.NET that uses the LiteSync library

Instructions

First follow the instructions to compile and install LiteSync from the source code or use the pre-compiled binaries for your platform. You can start with the free version.

You can put the .dll, .dylib or .so along side your application binaries or in a system-wide library path.

Here is how to bundle the library on the project:

1. On the Solution Explorer click on "Add Existing" and then select the LiteSync library (litesync-0.1.dll or liblitesync.so/dylib)

2. On properties of the library set "Build Action" to "Content" and set "Copy to Output Directory" to "Copy Always"

Add the SQLite.cs file to your project

Tables

The library contains simple attributes that you can use to control the construction of tables

public class TodoItem
{
    [PrimaryKey]
    public long ID { get; set; }
    public string Name { get; set; }
    public bool Done { get; set; }
}

On tables with integer primary keys the primary key column must be declared as long instead of int because LiteSync always use a 64-bit number for row ids

LiteSync does not support the AutoIncrement keyword

Example Code

using SQLite;

// open the database
var uri = "file:test.db?node=primary&bind=tcp://0.0.0.0:1234";
var db = new SQLiteConnection(uri);

// wait until the db is ready
while (!db.IsReady()) {
    System.Threading.Thread.Sleep(250);
}

// now we can use the database
db.CreateTable<TodoItem>(CreateFlags.AutoIncPK);
...

Instead of waiting until the database is ready for access we can use an event notification:

// callback for when the db is ready (do not access the database before)
db.OnReady(() => {
    // the database is ready to be accessed
    db.CreateTable<TodoItem>(CreateFlags.AutoIncPK);
    ...
});

Your application can also receive a notification when the database receives a sync/update:

db.OnSync(() => {
    // the db received an update. update the screen with new data
    UpdateScreen(db);
});

To retrieve the synchronization status:

var status = db.ExecuteScalar<string>("pragma sync_status");

Sample Project

Download

Microsoft.Data.SQLite

The Microsoft.Data.SQLite uses the SQLitePCLRaw to interface with the native library

Native Library

First follow the instructions to compile and install LiteSync from the source code or use the pre-compiled binaries for your platform. You can start with the free version.

You can put the .dll, .dylib or .so along side your application binaries, or in a system-wide library path.

Here is how to bundle the library on the project:

1. On the Solution Explorer click on "Add Existing" and then select the LiteSync library (litesync.dll or liblitesync.so/dylib). On Windows it may require to rename the litesync-0.1.dll to litesync.dll

2. On properties of the library set "Build Action" to "Content" and set "Copy to Output Directory" to "Copy Always"

Note: If it fails with "unable to load DLL or one of its dependencies", it may require to add the binn and libuv libraries to the project as well, and mark them to be copied to the output folder

Nuget Packages

Install with these commands:

Example Code

Make sure to load the native library before using Microsoft.Data.Sqlite

using Microsoft.Data.Sqlite;
using SQLitePCL;

namespace LiteSyncExample
{
    class Program
    {
        static void Main()
        {
            // load the LiteSync native library
            SQLitePCL.raw.SetProvider(new SQLite3Provider_LiteSync());
            SQLitePCL.raw.FreezeProvider(true);

            // open the database
            var uri = "file:test.db?node=primary&bind=tcp://0.0.0.0:1234";
            var db = new SqliteConnection("Data Source=" + uri);
            db.Open();

            // check if the db is ready
            while (true) {
                SqliteCommand cmd = db.CreateCommand();
                cmd.CommandText = "pragma sync_status";
                string status = (string) cmd.ExecuteScalar();
                if (status == null) {
                    Console.WriteLine("the loaded library does not contain LiteSync");
                    return;
                }
                if (status.Contains("\"db_is_ready\": true")) break;
                System.Threading.Thread.Sleep(250);
            }

            // now we can use the database
            ...
        }
    }
}

Instead of waiting until the database is ready for access we can use an event notification:

// callback for when the db is ready (do not access the database before)
db.CreateFunction("ready_notification", () => {
    // notification received on the worker thread
    // do not access the db connection here
    // transfer the notification to the main thread
    Console.WriteLine("the database is ready to be accessed");
});

Your application can also receive a notification when the database receives a sync/update:

db.CreateFunction("sync_notification", () => {
    // notification received on the worker thread
    // do not access the db connection here
    // transfer the notification to the main thread
    Console.WriteLine("db updated");
});

Sample Project

Download

Mono SQLite

The Mono SQLite can also be used.

First follow the instructions to compile and install LiteSync from the source code or use the pre-compiled binaries for your platform. You can start with the free version.

For the interface to work with the LiteSync library we must define SQLITE_STANDARD and modify this line from "sqlite3" to "litesync".

System.Data.SQLite

This wrapper is no longer supported. It is hard to maintain because it builds its own native library.