Share via

  • Article

IDbConnection Interface

Represents an open connection to a data source, and is implemented by SQL Server Reporting Services data processing extensions that access relational databases.

Namespace:  Microsoft.ReportingServices.DataProcessing
Assemblies:   Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)
  Microsoft.ReportingServices.Interfaces (in Microsoft.ReportingServices.Interfaces.dll)

Syntax

'Declaration
Public Interface IDbConnection _
    Inherits IDisposable, IExtension
'Usage
Dim instance As IDbConnection

public interface IDbConnection : IDisposable, 
    IExtension

public interface class IDbConnection : IDisposable, 
    IExtension

type IDbConnection =  
    interface
        interface IDisposable
        interface IExtension
    end

public interface IDbConnection extends IDisposable, IExtension

The IDbConnection type exposes the following members.

Properties

  Name Description
Public property ConnectionString Gets or sets the string used to open a database.
Public property ConnectionTimeout Gets the time to wait, while trying to establish a connection, before terminating the attempt and generating an error.
Public property LocalizedName Gets the localized name of the extension to be displayed in a user interface. (Inherited from IExtension.)

Top

Methods

  Name Description
Public method BeginTransaction Begins a database transaction.
Public method Close Closes the connection to the database.
Public method CreateCommand Creates and returns a Command object associated with the connection.
Public method Dispose (Inherited from IDisposable.)
Public method Open Initializes a database connection with the settings specified by the ConnectionString property of the provider-specific Connection object.
Public method SetConfiguration Used to pass custom configuration data to an extension. (Inherited from IExtension.)

Top

Remarks

The IDbConnection interface enables you to implement a Connection class, which represents a unique session with a data source. The IDbConnection interface can be used to build a custom data provider. For more information about Connection classes, see Implementing a Connection Class for a Data Processing Extension.

An application does not create an instance of the IDbConnection interface directly, but creates an instance of a class that implements IDbConnection.

Classes that implement IDbConnection must implement all required members, and typically define additional members to add provider-specific functionality. Because IDbConnection inherits from IExtension, you must also implement the IExtension members as part of your Connection class.

When you implement from the IDbConnection interface, you should also implement the following constructors:

Class

Description

PrvConnection()

Initializes a new instance of the PrvConnection class.

PrvConnection(string connectionString)

Initializes a new instance of the PrvConnection class when given a string containing the connection string.