PowerSync is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB, MySQL or SQL Server on the server-side.

powersync-dotnet is the monorepo for PowerSync .NET SDKs.

Packages are published to NuGet.

• PowerSync.Common
  • Core package: .NET implementation of a PowerSync database connector and streaming sync bucket implementation. Packages meant for specific platforms will extend functionality of Common.
• PowerSync.Maui
  • Extends the PowerSync.Common package to provide the .NET Multi-platform App UI (MAUI) integration for PowerSync for cross-platform mobile and desktop applications.

Demo applications are located in the demos/ directory. Also see our Demo Apps / Example Projects gallery which lists all projects by the backend and client-side framework they use.

• demos/CommandLine: A CLI-based app demonstrating real-time data sync
• demos/WPF: A Windows desktop to-do list app real-time data sync
• demos/MAUITodo: A cross-platform mobile and desktop to-do list app built with .NET MAUI, running on iOS, Android and Windows

This PowerSync SDK supports the following target frameworks:

• .NET 9 - Latest version

• .NET 8 - Current LTS Version, used for development of this project

• .NET 6 - supported for compatibility with older projects

• .NET Standard 2.0 - for compatibility with older libraries and frameworks, tested/verified older versions will be listed below.

• .NET Framework 4.8:

  To get a .NET Framework 4.8 working with this SDK add the following to your .csproj file:

  <PropertyGroup>
    ...
    <!-- Ensures the correct SQLite DLL is available -->
    <RuntimeIdentifiers>win-x86;win-x64</RuntimeIdentifiers>
    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
  </PropertyGroup>
  
  <ItemGroup>
    ...
    <!-- Ensures the HTTP client resolves in the SDK -->
    <PackageReference Include="System.Net.Http" Version="4.3.4" /> 
  </ItemGroup>

  and create a IsExternalInit.cs file in your project with the following contents:

  using System.ComponentModel;
  
  namespace System.Runtime.CompilerServices
  {
      [EditorBrowsable(EditorBrowsableState.Never)]
      internal class IsExternalInit { }
  }

When running commands such as dotnet run or dotnet test, you may need to specify the target framework explicitly using the --framework flag.

• MAUI - Cross-platform native apps for mobile and desktop
  • Platforms: iOS, Android, Windows
• WPF - Windows desktop applications
• Console Applications - Command-line and binary apps

This project uses EditorConfig for formatting, which may require certain extensions/plugins to function properly in your IDE.

• VSCode: Available via this extension.
• JetBrains Rider: Supported by default.
• Neovim: Supported by default, or via the gpanders/editorconfig.nvim plugin for versions prior to v0.9.
• Emacs: Available via editorconfig-mode, or the editorconfig package for versions prior to v30.1.

Download PowerSync extension

dotnet run --project Tools/Setup    

Install dependencies

dotnet restore

Run all tests

dotnet test -v n --framework net8.0

Run a specific test

dotnet test -v n --framework net8.0 --filter "test-file-pattern"  

Integration tests in PowerSync.Common.IntegrationTests are intended to run against the self-host nodejs demo. The integration tests are disabled by default, define the following environment variable when running the tests.

RUN_INTEGRATION_TESTS=true dotnet test -v n --framework net8.0

Only run integration tests, without any unit tests.

RUN_INTEGRATION_TESTS=true dotnet test -v n --framework net8.0 --filter "Category=Integration"

Performance tests in PowerSync.Common.PerformanceTests are disabled by default, define the following environment variable when running the tests.

RUN_PERFORMANCE_TESTS=true dotnet test -v n --framework net8.0

Only run performance tests, without any unit tests.

RUN_PERFORMANCE_TESTS=true dotnet test -v n --framework net8.0 --filter "Category=Performance"

dotnet add package PowerSync.Common