View Source

Class UmbracoDatabase

Extends NPoco Database for Umbraco.

Inheritance

System.Object

Namespace: Umbraco.Cms.Infrastructure.Persistence

Assembly: Umbraco.Infrastructure.dll

Syntax

public class UmbracoDatabase : Database, IUmbracoDatabase

Remarks

Is used everywhere in place of the original NPoco Database object, and provides additional features such as profiling, retry policies, logging, etc.

Is never created directly but obtained from the UmbracoDatabaseFactory.

Constructors

UmbracoDatabase(String, ISqlContext, DbProviderFactory, ILogger<UmbracoDatabase>, IBulkSqlInsertProvider, DatabaseSchemaCreatorFactory, Nullable<IEnumerable<IMapper>>)

Initializes a new instance of the UmbracoDatabase class.

Declaration

public UmbracoDatabase(string connectionString, ISqlContext sqlContext, DbProviderFactory provider, ILogger<UmbracoDatabase> logger, IBulkSqlInsertProvider bulkSqlInsertProvider, DatabaseSchemaCreatorFactory databaseSchemaCreatorFactory, IEnumerable<IMapper>? mapperCollection = null)

Parameters

Type	Name	Description
System.String	connectionString
ISqlContext	sqlContext
System.Data.Common.DbProviderFactory	provider
ILogger<UmbracoDatabase>	logger
IBulkSqlInsertProvider	bulkSqlInsertProvider
DatabaseSchemaCreatorFactory	databaseSchemaCreatorFactory
System.Nullable<IEnumerable<IMapper>>	mapperCollection

Remarks

Used by UmbracoDatabaseFactory to create databases.

Also used by DatabaseBuilder for creating databases and installing/upgrading.

Properties

EnableSqlCount

Gets or sets a value indicating whether to count all executed Sql statements.

Declaration

public bool EnableSqlCount { get; set; }

Property Value

Type	Description
System.Boolean

InstanceId

Gets the database instance unique identifier as a string.

Declaration

public string InstanceId { get; }

Property Value

Type	Description
System.String

Remarks

UmbracoDatabase returns the first eight digits of its unique Guid and, in some debug mode, the underlying database connection identifier (if any).

InTransaction

Gets a value indicating whether the database is currently in a transaction.

Declaration

public bool InTransaction { get; }

Property Value

Type	Description
System.Boolean

SqlContext

Gets the Sql context.

Declaration

public ISqlContext SqlContext { get; }

Property Value

Type	Description
ISqlContext

SqlCount

Gets the count of all executed Sql statements.

Declaration

public int SqlCount { get; }

Property Value

Type	Description
System.Int32

Methods

BulkInsertRecords<T>(IEnumerable<T>)

Declaration

public int BulkInsertRecords<T>(IEnumerable<T> records)

Parameters

Type	Name	Description
IEnumerable<T>	records

Returns

Type	Description
System.Int32

Type Parameters

Name	Description
T

ExecuteScalar<T>(Sql)

Declaration

public T ExecuteScalar<T>(Sql sql)

Parameters

Type	Name	Description
Sql	sql

Returns

Type	Description
T

Type Parameters

Name	Description
T

ExecuteScalar<T>(String, CommandType, Object[])

Declaration

public T ExecuteScalar<T>(string sql, CommandType commandType, params object[] args)

Parameters

Type	Name	Description
System.String	sql
System.Data.CommandType	commandType
System.Object[]	args

Returns

Type	Description
T

Type Parameters

Name	Description
T

Remarks

Be nice if handled upstream GH issue

ExecuteScalar<T>(String, Object[])

Declaration

public T ExecuteScalar<T>(string sql, params object[] args)

Parameters

Type	Name	Description
System.String	sql
System.Object[]	args

Returns

Type	Description
T

Type Parameters

Name	Description
T

IsUmbracoInstalled()

Returns true if Umbraco database tables are detected to be installed

Declaration

public bool IsUmbracoInstalled()

Returns

Type	Description
System.Boolean

OnAbortTransaction()

Declaration

protected override void OnAbortTransaction()

OnBeginTransaction()

Declaration

protected override void OnBeginTransaction()

OnCompleteTransaction()

Declaration

protected override void OnCompleteTransaction()

OnConnectionOpened(DbConnection)

Declaration

protected override DbConnection OnConnectionOpened(DbConnection connection)

Parameters

Type	Name	Description
System.Data.Common.DbConnection	connection

Returns

Type	Description
System.Data.Common.DbConnection

OnException(Exception)

Declaration

protected override void OnException(Exception ex)

Parameters

Type	Name	Description
Exception	ex

OnExecutedCommand(DbCommand)

Declaration

protected override void OnExecutedCommand(DbCommand cmd)

Parameters

Type	Name	Description
System.Data.Common.DbCommand	cmd

OnExecutingCommand(DbCommand)

Declaration

protected override void OnExecutingCommand(DbCommand cmd)

Parameters

Type	Name	Description
System.Data.Common.DbCommand	cmd

ValidateSchema()

Returns the DatabaseSchemaResult for the database

Declaration

public DatabaseSchemaResult ValidateSchema()

Returns

Type	Description
DatabaseSchemaResult