Enterprise Library Data Access Application Block  7.0-rc1
The Data Access Application Block abstracts the actual database you are using, and exposes a collection of methods that make it easy to access that database and to perform common tasks.
Public Member Functions | Protected Member Functions | Properties | List of all members
Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension Class Reference

Base class to help build database-specific configurations extensions for DataConfigurationSourceBuilderExtensions. More...

Inheritance diagram for Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension:
Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.IDatabaseConfigurationProperties Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.IDatabaseConfigurationProviderEntry Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.IDatabaseConfiguration

Public Member Functions

IDatabaseConfigurationProperties ForDatabaseNamed (string databaseName)
 Configure a named database. More...
 
IDatabaseConfigurationProperties AsDefault ()
 Set this database as the default one in the configuration. More...
 
IDatabaseConfigurationProperties WithConnectionString (string connectionString)
 Connection string to use for this data source. More...
 
IDatabaseConfigurationProperties WithConnectionString (DbConnectionStringBuilder builder)
 Connection string to use for this data source More...
 

Protected Member Functions

 DatabaseConfigurationExtension (IDatabaseConfigurationProviders context)
 Initializes a new DatabaseConfigurationExtension with a IDatabaseConfigurationProviders context. More...
 

Properties

IDatabaseConfigurationProviders ThatIs [get]
 Specify the type of database. More...
 
ConnectionStringSettings ConnectionString [get]
 The connection string in progress. More...
 
IConfigurationSourceBuilder Builder [get]
 Context of the current builder for the extension. More...
 

Detailed Description

Base class to help build database-specific configurations extensions for DataConfigurationSourceBuilderExtensions.

Constructor & Destructor Documentation

◆ DatabaseConfigurationExtension()

Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.DatabaseConfigurationExtension ( IDatabaseConfigurationProviders  context)
protected

Initializes a new DatabaseConfigurationExtension with a IDatabaseConfigurationProviders context.

This class supports extending the data configuration section's fluent-style API. New database providers can inherit from this class to gain access to the current ConnectionString and underlying Builder properties.

This class also implements the IDatabaseConfigurationProperties to enable continuation of the data fluent interface.

Parameters
context

Member Function Documentation

◆ AsDefault()

IDatabaseConfigurationProperties Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.AsDefault ( )

Set this database as the default one in the configuration.

Returns

Implements Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.IDatabaseConfigurationProperties.

◆ ForDatabaseNamed()

IDatabaseConfigurationProperties Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.ForDatabaseNamed ( string  databaseName)

Configure a named database.

Parameters
databaseNameName of database to configure
Returns

Implements Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.IDatabaseConfiguration.

◆ WithConnectionString() [1/2]

IDatabaseConfigurationProperties Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.WithConnectionString ( DbConnectionStringBuilder  builder)

Connection string to use for this data source

Parameters
builderThe connection string builder for the database provider
Returns
Exceptions
ArgumentNullExceptionbuilder is null.

◆ WithConnectionString() [2/2]

IDatabaseConfigurationProperties Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.WithConnectionString ( string  connectionString)

Connection string to use for this data source.

Parameters
connectionStringThe connection string.
Returns
This instance
Exceptions
ArgumentExceptionconnectionString is null or empty.
See also
ConnectionStringSettings, DbConnectionStringBuilder

Property Documentation

◆ Builder

IConfigurationSourceBuilder Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.Builder
get

Context of the current builder for the extension.

◆ ConnectionString

ConnectionStringSettings Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.ConnectionString
get

The connection string in progress.

◆ ThatIs

IDatabaseConfigurationProviders Microsoft.Practices.EnterpriseLibrary.Data.Configuration.Fluent.DatabaseConfigurationExtension.ThatIs
get

Specify the type of database.

The documentation for this class was generated from the following file: