using System.Data;
using System.Data.Common;
using System.Text.RegularExpressions;
using NPoco;
using StackExchange.Profiling.Data;
using Umbraco.Cms.Infrastructure.Persistence;
using Umbraco.Cms.Infrastructure.Persistence.FaultHandling;
using Umbraco.Cms.Infrastructure.Persistence.SqlSyntax;
namespace Umbraco.Extensions;
///
/// Provides extension methods to NPoco Database class.
///
public static partial class NPocoDatabaseExtensions
{
///
/// Iterates over the result of a paged data set with a db reader
///
///
///
///
/// The number of rows to load per page
///
///
///
/// Specify a custom Sql command to get the total count, if null is specified than the
/// auto-generated sql count will be used
///
///
///
/// NPoco's normal Page returns a List{T} but sometimes we don't want all that in memory and instead want to
/// iterate over each row with a reader using Query vs Fetch.
///
public static IEnumerable QueryPaged(this IDatabase database, long pageSize, Sql sql, Sql? sqlCount)
{
var sqlString = sql.SQL;
var sqlArgs = sql.Arguments;
int? itemCount = null;
long pageIndex = 0;
do
{
// Get the paged queries
database.BuildPageQueries(pageIndex * pageSize, pageSize, sqlString, ref sqlArgs, out var generatedSqlCount, out var sqlPage);
// get the item count once
if (itemCount == null)
{
itemCount = database.ExecuteScalar(
sqlCount?.SQL ?? generatedSqlCount,
sqlCount?.Arguments ?? sqlArgs);
}
pageIndex++;
// iterate over rows without allocating all items to memory (Query vs Fetch)
foreach (T row in database.Query(sqlPage, sqlArgs))
{
yield return row;
}
}
while (pageIndex * pageSize < itemCount);
}
///
/// Iterates over the result of a paged data set with a db reader
///
///
///
///
/// The number of rows to load per page
///
///
///
///
/// NPoco's normal Page returns a List{T} but sometimes we don't want all that in memory and instead want to
/// iterate over each row with a reader using Query vs Fetch.
///
public static IEnumerable QueryPaged(this IDatabase database, long pageSize, Sql sql) =>
database.QueryPaged(pageSize, sql, null);
// NOTE
//
// proper way to do it with TSQL and SQLCE
// IF EXISTS (SELECT ... FROM table WITH (UPDLOCK,HOLDLOCK)) WHERE ...)
// BEGIN
// UPDATE table SET ... WHERE ...
// END
// ELSE
// BEGIN
// INSERT INTO table (...) VALUES (...)
// END
//
// works in READ COMMITED, TSQL & SQLCE lock the constraint even if it does not exist, so INSERT is OK
//
// TODO: use the proper database syntax, not this kludge
///
/// Safely inserts a record, or updates if it exists, based on a unique constraint.
///
///
///
///
/// The action that executed, either an insert or an update. If an insert occurred and a PK value got generated, the
/// poco object
/// passed in will contain the updated value.
///
///
///
/// We cannot rely on database-specific options because SQLCE
/// does not support any of them. Ideally this should be achieved with proper transaction isolation levels but that
/// would mean revisiting
/// isolation levels globally. We want to keep it simple for the time being and manage it manually.
///
/// We handle it by trying to update, then insert, etc. until something works, or we get bored.
///
/// Note that with proper transactions, if T2 begins after T1 then we are sure that the database will contain T2's
/// value
/// once T1 and T2 have completed. Whereas here, it could contain T1's value.
///
///
[Obsolete("Use InsertOrUpdateAsync instead")]
public static RecordPersistenceType InsertOrUpdate(this IUmbracoDatabase db, T poco)
where T : class =>
db.InsertOrUpdate(poco, null, null);
///
/// Safely inserts a record, or updates if it exists, based on a unique constraint.
///
///
///
///
/// If the entity has a composite key they you need to specify the update command explicitly
///
/// The action that executed, either an insert or an update. If an insert occurred and a PK value got generated, the
/// poco object
/// passed in will contain the updated value.
///
///
///
/// We cannot rely on database-specific options because SQLCE
/// does not support any of them. Ideally this should be achieved with proper transaction isolation levels but that
/// would mean revisiting
/// isolation levels globally. We want to keep it simple for the time being and manage it manually.
///
/// We handle it by trying to update, then insert, etc. until something works, or we get bored.
///
/// Note that with proper transactions, if T2 begins after T1 then we are sure that the database will contain T2's
/// value
/// once T1 and T2 have completed. Whereas here, it could contain T1's value.
///
///
public static async Task InsertOrUpdateAsync(
this IUmbracoDatabase db,
T poco,
string? updateCommand,
object? updateArgs)
where T : class
{
if (poco == null)
{
throw new ArgumentNullException(nameof(poco));
}
// TODO: NPoco has a Save method that works with the primary key
// in any case, no point trying to update if there's no primary key!
// try to update
var rowCount = updateCommand.IsNullOrWhiteSpace() || updateArgs is null
? await db.UpdateAsync(poco)
: db.Update(updateCommand!, updateArgs);
if (rowCount > 0)
{
return RecordPersistenceType.Update;
}
// failed: does not exist, need to insert
// RC1 race cond here: another thread may insert a record with the same constraint
var i = 0;
while (i++ < 4)
{
try
{
// try to insert
await db.InsertAsync(poco);
return RecordPersistenceType.Insert;
}
catch (DbException)
{
// assuming all db engines will throw SQLException exception
// failed: exists (due to race cond RC1)
// RC2 race cond here: another thread may remove the record
// try to update
rowCount = updateCommand.IsNullOrWhiteSpace() || updateArgs is null
? await db.UpdateAsync(poco)
: db.Update(updateCommand!, updateArgs);
if (rowCount > 0)
{
return RecordPersistenceType.Update;
}
// failed: does not exist (due to race cond RC2), need to insert
// loop
}
}
// this can go on forever... have to break at some point and report an error.
throw new DataException("Record could not be inserted or updated.");
}
public static RecordPersistenceType InsertOrUpdate(
this IUmbracoDatabase db,
T poco,
string? updateCommand,
object? updateArgs)
where T : class =>
db.InsertOrUpdateAsync(poco, updateCommand, updateArgs).GetAwaiter().GetResult();
///
/// This will escape single @ symbols for npoco values so it doesn't think it's a parameter
///
///
///
public static string EscapeAtSymbols(string value)
{
if (value.Contains('@') == false)
{
return value;
}
// this fancy regex will only match a single @ not a double, etc...
return AtRegex().Replace(value, "@@");
}
[GeneratedRegex("(?
/// Returns the underlying connection as a typed connection - this is used to unwrap the profiled mini profiler stuff
///
///
///
///
public static TConnection GetTypedConnection(IDbConnection? connection)
where TConnection : class, IDbConnection
{
IDbConnection? c = connection;
for (; ;)
{
switch (c)
{
case TConnection ofType:
return ofType;
case RetryDbConnection retry:
c = retry.Inner;
break;
case ProfiledDbConnection profiled:
c = profiled.WrappedConnection;
break;
default:
throw new NotSupportedException(connection?.GetType().FullName);
}
}
}
///
/// Returns the underlying transaction as a typed transaction - this is used to unwrap the profiled mini profiler stuff
///
///
///
///
public static TTransaction GetTypedTransaction(IDbTransaction? transaction)
where TTransaction : class, IDbTransaction
{
IDbTransaction? t = transaction;
for (; ;)
{
switch (t)
{
case TTransaction ofType:
return ofType;
case ProfiledDbTransaction profiled:
t = profiled.WrappedTransaction;
break;
default:
throw new NotSupportedException(transaction?.GetType().FullName);
}
}
}
///
/// Returns the underlying command as a typed command - this is used to unwrap the profiled mini profiler stuff
///
///
///
///
public static TCommand GetTypedCommand(IDbCommand command)
where TCommand : class, IDbCommand
{
IDbCommand? c = command;
for (; ;)
{
switch (c)
{
case TCommand ofType:
return ofType;
case FaultHandlingDbCommand faultHandling:
c = faultHandling.Inner;
break;
case ProfiledDbCommand profiled:
c = profiled.InternalCommand;
break;
default:
throw new NotSupportedException(command.GetType().FullName);
}
}
}
public static void TruncateTable(this IDatabase db, ISqlSyntaxProvider sqlSyntax, string tableName)
{
var sql = new Sql(string.Format(
sqlSyntax.TruncateTable,
sqlSyntax.GetQuotedTableName(tableName)));
db.Execute(sql);
}
public static IsolationLevel GetCurrentTransactionIsolationLevel(this IDatabase database)
{
DbTransaction? transaction = database.Transaction;
return transaction?.IsolationLevel ?? IsolationLevel.Unspecified;
}
public static IEnumerable FetchByGroups(this IDatabase db, IEnumerable source, int groupSize, Func, Sql> sqlFactory) =>
source.SelectByGroups(x => db.Fetch(sqlFactory(x)), groupSize);
}