View Source

Class UmbracoDatabase

Extends NPoco Database for Umbraco.

Inheritance

System.Object

Namespace: Umbraco.Core.Persistence

Assembly: Umbraco.Core.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 Umbraco.Core.Persistence.UmbracoDatabaseFactory.

Constructors

UmbracoDatabase(String, ISqlContext, DbProviderFactory, ILogger, RetryPolicy, RetryPolicy)

Initializes a new instance of the UmbracoDatabase class.

Declaration

public UmbracoDatabase(string connectionString, ISqlContext sqlContext, DbProviderFactory provider, ILogger logger, RetryPolicy connectionRetryPolicy = null, RetryPolicy commandRetryPolicy = null)

Parameters

Type	Name	Description
System.String	connectionString
ISqlContext	sqlContext
System.Data.Common.DbProviderFactory	provider
ILogger	logger
RetryPolicy	connectionRetryPolicy
RetryPolicy	commandRetryPolicy

Remarks

Used by UmbracoDatabaseFactory to create databases.

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

Properties

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

Methods

CreateCommand(DbConnection, CommandType, String, Object[])

Declaration

public override DbCommand CreateCommand(DbConnection connection, CommandType commandType, string sql, params object[] args)

Parameters

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

Returns

Type	Description
System.Data.Common.DbCommand

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
System.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