Interface IDataExtension

Defines an interface for data extension objects, including properties for connection settings and methods for data retrieval and schema access.

Namespace: BoldReports.RDL.Data

Assembly: BoldReports.Web.dll

Syntax

public interface IDataExtension

Properties

CommandText

Gets or sets the command text or query to be executed against the data source.

Declaration

string CommandText { get; set; }

Property Value

Type	Description
System.String	A System.String representing the command text or query.

ConnectionString

Gets or sets the connection string for the data source.

Declaration

string ConnectionString { get; set; }

Property Value

Type	Description
System.String	A System.String representing the connection string for accessing the data source.

ConnectionTimeout

Gets or sets the timeout duration for the connection in seconds.

Declaration

int ConnectionTimeout { get; set; }

Property Value

Type	Description
System.Int32	An System.Int32 representing the connection timeout in seconds.

DataProvider

Gets or sets the data provider used for the connection.

Declaration

string DataProvider { get; set; }

Property Value

Type	Description
System.String	A System.String representing the name of the data provider.

Impersonate

Gets or sets the identity to impersonate during connection.

Declaration

string Impersonate { get; set; }

Property Value

Type	Description
System.String	A System.String representing the impersonated user identity.

IntegratedSecurity

Gets or sets a value indicating whether integrated security is used for the connection.

Declaration

bool IntegratedSecurity { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean that is true if integrated security is enabled; otherwise, false.

Password

Gets or sets the password used for authenticating the connection.

Declaration

string Password { get; set; }

Property Value

Type	Description
System.String	A System.String representing the password for connection authentication.

QueryParameters

Gets or sets the collection of query parameters for executing the command.

Declaration

Dictionary<string, object> QueryParameters { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A containing the query parameters.

Username

Gets or sets the username used for authenticating the connection.

Declaration

string Username { get; set; }

Property Value

Type	Description
System.String	A System.String representing the username for connection authentication.

Methods

GetData()

Retrieves data from the data source.

Declaration

object GetData()

Returns

Type	Description
System.Object	An System.Object containing the retrieved data.

GetSchemaData()

Retrieves schema data from the data source.

Declaration

object GetSchemaData()

Returns

Type	Description
System.Object	An System.Object containing the schema data.

ValidateConnection(String)

Validates the connection using the specified connection string.

Declaration

bool ValidateConnection(string connectionString)

Parameters

Type	Name	Description
System.String	connectionString	The connection string to validate.

Returns

Type	Description
System.Boolean	A System.Boolean indicating whether the connection is valid.