EntityConnection EntityConnection EntityConnection EntityConnection Class


Contains a reference to a conceptual model and a data source connection. This class cannot be inherited.

public ref class EntityConnection sealed : System::Data::Common::DbConnection
public sealed class EntityConnection : System.Data.Common.DbConnection
type EntityConnection = class
    inherit DbConnection
Public NotInheritable Class EntityConnection
Inherits DbConnection


To avoid inadvertently putting objects such as System.Data.Common.CommandTrees and ObjectContext out of sync with their metadata, EntityConnection must lock its metadata. No changes to the connection string are allowed after the metadata is locked. The following are two scenarios in which metadata is locked:

When metadata is loaded, the EntityConnection verifies that the conceptual model, the storage model, and the mapping file are all present.

For code examples, see Working with EntityClient.


EntityConnection() EntityConnection() EntityConnection() EntityConnection()

Initializes a new instance of the EntityConnection class.

EntityConnection(MetadataWorkspace, DbConnection) EntityConnection(MetadataWorkspace, DbConnection) EntityConnection(MetadataWorkspace, DbConnection) EntityConnection(MetadataWorkspace, DbConnection)

Initializes a new instance of the EntityConnection class with a specified MetadataWorkspace and DbConnection.

EntityConnection(String) EntityConnection(String) EntityConnection(String) EntityConnection(String)

Initializes a new instance of the EntityConnection class, based on the connection string.


CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Gets a value indicating whether the component can raise an event.

(Inherited from Component)
ConnectionString ConnectionString ConnectionString ConnectionString

Gets or sets the EntityConnection connection string.

ConnectionTimeout ConnectionTimeout ConnectionTimeout ConnectionTimeout

Gets the number of seconds to wait when attempting to establish a connection before ending the attempt and generating an error.

Container Container Container Container

Gets the IContainer that contains the Component.

(Inherited from Component)
Database Database Database Database

Gets the name of the current database, or the database that will be used after a connection is opened.

DataSource DataSource DataSource DataSource

Gets the name or network address of the data source to connect to.

DbProviderFactory DbProviderFactory DbProviderFactory DbProviderFactory

Gets the DbProviderFactory for this DbConnection.

(Inherited from DbConnection)
DesignMode DesignMode DesignMode DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events Events Events Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ServerVersion ServerVersion ServerVersion ServerVersion

Gets a string that contains the version of the data source to which the client is connected.

Site Site Site Site

Gets or sets the ISite of the Component.

(Inherited from Component)
State State State State

Gets the ConnectionState property of the underlying provider if the EntityConnection is open. Otherwise, returns Closed.

StoreConnection StoreConnection StoreConnection StoreConnection

Provides access to the underlying data source connection that is used by the EntityConnection object.


BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel)

Starts a database transaction.

(Inherited from DbConnection)
BeginTransaction() BeginTransaction() BeginTransaction() BeginTransaction()

Begins a transaction by using the underlying provider.

BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel)

Begins a transaction with the specified isolation level by using the underlying provider.

ChangeDatabase(String) ChangeDatabase(String) ChangeDatabase(String) ChangeDatabase(String)

Not supported.

Close() Close() Close() Close()

Closes the connection to the database.

CreateCommand() CreateCommand() CreateCommand() CreateCommand()

Creates a new instance of an EntityCommand, with the Connection set to this EntityConnection.

CreateDbCommand() CreateDbCommand() CreateDbCommand() CreateDbCommand()

Creates and returns a DbCommand object associated with the current connection.

(Inherited from DbConnection)
CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose() Inherited from DbConnection
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Inherited from DbConnection
EnlistTransaction(Transaction) EnlistTransaction(Transaction) EnlistTransaction(Transaction) EnlistTransaction(Transaction)

Enlists this EntityConnection in the specified transaction.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetMetadataWorkspace() GetMetadataWorkspace() GetMetadataWorkspace() GetMetadataWorkspace()

Returns the MetadataWorkspace associated with this EntityConnection.

GetSchema() GetSchema() GetSchema() GetSchema()

Returns schema information for the data source of this DbConnection.

(Inherited from DbConnection)
GetSchema(String) GetSchema(String) GetSchema(String) GetSchema(String)

Returns schema information for the data source of this DbConnection using the specified string for the schema name.

(Inherited from DbConnection)
GetSchema(String, String[]) GetSchema(String, String[]) GetSchema(String, String[]) GetSchema(String, String[])

Returns schema information for the data source of this DbConnection using the specified string for the schema name and the specified string array for the restriction values.

(Inherited from DbConnection)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs)

Raises the StateChange event.

(Inherited from DbConnection)
Open() Open() Open() Open()

Establishes a connection to the data source by calling the underlying data provider's Open method.

OpenAsync() OpenAsync() OpenAsync() OpenAsync()

An asynchronous version of Open(), which opens a database connection with the settings specified by the ConnectionString. This method invokes the virtual method OpenAsync(CancellationToken) with CancellationToken.None.

(Inherited from DbConnection)
OpenAsync(CancellationToken) OpenAsync(CancellationToken) OpenAsync(CancellationToken) OpenAsync(CancellationToken)

This is the asynchronous version of Open(). Providers should override with an appropriate implementation. The cancellation token can optionally be honored.

The default implementation invokes the synchronous Open() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Open will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbConnection object until the returned Task is complete.

(Inherited from DbConnection)
ToString() ToString() ToString() ToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.

(Inherited from Component)


Disposed Disposed Disposed Disposed

Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)
StateChange StateChange StateChange StateChange

Occurs when the state of the event changes.

(Inherited from DbConnection)

Explicit Interface Implementations

IDbConnection.BeginTransaction() IDbConnection.BeginTransaction() IDbConnection.BeginTransaction() IDbConnection.BeginTransaction()

Begins a database transaction.

(Inherited from DbConnection)
IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel)

Begins a database transaction with the specified IsolationLevel value.

(Inherited from DbConnection)
IDbConnection.CreateCommand() IDbConnection.CreateCommand() IDbConnection.CreateCommand() IDbConnection.CreateCommand()

Creates and returns a DbCommand object that is associated with the current connection.

(Inherited from DbConnection)

Applies to

See also