Class SchemaUpdaterBase

This class is intended to be used internally by EPiServer. We do not support any backward compatibility on this.

Inheritance

System.Object

SchemaUpdaterBase

AuxiliarySchemaUpdaterBase

CommerceDatabaseSchemaUpdater

Implements

EPiServer.Data.SchemaUpdates.ISchemaUpdater

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Commerce.Internal

Assembly: EPiServer.Business.Commerce.dll

Version: 12.17.2

Syntax

public abstract class SchemaUpdaterBase : ISchemaUpdater

Constructors

SchemaUpdaterBase(IDatabaseExecutorFactory, ScriptExecutor, IConnectionStringHandler)

Declaration

protected SchemaUpdaterBase(IDatabaseExecutorFactory databaseExecutorFactory, ScriptExecutor scriptExecutor, IConnectionStringHandler connectionStringHandler)

Parameters

Type	Name	Description
EPiServer.Data.Providers.IDatabaseExecutorFactory	databaseExecutorFactory
EPiServer.Data.SchemaUpdates.ScriptExecutor	scriptExecutor
IConnectionStringHandler	connectionStringHandler

Properties

ZipFileName

Name of the embedded zip containing the DB upgrade scripts.

Declaration

protected abstract string ZipFileName { get; }

Property Value

Type	Description
System.String

Methods

GetCommerceConnection(IEnumerable<ConnectionStringOptions>)

Gets the EPiServer.Data.ConnectionStringOptions of the Commerce database from the input collection.

Declaration

protected ConnectionStringOptions GetCommerceConnection(IEnumerable<ConnectionStringOptions> connectionStringOptions)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<EPiServer.Data.ConnectionStringOptions>	connectionStringOptions	All configured connections.

Returns

Type	Description
EPiServer.Data.ConnectionStringOptions	The commerce connection if found, otherwise null.

GetConnection(IEnumerable<ConnectionStringOptions>, String)

Gets the EPiServer.Data.ConnectionStringOptions of with the specified name.

Declaration

protected ConnectionStringOptions GetConnection(IEnumerable<ConnectionStringOptions> connectionStringOptions, string connectionName)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<EPiServer.Data.ConnectionStringOptions>	connectionStringOptions	All configured connections.
System.String	connectionName	The connection string name to match.

Returns

Type	Description
EPiServer.Data.ConnectionStringOptions	The matching connection if found, otherwise null.

GetCurrentCommerceDatabaseVersion(IEnumerable<ConnectionStringOptions>)

Gets the current database version of the commerce database.

Declaration

protected Version GetCurrentCommerceDatabaseVersion(IEnumerable<ConnectionStringOptions> connectionStringOptions)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<EPiServer.Data.ConnectionStringOptions>	connectionStringOptions	All configured connections.

Returns

Type	Description
System.Version	The current database version.

GetRequiredCommerceDatabaseVersion()

Gets the commerce database version required to run this assembly version.

Declaration

protected Version GetRequiredCommerceDatabaseVersion()

Returns

Type	Description
System.Version	The required commerce database version.

GetStatus(IEnumerable<ConnectionStringOptions>)

Declaration

public abstract SchemaStatus GetStatus(IEnumerable<ConnectionStringOptions> connectionStringOptions)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<EPiServer.Data.ConnectionStringOptions>	connectionStringOptions

Returns

Type	Description
EPiServer.Data.SchemaUpdates.SchemaStatus

Update(ConnectionStringOptions)

Declaration

public virtual void Update(ConnectionStringOptions connectionStringOptions)

Parameters

Type	Name	Description
EPiServer.Data.ConnectionStringOptions	connectionStringOptions

Implements

EPiServer.Data.SchemaUpdates.ISchemaUpdater