2021-05-20 21:28:18 +02:00
|
|
|
#nullable disable
|
|
|
|
|
2019-11-01 18:38:54 +01:00
|
|
|
#pragma warning disable CS1591
|
|
|
|
|
2019-01-13 20:54:44 +01:00
|
|
|
using System;
|
2016-11-18 09:39:20 +01:00
|
|
|
using System.Collections.Generic;
|
2021-12-20 13:31:07 +01:00
|
|
|
using Jellyfin.Extensions;
|
2018-12-13 14:18:25 +01:00
|
|
|
using Microsoft.Extensions.Logging;
|
2019-01-13 20:20:16 +01:00
|
|
|
using SQLitePCL.pretty;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
|
|
|
namespace Emby.Server.Implementations.Data
|
|
|
|
{
|
|
|
|
public abstract class BaseSqliteRepository : IDisposable
|
|
|
|
{
|
2019-04-03 17:34:54 +02:00
|
|
|
private bool _disposed = false;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-11-01 18:38:54 +01:00
|
|
|
/// <summary>
|
|
|
|
/// Initializes a new instance of the <see cref="BaseSqliteRepository"/> class.
|
|
|
|
/// </summary>
|
2019-12-10 16:22:03 +01:00
|
|
|
/// <param name="logger">The logger.</param>
|
2020-06-06 02:15:56 +02:00
|
|
|
protected BaseSqliteRepository(ILogger<BaseSqliteRepository> logger)
|
2016-11-18 09:39:20 +01:00
|
|
|
{
|
|
|
|
Logger = logger;
|
2016-11-21 00:48:52 +01:00
|
|
|
}
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path to the DB file.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected string DbFilePath { get; set; }
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2023-04-14 13:43:56 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the number of write connections to create.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>Path to the DB file.</value>
|
|
|
|
protected int WriteConnectionsCount { get; set; } = 1;
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the number of read connections to create.
|
|
|
|
/// </summary>
|
|
|
|
protected int ReadConnectionsCount { get; set; } = 1;
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the logger.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The logger.</value>
|
2020-06-06 02:15:56 +02:00
|
|
|
protected ILogger<BaseSqliteRepository> Logger { get; }
|
2016-11-28 20:26:48 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the default connection flags.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The default connection flags.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual ConnectionFlags DefaultConnectionFlags => ConnectionFlags.NoMutex;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the transaction mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The transaction mode.</value>>
|
2019-01-06 21:50:43 +01:00
|
|
|
protected TransactionMode TransactionMode => TransactionMode.Deferred;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the transaction mode for read-only operations.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The transaction mode.</value>
|
2019-01-06 21:50:43 +01:00
|
|
|
protected TransactionMode ReadTransactionMode => TransactionMode.Deferred;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the cache size.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The cache size or null.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual int? CacheSize => null;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2023-01-09 00:07:53 +01:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the locking mode. <see href="https://www.sqlite.org/pragma.html#pragma_locking_mode" />.
|
|
|
|
/// </summary>
|
2023-04-14 13:43:56 +02:00
|
|
|
protected virtual string LockingMode => "NORMAL";
|
2023-01-09 00:07:53 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
2021-08-29 00:32:50 +02:00
|
|
|
/// Gets the journal mode. <see href="https://www.sqlite.org/pragma.html#pragma_journal_mode" />.
|
2019-07-01 18:24:35 +02:00
|
|
|
/// </summary>
|
|
|
|
/// <value>The journal mode.</value>
|
2023-01-09 00:07:53 +01:00
|
|
|
protected virtual string JournalMode => "WAL";
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2023-01-10 22:29:05 +01:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the journal size limit. <see href="https://www.sqlite.org/pragma.html#pragma_journal_size_limit" />.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The journal size limit.</value>
|
|
|
|
protected virtual int? JournalSizeLimit => 0;
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the page size.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The page size or null.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual int? PageSize => null;
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the temp store mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The temp store mode.</value>
|
|
|
|
/// <see cref="TempStoreMode"/>
|
2023-04-14 13:43:56 +02:00
|
|
|
protected virtual TempStoreMode TempStore => TempStoreMode.Memory;
|
2016-11-19 08:51:07 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the synchronous mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The synchronous mode or null.</value>
|
|
|
|
/// <see cref="SynchronousMode"/>
|
2023-01-09 14:14:19 +01:00
|
|
|
protected virtual SynchronousMode? Synchronous => SynchronousMode.Normal;
|
2016-11-20 22:02:32 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the write lock.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The write lock.</value>
|
2023-04-14 13:43:56 +02:00
|
|
|
protected ConnectionPool WriteConnections { get; set; }
|
2016-11-21 09:54:53 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the write connection.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The write connection.</value>
|
2023-04-14 13:43:56 +02:00
|
|
|
protected ConnectionPool ReadConnections { get; set; }
|
|
|
|
|
|
|
|
public virtual void Initialize()
|
|
|
|
{
|
|
|
|
WriteConnections = new ConnectionPool(WriteConnectionsCount, CreateWriteConnection);
|
|
|
|
ReadConnections = new ConnectionPool(ReadConnectionsCount, CreateReadConnection);
|
2022-03-05 20:37:23 +01:00
|
|
|
|
2023-04-14 21:38:12 +02:00
|
|
|
// Configuration and pragmas can affect VACUUM so it needs to be last.
|
2023-04-14 22:43:14 +02:00
|
|
|
using (var connection = GetConnection())
|
2016-12-13 16:44:34 +01:00
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("VACUUM");
|
2016-12-13 16:44:34 +01:00
|
|
|
}
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
2023-04-14 21:38:12 +02:00
|
|
|
protected ManagedConnection GetConnection(bool readOnly = false)
|
|
|
|
=> readOnly ? ReadConnections.GetConnection() : WriteConnections.GetConnection();
|
|
|
|
|
2023-04-14 13:43:56 +02:00
|
|
|
protected SQLiteDatabaseConnection CreateWriteConnection()
|
|
|
|
{
|
|
|
|
var writeConnection = SQLite3.Open(
|
2019-03-11 22:33:27 +01:00
|
|
|
DbFilePath,
|
|
|
|
DefaultConnectionFlags | ConnectionFlags.Create | ConnectionFlags.ReadWrite,
|
|
|
|
null);
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (CacheSize.HasValue)
|
2019-02-20 14:26:49 +01:00
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA cache_size=" + CacheSize.Value);
|
2019-04-03 17:34:54 +02:00
|
|
|
}
|
2017-09-22 07:54:57 +02:00
|
|
|
|
2023-01-09 00:07:53 +01:00
|
|
|
if (!string.IsNullOrWhiteSpace(LockingMode))
|
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA locking_mode=" + LockingMode);
|
2023-01-09 00:07:53 +01:00
|
|
|
}
|
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (!string.IsNullOrWhiteSpace(JournalMode))
|
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA journal_mode=" + JournalMode);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2016-11-27 20:36:56 +01:00
|
|
|
|
2023-01-10 22:29:05 +01:00
|
|
|
if (JournalSizeLimit.HasValue)
|
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA journal_size_limit=" + JournalSizeLimit.Value);
|
2023-01-10 22:29:05 +01:00
|
|
|
}
|
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (Synchronous.HasValue)
|
2019-02-26 18:30:13 +01:00
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA synchronous=" + (int)Synchronous.Value);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2017-09-22 07:54:57 +02:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (PageSize.HasValue)
|
2019-02-26 18:30:13 +01:00
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA page_size=" + PageSize.Value);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2016-11-19 08:51:07 +01:00
|
|
|
|
2023-04-14 13:43:56 +02:00
|
|
|
writeConnection.Execute("PRAGMA temp_store=" + (int)TempStore);
|
2019-08-15 00:00:21 +02:00
|
|
|
|
2023-04-14 13:43:56 +02:00
|
|
|
return writeConnection;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected SQLiteDatabaseConnection CreateReadConnection()
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
var connection = SQLite3.Open(
|
2023-04-14 13:43:56 +02:00
|
|
|
DbFilePath,
|
|
|
|
DefaultConnectionFlags | ConnectionFlags.ReadOnly,
|
|
|
|
null);
|
|
|
|
|
|
|
|
if (CacheSize.HasValue)
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA cache_size=" + CacheSize.Value);
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!string.IsNullOrWhiteSpace(LockingMode))
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA locking_mode=" + LockingMode);
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!string.IsNullOrWhiteSpace(JournalMode))
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA journal_mode=" + JournalMode);
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (JournalSizeLimit.HasValue)
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA journal_size_limit=" + JournalSizeLimit.Value);
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (Synchronous.HasValue)
|
|
|
|
{
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA synchronous=" + (int)Synchronous.Value);
|
2023-04-14 13:43:56 +02:00
|
|
|
}
|
|
|
|
|
2023-04-14 21:38:12 +02:00
|
|
|
connection.Execute("PRAGMA temp_store=" + (int)TempStore);
|
2023-04-14 13:43:56 +02:00
|
|
|
|
2023-04-14 21:38:12 +02:00
|
|
|
return connection;
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
|
2016-12-13 16:44:34 +01:00
|
|
|
public IStatement PrepareStatement(ManagedConnection connection, string sql)
|
2019-02-26 18:58:33 +01:00
|
|
|
=> connection.PrepareStatement(sql);
|
2016-12-13 16:44:34 +01:00
|
|
|
|
2016-12-11 06:12:00 +01:00
|
|
|
public IStatement PrepareStatement(IDatabaseConnection connection, string sql)
|
2019-02-26 18:58:33 +01:00
|
|
|
=> connection.PrepareStatement(sql);
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2018-09-12 19:26:21 +02:00
|
|
|
protected bool TableExists(ManagedConnection connection, string name)
|
|
|
|
{
|
2020-10-12 20:05:11 +02:00
|
|
|
return connection.RunInTransaction(
|
2021-12-24 18:28:27 +01:00
|
|
|
db =>
|
2018-09-12 19:26:21 +02:00
|
|
|
{
|
2021-12-24 18:28:27 +01:00
|
|
|
using (var statement = PrepareStatement(db, "select DISTINCT tbl_name from sqlite_master"))
|
2018-09-12 19:26:21 +02:00
|
|
|
{
|
2021-12-24 18:28:27 +01:00
|
|
|
foreach (var row in statement.ExecuteQuery())
|
2018-09-12 19:26:21 +02:00
|
|
|
{
|
2021-12-24 18:28:27 +01:00
|
|
|
if (string.Equals(name, row.GetString(0), StringComparison.OrdinalIgnoreCase))
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
2018-09-12 19:26:21 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-12-24 18:28:27 +01:00
|
|
|
return false;
|
|
|
|
},
|
|
|
|
ReadTransactionMode);
|
2018-09-12 19:26:21 +02:00
|
|
|
}
|
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
protected List<string> GetColumnNames(IDatabaseConnection connection, string table)
|
2016-11-29 20:12:37 +01:00
|
|
|
{
|
2019-07-01 17:59:01 +02:00
|
|
|
var columnNames = new List<string>();
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
foreach (var row in connection.Query("PRAGMA table_info(" + table + ")"))
|
2017-08-09 21:56:38 +02:00
|
|
|
{
|
2021-05-16 14:49:11 +02:00
|
|
|
if (row.TryGetString(1, out var columnName))
|
2017-08-09 21:56:38 +02:00
|
|
|
{
|
2021-05-16 14:49:11 +02:00
|
|
|
columnNames.Add(columnName);
|
2019-04-03 18:02:43 +02:00
|
|
|
}
|
2017-08-09 21:56:38 +02:00
|
|
|
}
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-07-01 17:59:01 +02:00
|
|
|
return columnNames;
|
2016-11-29 20:12:37 +01:00
|
|
|
}
|
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
protected void AddColumn(IDatabaseConnection connection, string table, string columnName, string type, List<string> existingColumnNames)
|
|
|
|
{
|
2021-12-20 13:31:07 +01:00
|
|
|
if (existingColumnNames.Contains(columnName, StringComparison.OrdinalIgnoreCase))
|
2019-04-03 18:02:43 +02:00
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
2016-11-27 20:36:56 +01:00
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
connection.Execute("alter table " + table + " add column " + columnName + " " + type + " NULL");
|
|
|
|
}
|
2016-11-19 19:09:15 +01:00
|
|
|
|
2016-11-18 09:39:20 +01:00
|
|
|
protected void CheckDisposed()
|
|
|
|
{
|
|
|
|
if (_disposed)
|
|
|
|
{
|
2019-01-13 20:20:16 +01:00
|
|
|
throw new ObjectDisposedException(GetType().Name, "Object has been disposed and cannot be accessed.");
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-07-01 17:59:01 +02:00
|
|
|
/// <inheritdoc />
|
2016-11-18 09:39:20 +01:00
|
|
|
public void Dispose()
|
|
|
|
{
|
|
|
|
Dispose(true);
|
2019-04-02 22:15:18 +02:00
|
|
|
GC.SuppressFinalize(this);
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Releases unmanaged and - optionally - managed resources.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
|
|
protected virtual void Dispose(bool dispose)
|
|
|
|
{
|
2019-02-20 14:26:49 +01:00
|
|
|
if (_disposed)
|
2016-11-18 09:39:20 +01:00
|
|
|
{
|
2019-02-20 14:26:49 +01:00
|
|
|
return;
|
2017-09-22 07:54:57 +02:00
|
|
|
}
|
|
|
|
|
2019-02-26 18:58:33 +01:00
|
|
|
if (dispose)
|
2017-09-22 07:54:57 +02:00
|
|
|
{
|
2023-04-14 13:43:56 +02:00
|
|
|
WriteConnections.Dispose();
|
|
|
|
ReadConnections.Dispose();
|
2017-09-22 07:54:57 +02:00
|
|
|
}
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-02-20 14:26:49 +01:00
|
|
|
_disposed = true;
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|