How to try Akka.Persistence.Linq2Db if you are an existing Akka.Persistence.Sql user.

[to11mtm]

We've created Akka.Persistence.Linq2Db in effort to provide the community a high performance, database agnostic solution to SQL Persistence needs.

As part of recognizing the community's need to migrate from existing plugins, we have created a 'Compatibility mode' with corresponding code support in order to make it easier for users to migrate over to the new version.

This discussion aims to provide Answer questions, and provide guidance to those wanting to give it a try.

Migrating from Akka.Persistence.Sql Journal

You can use your existing HOCON configuration, as long as you follow the instructions below!

• Make sure your launching project pulls in a reference to the database connector needed.
  • SQL Server: Microsoft.Data.SqlClient or System.Data.SqlClient
  • Postgres: Npgsql
  • SQLite: Microsoft.Data.Sqlite
• Make the following changes:
  • Change class to the following:
    • class = "Akka.Persistence.Sql.Linq2Db.Journal.Linq2DbWriteJournal, Akka.Persistence.Sql.Linq2Db"
  • Add the compatibility mode switch, to set column names to be the same as Akka.Persistence.Sql.Common:
    • table-compatibility-mode
      • Sql Server : table-compatibility-mode = "SqlServer"
      • Postgres : table-compatibility-mode = "Postgres"
      • Sqlite : table-compatibility-mode = "Sqlite"
  • Add the provider-name for your database provider.
    • Sql Server, Pick the right version. Really, there shouldn't be anything that special about what we do that will require anything too specific here. Still, would not hurt for possible future functionality to be specific.
      • 2008+ provider-name = "SqlServer.2008"
      • 2012+ provider-name = "SqlServer.2012"
      • 2014+ provider-name = "SqlServer.2014"
      • 2016+ provider-name = "SqlServer.2016"
      • 2017+ provider-name = "SqlServer.2017"
    • PostgreSQL, It is important to only specify 9.5 here if you actually have it, as some delete statements -will- be written differently if you don't and might not work.
      • provider-name = "PostgreSQL.9.2"
      • provider-name = "PostgreSQL.9.3"
      • provider-name = "PostgreSQL.9.5"
    • SQLite, this one is easy, just use the below and you'll be all set.
      • provider-name = "SQLite.MS"
  • Table names:
    • You shouldn't have to move your table names in configuration, we try to first read from tables.journal.table-name and tables.journal.metadata-table-name but will try to read what is in the 'root' journal configuration first. Here's an example from the SQLite compatibility spec to help explain
    • If you -do- have an issue, use tables.journal.table-name and tables.journal.metadata-table-name to set your table names for the Journal and Journal Metadata, respectively.

[to11mtm]

Migrating from Akka.Persistence.Sql Snapshot Store

You can use your existing HOCON configuration, as long as you follow the instructions below!

• Make the following changes:
  • Change class to the following:
    • class = "class = "Akka.Persistence.Sql.Linq2Db.Snapshot.Linq2DbSnapshotStore, Akka.Persistence.Sql.Linq2Db"
  • Add the compatibility mode switch, to set column names to be the same as Akka.Persistence.Sql.Common:
    • table-compatibility-mode
      • Sql Server : table-compatibility-mode = "SqlServer"
      • Postgres : table-compatibility-mode = "Postgres"
      • Sqlite : table-compatibility-mode = "Sqlite"
  • Add the provider-name for your database provider.
    • Sql Server, Pick the right version. Really, there shouldn't be anything that special about what we do that will require anything too specific here. Still, would not hurt for possible future functionality to be specific.
      • 2008+ provider-name = "SqlServer.2008"
      • 2012+ provider-name = "SqlServer.2012"
      • 2014+ provider-name = "SqlServer.2014"
      • 2016+ provider-name = "SqlServer.2016"
      • 2017+ provider-name = "SqlServer.2017"
    • PostgreSQL, It is important to only specify 9.5 here if you actually have it, as some delete statements -will- be written differently if you don't and might not work.
      • provider-name = "PostgreSQL.9.2"
      • provider-name = "PostgreSQL.9.3"
      • provider-name = "PostgreSQL.9.5"
    • SQLite, this one is easy, just use the below and you'll be all set.
      • provider-name = "SQLite.MS"
  • Table names:
    • You shouldn't have to move your table names in configuration, we try to first read from tables.snapshot.table-name and ` but will try to read what is in the 'root' journal configuration first. Here's an example from the SQLite compatibility spec to help explain
    • If you -do- have an issue, use tables.snapshot.table-name to set the snapshot table name.