November Happy Hour will be moved to Thursday December 5th.

Class EPiServerDataStoreSection

Class representing the episerver.dataStore configuration element

Inheritance
System.Object
EPiServerDataStoreSection
Namespace: EPiServer.Data.Configuration
Assembly: EPiServer.Data.dll
Version: 9.12.2
Syntax
[ServiceConfiguration(FactoryMember = "Instance")]
public class EPiServerDataStoreSection : ConfigurationSection

Constructors

EPiServerDataStoreSection()

Declaration
public EPiServerDataStoreSection()

Fields

DefaultConnectionStringName

The default name of the connection string used by CMS.

Declaration
public const string DefaultConnectionStringName = "EPiServerDB"
Field Value
Type Description
System.String

Properties

ConfigurationInstance

Gets and sets the current configuration to use

Declaration
[Obsolete("Use ConfigurationSource.Instance = new FileConfigurationSource(value) to replace global configuration or use GlobalConfigurationManager to Load and Save configuration files")]
public static Configuration ConfigurationInstance { get; set; }
Property Value
Type Description
System.Configuration.Configuration

ConnectionStringSection

Gets or sets the connection string section to use.

Declaration
public ConnectionStringsSection ConnectionStringSection { get; set; }
Property Value
Type Description
System.Configuration.ConnectionStringsSection

DatabaseMode

Declaration
public DatabaseMode DatabaseMode { get; set; }
Property Value
Type Description
DatabaseMode

DataSettings

Gets the data settings element.

Declaration
public SiteDataSettingsElement DataSettings { get; }
Property Value
Type Description
SiteDataSettingsElement

The data settings.

DataStoreSettings

Gets the dataStore element

Declaration
public DataStoreElement DataStoreSettings { get; }
Property Value
Type Description
DataStoreElement

EntitySettings

Gets the entity element

Declaration
public EntityElement EntitySettings { get; }
Property Value
Type Description
EntityElement

Instance

Gets the instance of the EPiServerDataStoreSection section

Declaration
public static EPiServerDataStoreSection Instance { get; }
Property Value
Type Description
EPiServerDataStoreSection

Methods

GetCurrentSiteDataSettings()

Gets the data settings.

Declaration
public SiteDataSettingsElement GetCurrentSiteDataSettings()
Returns
Type Description
SiteDataSettingsElement

The data settings

InitializeAllSettings(Configuration, Boolean)

Initialize the section from the config passed

Declaration
public static void InitializeAllSettings(Configuration config, bool modifyConnectionStringNameForTest)
Parameters
Type Name Description
System.Configuration.Configuration config

A System.Configuration.Configuration

System.Boolean modifyConnectionStringNameForTest

Pass true if the connection string name should be modified when running in test mode

InitializeDefault()

Declaration
protected override void InitializeDefault()

InitializeWithDefaults(String)

Declaration
public static void InitializeWithDefaults(string connectionStringName)
Parameters
Type Name Description
System.String connectionStringName

ResolveConnectionStringSettings()

Resolves connection strings

Declaration
public virtual ConnectionStringSettings ResolveConnectionStringSettings()
Returns
Type Description
System.Configuration.ConnectionStringSettings

Connection string

Exceptions
Type Condition
System.Configuration.ConfigurationErrorsException

Thrown if connection string was not found

Extension Methods