Table of Contents

Class FirebirdConnectionProvider

Namespace
DevExpress.Xpo.DB
Assembly
DevExpress.Xpo.v24.1.dll

Implements data-aware operations for working with a Firebird database.

public class FirebirdConnectionProvider : ConnectionProviderSql
Inheritance
FirebirdConnectionProvider

Constructors

FirebirdConnectionProvider(IDbConnection, AutoCreateOption)

Initializes a new instance of the FirebirdConnectionProvider class with the specified settings.

public FirebirdConnectionProvider(IDbConnection connection, AutoCreateOption autoCreateOption)

Parameters

connection IDbConnection

An object implementing the IDbConnection interface that represents an open connection to a data source.

autoCreateOption AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations should be performed when storage is accessed for the first time. This parameter is used to initialize the IDataStore.AutoCreateOption property.

Fields

DefaultCharacterSet

Specifies the default character set for the current FirebirdConnectionProvider instance. When this field is not initialized (or set to null), the GlobalDefaultCharacterSet value is used. When both values are not specified, the UTF8 character set is used.

public string DefaultCharacterSet

Field Value

string

GlobalDefaultCharacterSet

Specifies the default character set for all FirebirdConnectionProvider instances. When this field is not initialized (or set to null), the UTF8 character set is used. To specify the character set for a specific FirebirdConnectionProvider instance, use the DefaultCharacterSet field instead.

public static string GlobalDefaultCharacterSet

Field Value

string

MaximumStringSize

This member supports the internal infrastructure and is not intended to be used directly from your code.

public const int MaximumStringSize = 4000

Field Value

int

XpoProviderTypeString

Gets the name of the current connection provider. This name is used internally when generating a connection string via the FirebirdConnectionProvider.GetConnectionString method.

public const string XpoProviderTypeString = "Firebird"

Field Value

string

Properties

CreateForeignKeyTemplate 

protected override string CreateForeignKeyTemplate { get; }

Property Value

string

DbTypeMapper 

protected override DbTypeMapperBase DbTypeMapper { get; }

Property Value

DbTypeMapperBase

NativeSkipTakeSupported

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override bool NativeSkipTakeSupported { get; }

Property Value

bool

SupportNamedParameters

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override bool SupportNamedParameters { get; }

Property Value

bool

Methods

CollectTablesToCreate(ICollection)

This method supports the internal infrastructure and is not intended to be called directly from your code.

public override ICollection CollectTablesToCreate(ICollection tables)

Parameters

tables ICollection

Returns

ICollection

CommandBuilderDeriveParameters(IDbCommand) 

protected override void CommandBuilderDeriveParameters(IDbCommand command)

Parameters

command IDbCommand

ConvertToDbParameter(object, TypeCode) 

protected override object ConvertToDbParameter(object clientValue, TypeCode clientValueTypeCode)

Parameters

clientValue object
clientValueTypeCode TypeCode

Returns

object

CreateConnection() 

protected override IDbConnection CreateConnection()

Returns

IDbConnection

CreateConnection(string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public static IDbConnection CreateConnection(string connectionString)

Parameters

connectionString string

Returns

IDbConnection

CreateDataBase() 

protected override void CreateDataBase()

CreateIndex(DBTable, DBIndex)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override void CreateIndex(DBTable table, DBIndex index)

Parameters

table DBTable
index DBIndex

CreateProviderFromConnection(IDbConnection, AutoCreateOption)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public static IDataStore CreateProviderFromConnection(IDbConnection connection, AutoCreateOption autoCreateOption)

Parameters

connection IDbConnection
autoCreateOption AutoCreateOption

Returns

IDataStore

CreateProviderFromString(string, AutoCreateOption, out IDisposable[])

This member supports the internal infrastructure and is not intended to be used directly from your code.

public static IDataStore CreateProviderFromString(string connectionString, AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connectionString string
autoCreateOption AutoCreateOption
objectsToDisposeOnDisconnect IDisposable[]

Returns

IDataStore

CreateTable(DBTable)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override void CreateTable(DBTable table)

Parameters

table DBTable

ExecuteSprocParametrized(string, params OperandValue[]) 

protected override SelectedData ExecuteSprocParametrized(string sprocName, params OperandValue[] parameters)

Parameters

sprocName string
parameters OperandValue[]

Returns

SelectedData

ExecuteSprocParametrizedAsync(AsyncOperationIdentifier, CancellationToken, string, params OperandValue[]) 

protected override Task<SelectedData> ExecuteSprocParametrizedAsync(AsyncOperationIdentifier asyncOperationId, CancellationToken cancellationToken, string sprocName, params OperandValue[] parameters)

Parameters

asyncOperationId AsyncOperationIdentifier
cancellationToken CancellationToken
sprocName string
parameters OperandValue[]

Returns

Task<SelectedData>

FormatBinary(BinaryOperatorType, string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatBinary(BinaryOperatorType operatorType, string leftOperand, string rightOperand)

Parameters

operatorType BinaryOperatorType
leftOperand string
rightOperand string

Returns

string

FormatColumn(string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatColumn(string columnName)

Parameters

columnName string

Returns

string

FormatColumn(string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatColumn(string columnName, string tableAlias)

Parameters

columnName string
tableAlias string

Returns

string

FormatConstant(object) 

protected string FormatConstant(object value)

Parameters

value object

Returns

string

FormatConstraint(string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatConstraint(string constraintName)

Parameters

constraintName string

Returns

string

FormatDelete(string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatDelete(string tableName, string whereClause)

Parameters

tableName string
whereClause string

Returns

string

FormatFunction(FunctionOperatorType, params string[])

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatFunction(FunctionOperatorType operatorType, params string[] operands)

Parameters

operatorType FunctionOperatorType
operands string[]

Returns

string

FormatFunction(ProcessParameter, FunctionOperatorType, params object[])

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatFunction(ProcessParameter processParameter, FunctionOperatorType operatorType, params object[] operands)

Parameters

processParameter ProcessParameter
operatorType FunctionOperatorType
operands object[]

Returns

string

FormatInsert(string, string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatInsert(string tableName, string fields, string values)

Parameters

tableName string
fields string
values string

Returns

string

FormatInsertDefaultValues(string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatInsertDefaultValues(string tableName)

Parameters

tableName string

Returns

string

FormatOrder(string, SortingDirection)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatOrder(string sortProperty, SortingDirection direction)

Parameters

sortProperty string
direction SortingDirection

Returns

string

FormatSelect(string, string, string, string, string, string, int, int)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatSelect(string selectedPropertiesSql, string fromSql, string whereSql, string orderBySql, string groupBySql, string havingSql, int skipSelectedRecords, int topSelectedRecords)

Parameters

selectedPropertiesSql string
fromSql string
whereSql string
orderBySql string
groupBySql string
havingSql string
skipSelectedRecords int
topSelectedRecords int

Returns

string

FormatString(object) 

protected string FormatString(object value)

Parameters

value object

Returns

string

FormatTable(string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatTable(string schema, string tableName)

Parameters

schema string
tableName string

Returns

string

FormatTable(string, string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatTable(string schema, string tableName, string tableAlias)

Parameters

schema string
tableName string
tableAlias string

Returns

string

FormatUpdate(string, string, string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override string FormatUpdate(string tableName, string sets, string whereClause)

Parameters

tableName string
sets string
whereClause string

Returns

string

GetConnectionString(string, int, string, string, string)

Returns a connection string used to open a specified Firebird database using provided login credentials.

public static string GetConnectionString(string server, int port, string userId, string password, string database)

Parameters

server string

A string that specifies the server’s name.

port int

An integer that specifies the server’s port number.

userId string

A string that specifies a user name.

password string

A string that specifies a password.

database string

A string that specifies the database name.

Returns

string

A connection string.

GetConnectionString(string, string, string)

Returns a connection string used to open a specified Firebird database using provided login credentials.

public static string GetConnectionString(string userId, string password, string database)

Parameters

userId string

A string that specifies a user name.

password string

A string that specifies a password.

database string

A string that specifies the database name.

Returns

string

A connection string.

GetConnectionString(string, string, string, string)

Returns a connection string used to open a specified Firebird database using provided login credentials.

public static string GetConnectionString(string server, string userId, string password, string database)

Parameters

server string

A string that specifies the server’s name

userId string

A string that specifies a user name.

password string

A string that specifies a password.

database string

A string that specifies a database name.

Returns

string

A connection string.

GetConnectionString(string, string, string, string, FirebirdServerType, string)

Returns a connection string used to open a specified Firebird database using provided login credentials.

public static string GetConnectionString(string server, string userId, string password, string database, FirebirdServerType serverType, string charset)

Parameters

server string

A string that specifies the server’s name

userId string

A string that specifies a user name.

password string

A string that specifies a password.

database string

A string that specifies the database name.

serverType FirebirdServerType

A string that specifies the server type.

charset string

A string that specifies the database’s character set.

Returns

string

A connection string.

GetConnectionString(string, string, string, string, string)

Returns a connection string used to open a specified Firebird database using provided login credentials.

public static string GetConnectionString(string server, string userId, string password, string database, string charset)

Parameters

server string

A string that specifies the server’s name.

userId string

A string that specifies a user name.

password string

A string that specifies a password.

database string

A string that specifies the database name.

charset string

A string that specifies the database’s character set.

Returns

string

A connection string.

GetIdentity(InsertStatement, TaggedParametersHolder) 

protected override long GetIdentity(InsertStatement root, TaggedParametersHolder identitiesByTag)

Parameters

root InsertStatement
identitiesByTag TaggedParametersHolder

Returns

long

GetIdentityAsync(InsertStatement, TaggedParametersHolder, AsyncOperationIdentifier, CancellationToken) 

protected override Task<long> GetIdentityAsync(InsertStatement root, TaggedParametersHolder identitiesByTag, AsyncOperationIdentifier asyncOperationId, CancellationToken cancellationToken)

Parameters

root InsertStatement
identitiesByTag TaggedParametersHolder
asyncOperationId AsyncOperationIdentifier
cancellationToken CancellationToken

Returns

Task<long>

GetObjectNameEffectiveLength(string) 

protected override int GetObjectNameEffectiveLength(string objectName)

Parameters

objectName string

Returns

int

GetParameterName(OperandValue, int, ref bool)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public override string GetParameterName(OperandValue parameter, int index, ref bool createParameter)

Parameters

parameter OperandValue
index int
createParameter bool

Returns

string

GetSafeNameTableMaxLength() 

protected override int GetSafeNameTableMaxLength()

Returns

int

GetSeqName(string) 

protected virtual string GetSeqName(string tableName)

Parameters

tableName string

Returns

string

GetSqlCreateColumnFullAttributes(DBTable, DBColumn)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public override string GetSqlCreateColumnFullAttributes(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnFullAttributes(DBTable, DBColumn, bool)

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

public override string GetSqlCreateColumnFullAttributes(DBTable table, DBColumn column, bool forTableCreate)

Parameters

table DBTable
column DBColumn
forTableCreate bool

Returns

string

GetSqlCreateColumnTypeForBoolean(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForBoolean(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForByte(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForByte(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForByteArray(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForByteArray(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForChar(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForChar(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForDateTime(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForDateTime(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForDecimal(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForDecimal(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForDouble(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForDouble(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForGuid(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForGuid(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForInt16(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForInt16(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForInt32(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForInt32(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForInt64(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForInt64(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForSByte(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForSByte(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForSingle(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForSingle(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForString(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForString(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForUInt16(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForUInt16(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForUInt32(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForUInt32(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetSqlCreateColumnTypeForUInt64(DBTable, DBColumn) 

protected override string GetSqlCreateColumnTypeForUInt64(DBTable table, DBColumn column)

Parameters

table DBTable
column DBColumn

Returns

string

GetStorageTablesList(bool)

Returns a list of the available tables in the data store.

public override string[] GetStorageTablesList(bool includeViews)

Parameters

includeViews bool

true, to include available database views in the resulting array; otherwise, false.

Returns

string[]

An array of the table names in the data store.

GetStoredProcedures()

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override DBStoredProcedure[] GetStoredProcedures()

Returns

DBStoredProcedure[]

GetTableSchema(DBTable, bool, bool)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public override void GetTableSchema(DBTable table, bool checkIndexes, bool checkForeignKeys)

Parameters

table DBTable
checkIndexes bool
checkForeignKeys bool

ProcessClearDatabase() 

protected override void ProcessClearDatabase()

ReformatReadValue(object, ReformatReadValueArgs) 

protected override object ReformatReadValue(object value, ConnectionProviderSql.ReformatReadValueArgs args)

Parameters

value object
args ReformatReadValueArgs

Returns

object

Register()

Registers the provider for use with XPO.

public static void Register()

SetServerVersion(string)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public void SetServerVersion(string versionString)

Parameters

versionString string

WrapException(Exception, IDbCommand) 

protected override Exception WrapException(Exception e, IDbCommand query)

Parameters

e Exception
query IDbCommand

Returns

Exception