Table of Contents

Class AccessConnectionProvider

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

Implements data-aware operations for working with Microsoft Access databases.

public class AccessConnectionProvider : OleDBConnectionProvider, ISqlGeneratorFormatterEx, ISqlGeneratorFormatter
Inheritance
AccessConnectionProvider
Implements
ISqlGeneratorFormatterEx
ISqlGeneratorFormatter
Inherited Members

Constructors

AccessConnectionProvider(IDbConnection, AutoCreateOption)

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

public AccessConnectionProvider(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

MaximumStringSize

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

public const int MaximumStringSize = 255

Field Value

int

XpoProviderTypeString

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

public const string XpoProviderTypeString = "MSAccess"

Field Value

string

Properties

DbTypeMapper

protected override DbTypeMapperBase DbTypeMapper { get; }

Property Value

DbTypeMapperBase

NeedsIndexForForeignKey

protected override bool NeedsIndexForForeignKey { get; }

Property Value

bool

Methods

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

CreateCommand(Query)

protected override IDbCommand CreateCommand(Query query)

Parameters

query Query

Returns

IDbCommand

CreateConnection()

protected override IDbConnection CreateConnection()

Returns

IDbConnection

CreateDataBase()

protected override void CreateDataBase()

CreateForeignKey(DBTable, DBForeignKey)

Creates a foreign key.

public override void CreateForeignKey(DBTable table, DBForeignKey foreignKey)

Parameters

table DBTable

A DevExpress.Xpo.DB.DBTable object that represents the table.

foreignKey DBForeignKey

A DevExpress.Xpo.DB.DBForeignKey object that represents the foreign key.

CreateProviderFromConnection(IDbConnection, AutoCreateOption)

This method supports the internal infrastructure and is not intended to be called 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 method supports the internal infrastructure and is not intended to be called directly from your code.

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

Parameters

connectionString string
autoCreateOption AutoCreateOption
objectsToDisposeOnDisconnect IDisposable[]

Returns

IDataStore

ExecuteSproc(string, params OperandValue[])

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

Parameters

sprocName string
parameters OperandValue[]

Returns

SelectedData

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

protected override Task<SelectedData> ExecuteSprocAsync(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

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

FormatSelect(string, string, string, string, string, string, 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 topSelectedRecords)

Parameters

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

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 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)

Returns a connection string to the specified Microsoft Access data base using the default credentials.

public static string GetConnectionString(string database)

Parameters

database string

A string that specifies the path and name of the data base to connect to.

Returns

string

A connection string.

GetConnectionString(string, string, string)

Returns a connection string to the specified Microsoft Access database using the specified credentials.

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

Parameters

database string

A string that specifies the path and name of the database to connect to.

userId string

A string that specifies the user’s name. This is used to initialize the “User ID” field of the connection string.

password string

A string that specifies the password. This is used to initialize the “Password” field of the connection string.

Returns

string

A connection string.

GetConnectionStringACE(string, string)

Returns a connection string to the specified Microsoft Access 2007 database using the default credentials.

public static string GetConnectionStringACE(string database, string password)

Parameters

database string

A string that specifies the path and name of the data base to connect to.

password string

A string that specifies the password. This is used to initialize the “Password” field of the connection string.

Returns

string

A connection string.

GetIdentity(Query)

protected override long GetIdentity(Query sql)

Parameters

sql Query

Returns

long

GetIdentityAsync(Query, AsyncOperationIdentifier, CancellationToken)

protected override Task<long> GetIdentityAsync(Query sql, AsyncOperationIdentifier asyncOperationId, CancellationToken cancellationToken)

Parameters

sql Query
asyncOperationId AsyncOperationIdentifier
cancellationToken CancellationToken

Returns

Task<long>

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

GetSafeNameRoot(string)

protected override string GetSafeNameRoot(string originalName)

Parameters

originalName string

Returns

string

GetSafeNameTableMaxLength()

protected override int GetSafeNameTableMaxLength()

Returns

int

GetSqlCreateColumnFullAttributes(DBTable, DBColumn)

This method supports the internal infrastructure and is not intended to 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)

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 which contains the table names in the data store.

GetStoredProcedures()

Returns an array of stored procedures available within the data store.

public override DBStoredProcedure[] GetStoredProcedures()

Returns

DBStoredProcedure[]

An array containing available stored procedures.

ProcessClearDatabase()

protected override void ProcessClearDatabase()

Register()

Registers the provider for use with XPO.

public static void Register()

WrapException(Exception, IDbCommand)

protected override Exception WrapException(Exception e, IDbCommand query)

Parameters

e Exception
query IDbCommand

Returns

Exception