Interface IDatabaseConnector

Provides an interface to connecto to a database server.

Namespace: Paradigm.ORM.Data.Database
Assembly: Paradigm.ORM.Data.dll
Syntax
public interface IDatabaseConnector : IDisposable

Properties

| Improve this Doc View Source

Configuration

Gets the database configuration.

Declaration
IDatabaseConfiguration Configuration { get; }
Property Value
Type Description
IDatabaseConfiguration

The configuration.
| Improve this Doc View Source

ConnectionTimeout

Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.

Declaration
int ConnectionTimeout { get; }
Property Value
Type Description
System.Int32

The time (in seconds) to wait for a connection to open. The default value is 15 seconds.

Methods

| Improve this Doc View Source

Close()

Closes a previously opened connection to a database.

Declaration
void Close()
| Improve this Doc View Source

CloseAsync()

Closes a previously opened connection to a database.

Declaration
Task CloseAsync()
Returns
Type Description
Task
| Improve this Doc View Source

CreateCommand()

Creates a new database command.

Declaration
IDatabaseCommand CreateCommand()
Returns
Type Description
IDatabaseCommand

A new command.
| Improve this Doc View Source

CreateTransaction()

Creates a new database transaction.

Declaration
IDatabaseTransaction CreateTransaction()
Returns
Type Description
IDatabaseTransaction

A new transaction
| Improve this Doc View Source

CreateTransaction(IsolationLevel)

Creates a new database transaction.

Declaration
IDatabaseTransaction CreateTransaction(IsolationLevel isolationLevel)
Parameters
Type Name Description
IsolationLevel isolationLevel

Specifies the transaction isolation level.
Returns
Type Description
IDatabaseTransaction

A new transaction.
| Improve this Doc View Source

GetCommandBuilderFactory()

Gets a command builder factory.

Declaration
ICommandBuilderFactory GetCommandBuilderFactory()
Returns
Type Description
ICommandBuilderFactory

The command builder factory related to this database type.
Remarks

The command builder factory creates command builders for standard crud actions over a given data type.

| Improve this Doc View Source

GetCommandFormatProvider()

Get a command text format provider.

Declaration
ICommandFormatProvider GetCommandFormatProvider()
Returns
Type Description
ICommandFormatProvider

The command formatted realted to this database type.
Remarks

The command formatter gives basic functionality to format sql queries for each database type.

| Improve this Doc View Source

GetDbStringTypeConverter()

Gets a string type converter.

Declaration
IDbStringTypeConverter GetDbStringTypeConverter()
Returns
Type Description
IDbStringTypeConverter

A database type converter.
Remarks

This converter can convert back and forth from a database type in string format, to a .NET type.

Examples

For the string "int" the converter will return . For the string "text" the converter will return .

| Improve this Doc View Source

GetDbTypeValueRangeProvider()

Gets the database type size provider.

Declaration
IDbTypeValueRangeProvider GetDbTypeValueRangeProvider()
Returns
Type Description
IDbTypeValueRangeProvider
Remarks

A database type size provider retrieves minimum and maximum values for regular sql types like tinyint, smallint, int, etc.

| Improve this Doc View Source

GetSchemaProvider()

Gets a database schema provider.

Declaration
ISchemaProvider GetSchemaProvider()
Returns
Type Description
ISchemaProvider

A schema provider related to this database connection.
Remarks

The schema provider, allows to retrieve schema information about database objects like tables, views, stored procedures, etc.

| Improve this Doc View Source

GetValueConverter()

Gets the value converter.

Declaration
IValueConverter GetValueConverter()
Returns
Type Description
IValueConverter

A value converter.
Remarks

This converter can convert from database objects to specific .net types.

| Improve this Doc View Source

Initialize(String)

Initializes the connection against the database.

Declaration
void Initialize(string connectionString = null)
Parameters
Type Name Description
System.String connectionString

A connection string containing information to connect to a given database.
| Improve this Doc View Source

IsOpen()

Indicates if the connection is currently opened.

Declaration
bool IsOpen()
Returns
Type Description
System.Boolean

True if the connection is opened, false otherwise.
| Improve this Doc View Source

Open()

Opens the conection to a database.

Declaration
void Open()
| Improve this Doc View Source

OpenAsync()

Opens the conection to a database.

Declaration
Task OpenAsync()
Returns
Type Description
Task

Extension Methods