AbstractDatabaseAbstracter Class

Base class for all database abstracters. It implements the following functions:

SQL request parser - using the standard parameter format (see the format description)
SQL request execution - using either a SqlStatement or a plain text SQL request
Transaction management - by default, each SQL request is executed against a new connection from the pool; once BeginTransaction is called, all request will be launched on the same connection, inside a transaction, until either Commit or Rollback is called
Parameter creation helper - the various CreateAndAddParameter(IDbCommand, DbType, String, Object) methods create a parameter according to the provider and add it to the provided IDbCommande

When you derive from this class, you must implement the following members:

ExplainException (ExplainException(DbException, String, String)) - SQL exceptions are completely provider dependent in ADO.NET
OpenConnection (OpenConnection) - You only have to create the connection object from the provider (for example SqlConnection)
CreateSqlStatement (CreateSqlStatement) - You must create a class derived from SqlStatement (SqlStatement) and use it here

Inheritance Hierarchy

SystemObject
Activsoft.Engine.DbAbstractDatabaseAbstracter
More...

Namespace: Activsoft.Engine.Db
Assembly: Activsoft.Engine (in Activsoft.Engine.dll) Version: 6.0.0.0

Syntax

C++

Copy

public abstract class AbstractDatabaseAbstracter : IDatabaseAbstracter, 
	IDisposable

Public MustInherit Class AbstractDatabaseAbstracter
	Implements IDatabaseAbstracter, IDisposable

public ref class AbstractDatabaseAbstracter abstract : IDatabaseAbstracter, 
	IDisposable

[<AbstractClassAttribute>]
type AbstractDatabaseAbstracter =  
    class
        interface IDatabaseAbstracter
        interface IDisposable
    end

The AbstractDatabaseAbstracter type exposes the following members.

Constructors

	Name	Description
	AbstractDatabaseAbstracter	Initializes a new instance of the AbstractDatabaseAbstracter class

Top

Methods

	Name	Description
	BeginTransaction	Puts the abstracter in transaction mode using the Read Committed isolation level. From this point, and until a call to Commit or Rollback, all SQL requests will be executed on the same connection and transaction.
	BeginTransaction(IsolationLevel)	Puts the abstracter in transaction mode using the given isolation level. From this point, and until a call to Commit or Rollback, all SQL requests will be executed on the same connection and transaction.
	CloseCommand	Closes a IDbCommand and if the abstracter is not in transaction mode, its underlying connection.
	CloseReader	Closes a IDataReader and if the abstracter is not in transaction mode, its underlying connection.
	Commit	If the abstracter is in transaction mode, commits the transaction, closes the connection, and exits the transaction mode. If the abstracter is not in transaction mode, does nothing.
	CreateAndAddParameter(IDbCommand, DbType, String, Object)	Creates a SQL parameter and attaches it to the given IDbCommand.
	CreateAndAddParameter(IDbCommand, DbType, String, ParameterDirection, Object)	Creates a SQL parameter and attaches it to the given IDbCommand.
	CreateAndAddParameter(IDbCommand, DbType, String, Int32, Object)	Creates a SQL parameter and attaches it to the given IDbCommand.
	CreateAndAddParameter(IDbCommand, DbType, String, Int32, ParameterDirection, Object)	Creates a SQL parameter and attaches it to the given IDbCommand.
	CreateSqlStatement	Creates a SqlStatement customized for the target database. To implement this method, you must derive from the SqlStatement class and return an instance of your class here.
	Dispose	Cleans up all resources attached to the abstracter. If the abstracter is in transaction mode, it rolls back the transaction.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExecuteNonQuery(IDbCommand)	Executes a IDbCommand not returning data (basically, anything but a SELECT, although postgresql, for example, can return data from INSERT / UPDATE / DELETE statements).
	ExecuteNonQuery(String)	Executes a SQL request not returning data (basically, anything but a SELECT, although postgresql, for example, can return data from INSERT / UPDATE / DELETE statements).
	ExecuteNonQuery(Config, SqlStatement)	Executes a SqlStatement not returning data (basically, anything but a SELECT, although postgresql, for example, can return data from INSERT / UPDATE / DELETE statements). Exclusion zones that end up being excluded are replaced by an empty string.
	ExecuteNonQuery(SqlStatement, String)	Executes a SqlStatement not returning data (basically, anything but a SELECT). Exclusion zones that end up being excluded are replaced by replaceEmptyZone. Since no Config object is passed to the method, the parameters values are not modified.
	ExecuteNonQuery(Config, SqlStatement, String)	Executes a SqlStatement not returning data (basically, anything but a SELECT, although postgresql, for example, can return data from INSERT / UPDATE / DELETE statements). Parameter values are read from the Config object. Exclusion zones that end up being excluded are replaced by replaceEmptyZone.
	ExecuteReader(IDbCommand)	Executes a IDbCommand returning data.
	ExecuteReader(String)	Executes a SQL request returning data.
	ExecuteReader(Config, SqlStatement)	Executes a SqlStatement returning data. Exclusion zones that end up being excluded are replaced by an empty string.
	ExecuteReader(Config, SqlStatement, String)	Executes a SqlStatement returning data. Parameter values are read from the Config object. Exclusion zones that end up being excluded are replaced by replaceEmptyZone.
	ExplainException	Database errors are not consistent across providers; error codes and error messages are always provider dependent. If you derive from this class, you must implement this method by casting the DbException to the provider specific exception and extracting the error code number and message.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetCommand	Creates a IDbCommand on the current connection.
	GetCommand(Boolean)	Creates a new IDbCommand and attaches it to a database connection. If the abstracter is in transaction mode, and openConnection is false, the connection used is the transaction connection. Else, a new connection is used.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the type of the current instance. (Inherited from Object.)
	InnerGetCommand	Creates a IDbCommand with the given SQL text, the default command timeout, and either using the current connection if the abstracter is in a transaction or a new one if it is not in a transaction
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OpenConnection	Creates and opens a connection on the database.
	Parse(String, String, Int32)	Parses a list of SqlStatement from a semicolon separated string, a prefix and a starting number for the numeric parameters (see the format description). It uses the default formatters and transformers.
	Parse(String, String, Int32, DictionaryString, IFormatterFactory)	Parses a list of SqlStatement from a semicolon separated string, a prefix and a starting number for the numeric parameters (see the format description) and a custom list of formatters. It uses the default transformers.
	Parse(String, String, Int32, DictionaryString, IFormatterFactory, DictionaryString, KeyValuePairSqlType, IFormatterFactory)	Parses a list of SqlStatement from a semicolon separated string, a prefix and a starting number for the numeric parameters (see the format description) and a custom list of formatters. It uses the default transformers.
	Rollback	If the abstracter is in transaction mode, rolls back the transaction, closes the connection, and exits the transaction mode. If the abstracter is not in transaction mode, does nothing.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	commandTimeOut	The default command time out; this is the time .NET will wait for a SQL request to return data
	connectionString	The connection string to be used by this abstracter.
	currentConnection	If the abstracter is in transaction mode, it executes all its requests on this connection on which the transaction is open
	currentTransaction	If the abstracter is in transaction mode, the current transaction
	inTransaction	Whether the abstracter is in transaction mode

Top

Properties

	Name	Description
	CommandTimeout	Gets or sets the default command time out.
	ConnectionString	Gets or sets the connection string used by this abstracter. By default, the connection string is created by the configuration system, but you can force a custom connection string using this property.
	Type	A string describing the underlying database.

Top

Reference

Activsoft.Engine.Db Namespace

Inheritance Hierarchy

SystemObject
  Activsoft.Engine.DbAbstractDatabaseAbstracter
    Activsoft.Engine.Db.AccessAccessDatabaseAbstracter
    Activsoft.Engine.Db.MySqlMySqlDatabaseAbstracter
    Activsoft.Engine.Db.OracleOracleDatabaseAbstracter
    Activsoft.Engine.Db.PostgresqlPostgresqlDatabaseAbstracter
    Activsoft.Engine.Db.SQLiteSQLiteDatabaseAbstracter
    Activsoft.Engine.Db.SqlServerSqlServerDatabaseAbstracter
    Activsoft.Engine.Db.SqlServerCompactSqlServerCompactDatabaseAbstracter