Table of Contents

Class MSSql2005SqlDependencyCacheRoot

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

The Root element that is used to connect Node elements to a data store being cached, tracking data store changes via SqlDependency notifications.

public class MSSql2005SqlDependencyCacheRoot : ICachedDataStore, ICacheToCacheCommunicationCore, IDataStore, IDataStoreSchemaExplorer, ICommandChannel, IDisposable
Inheritance
MSSql2005SqlDependencyCacheRoot
Implements
ICachedDataStore
ICacheToCacheCommunicationCore
IDataStore
IDataStoreSchemaExplorer
ICommandChannel
Inherited Members

Constructors

MSSql2005SqlDependencyCacheRoot(ICacheToCacheCommunicationCore, SqlConnection, string, ISqlGeneratorFormatter) 

[Obsolete("Use MSSql2005SqlDependencyCacheRoot(IDbConnection connection, ICacheToCacheCommunicationCore root, string connectionString, ISqlGeneratorFormatter formatter) instead.", false)]
protected MSSql2005SqlDependencyCacheRoot(ICacheToCacheCommunicationCore root, SqlConnection connection, string connectionString, ISqlGeneratorFormatter formatter)

Parameters

root ICacheToCacheCommunicationCore
connection SqlConnection
connectionString string
formatter ISqlGeneratorFormatter

MSSql2005SqlDependencyCacheRoot(IDbConnection, ICacheToCacheCommunicationCore, string, ISqlGeneratorFormatter) 

protected MSSql2005SqlDependencyCacheRoot(IDbConnection connection, ICacheToCacheCommunicationCore root, string connectionString, ISqlGeneratorFormatter formatter)

Parameters

connection IDbConnection
root ICacheToCacheCommunicationCore
connectionString string
formatter ISqlGeneratorFormatter

Fields

Connection 

[Obsolete("Use DbConnection field instead.", false)]
protected readonly SqlConnection Connection

Field Value

SqlConnection

ConnectionString 

protected readonly string ConnectionString

Field Value

string

DbConnection 

protected readonly IDbConnection DbConnection

Field Value

IDbConnection

Root 

protected readonly ICacheToCacheCommunicationCore Root

Field Value

ICacheToCacheCommunicationCore

SqlFormatter 

protected readonly ISqlGeneratorFormatter SqlFormatter

Field Value

ISqlGeneratorFormatter

XpoProviderTypeString_CacheRoot

Gets the name of a cached data store provider that is created via the MSSql2005SqlDependencyCacheRoot.CreateProviderFromString_CacheRoot method. This name is used internally when generating a connection string via the MSSqlConnectionProvider.GetConnectionString2005CacheRoot method.

public static string XpoProviderTypeString_CacheRoot

Field Value

string

XpoProviderTypeString_WithCache

Gets the name of a cached data store provider that is created via the MSSql2005SqlDependencyCacheRoot.CreateProviderFromString_WithCache method. This name is used internally when generating a connection string via the MSSqlConnectionProvider.GetConnectionString2005WithCache method.

public static string XpoProviderTypeString_WithCache

Field Value

string

isDisposed 

protected bool isDisposed

Field Value

bool

Properties

AutoCreateOption

Returns which operations are performed when a session connects a cached data store for the first time.

[Browsable(false)]
public AutoCreateOption AutoCreateOption { get; }

Property Value

AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value specifying which operations are performed when a session connects a cached data store for the first time.

Methods

CreateProviderFromString_CacheRoot(string, AutoCreateOption, out IDisposable[])

Returns a cached data store provider, created based on specified settings.

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

Parameters

connectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

autoCreateOption AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations should be performed when a data store is accessed for the first time.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

IDataStore

A DevExpress.Xpo.DB.DataCacheNodeLocal instance (an DevExpress.Xpo.DB.IDataStore implementation) which is connected to a MSSql2005SqlDependencyCacheRoot associated with a MSSqlConnectionProvider, that is created based on specified settings.

CreateProviderFromString_WithCache(string, AutoCreateOption, out IDisposable[])

Returns a cached data store provider, created based on specified settings.

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

Parameters

connectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

autoCreateOption AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations should be performed when a data store is accessed for the first time.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnecting from the database.

Returns

IDataStore

A DevExpress.Xpo.DB.DataCacheNode instance (an DevExpress.Xpo.DB.IDataStore implementation) which is connected to a MSSql2005SqlDependencyCacheRoot associated with a MSSqlConnectionProvider, that is created based on specified settings.

CreateSqlDependencyCacheRoot(IDataStore, SqlConnection, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[])

This method is obsolete (use CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[]) instead).

[Obsolete("Use CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect) instead.", false)]
public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDataStore nonCachedProvider, SqlConnection connection, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass an MSSqlConnectionProvider object as the parameter.

connection SqlConnection

An System.Data.SqlClient.SqlConnection object providing access to a database to be cached.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass an MSSqlConnectionProvider object as the parameter.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDataStore, SqlConnection, ISqlGeneratorFormatter, out IDisposable[])

This method is obsolete (use CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, ISqlGeneratorFormatter, out IDisposable[]) instead).

[Obsolete("Use CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect) instead.", false)]
public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDataStore nonCachedProvider, SqlConnection connection, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass an MSSqlConnectionProvider object or its descendant as the parameter.

connection SqlConnection

An System.Data.SqlClient.SqlConnection object providing access to a database to be cached.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass an MSSqlConnectionProvider object or its descendant as the parameter.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDataStore, SqlConnection, string, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[])

This method is obsolete (use CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, string, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[]) instead).

[Obsolete("Use CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, string originalConnectionString, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect) instead.", false)]
public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDataStore nonCachedProvider, SqlConnection connection, string originalConnectionString, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider IDataStore
connection SqlConnection
originalConnectionString string
formatter ISqlGeneratorFormatter
cacheConfiguration DataCacheConfiguration
objectsToDisposeOnDisconnect IDisposable[]

Returns

ICacheToCacheCommunicationCore

CreateSqlDependencyCacheRoot(IDataStore, SqlConnection, string, ISqlGeneratorFormatter, out IDisposable[])

This method is obsolete (use CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, string, ISqlGeneratorFormatter, out IDisposable[]) instead).

[Obsolete("Use CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, string originalConnectionString, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect) instead.", false)]
public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDataStore nonCachedProvider, SqlConnection connection, string originalConnectionString, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider IDataStore
connection SqlConnection
originalConnectionString string
formatter ISqlGeneratorFormatter
objectsToDisposeOnDisconnect IDisposable[]

Returns

ICacheToCacheCommunicationCore

CreateSqlDependencyCacheRoot(MSSqlConnectionProvider, DataCacheConfiguration, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified MSSqlConnectionProvider, providing access to a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(MSSqlConnectionProvider nonCachedProvider, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider MSSqlConnectionProvider

An MSSqlConnectionProvider providing access to the database.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(MSSqlConnectionProvider, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified MSSqlConnectionProvider providing access to a database to be cached.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(MSSqlConnectionProvider nonCachedProvider, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider MSSqlConnectionProvider

An MSSqlConnectionProvider providing access to the database.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(MSSqlConnectionProvider, string, DataCacheConfiguration, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(MSSqlConnectionProvider nonCachedProvider, string originalConnectionString, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider MSSqlConnectionProvider

An MSSqlConnectionProvider providing access to the database.

originalConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(MSSqlConnectionProvider, string, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(MSSqlConnectionProvider nonCachedProvider, string originalConnectionString, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

nonCachedProvider MSSqlConnectionProvider

An MSSqlConnectionProvider providing access to the database.

originalConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connection IDbConnection

An IDbConnection object providing access to a database to be cached

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass an MSSqlConnectionProvider object as the parameter.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass an MSSqlConnectionProvider object as the parameter.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, ISqlGeneratorFormatter, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connection IDbConnection

An IDbConnection object providing access to a database to be cached.

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, string, ISqlGeneratorFormatter, DataCacheConfiguration, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, string originalConnectionString, ISqlGeneratorFormatter formatter, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connection IDbConnection

An IDbConnection object providing access to a database to be cached.

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

originalConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(IDbConnection, IDataStore, string, ISqlGeneratorFormatter, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with a specified Microsoft SQL Server provider, which is used to access a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(IDbConnection connection, IDataStore nonCachedProvider, string originalConnectionString, ISqlGeneratorFormatter formatter, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

connection IDbConnection

An IDbConnection object providing access to a database to be cached.

nonCachedProvider IDataStore

An Microsoft SQL Server provider (an object implementing the DevExpress.Xpo.DB.IDataStore). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

originalConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

formatter ISqlGeneratorFormatter

A SQL query formatter (an object implementing the ISqlGeneratorFormatter). Normally, you can pass a MSSqlConnectionProvider object or its descendant as the parameter.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(string, AutoCreateOption, DataCacheConfiguration, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with an MSSqlConnectionProvider, which is created to provide access to a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(string sqlConnectionConnectionString, AutoCreateOption autoCreateOption, DataCacheConfiguration cacheConfiguration, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

sqlConnectionConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

autoCreateOption AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations should be performed when a data store is accessed for the first time.

cacheConfiguration DataCacheConfiguration

A DevExpress.Xpo.DB.Helpers.DataCacheConfiguration object providing cache configuration settings.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

CreateSqlDependencyCacheRoot(string, AutoCreateOption, out IDisposable[])

Creates an MSSql2005SqlDependencyCacheRoot instance associated with an MSSqlConnectionProvider, which is created to provide access to a database to be cached, based on specified settings.

public static ICacheToCacheCommunicationCore CreateSqlDependencyCacheRoot(string sqlConnectionConnectionString, AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect)

Parameters

sqlConnectionConnectionString string

A connection string for an Microsoft SQL Server database that supports Query Notifications.

autoCreateOption AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption value that specifies which operations should be performed when a data store is accessed for the first time.

objectsToDisposeOnDisconnect IDisposable[]

An array of IDisposable objects that must be disposed on disconnect from the database.

Returns

ICacheToCacheCommunicationCore

An MSSql2005SqlDependencyCacheRoot instance (an DevExpress.Xpo.DB.ICacheToCacheCommunicationCore implementation) ready to be used as the Root element in a cached hierarchy.

Do(string, object)

Executes a specified command via the current Root element with specific parameters and returns the operation result.

public virtual object Do(string command, object args)

Parameters

command string

A string specifying the command to execute.

args object

An object specifying the command‘s parameters.

Returns

object

An object denoting the operation result.

ModifyData(DataCacheCookie, ModificationStatement[])

Updates data in a cached data store using specified settings and returns the operation result.

public DataCacheModificationResult ModifyData(DataCacheCookie cookie, ModificationStatement[] dmlStatements)

Parameters

cookie DataCacheCookie

A DevExpress.Xpo.DB.Helpers.DataCacheCookie object specifying MSSql2005SqlDependencyCacheRoot state information.

dmlStatements ModificationStatement[]

An array of data modification statements.

Returns

DataCacheModificationResult

A DevExpress.Xpo.DB.Helpers.DataCacheModificationResult object denoting the result of the data modifications.

ModifyData(params ModificationStatement[])

Updates data in a cached data store using specified modification statements and returns the operation result.

public ModificationResult ModifyData(params ModificationStatement[] dmlStatements)

Parameters

dmlStatements ModificationStatement[]

An array of data modification statements.

Returns

ModificationResult

A DevExpress.Xpo.DB.ModificationResult object denoting the result of the data modifications.

NotifyDirtyTables(DataCacheCookie, params string[])

Informs a cached data store‘s Root element about specific modified tables.

public DataCacheResult NotifyDirtyTables(DataCacheCookie cookie, params string[] dirtyTablesNames)

Parameters

cookie DataCacheCookie

A Root element’s state stored by a specific cache Node.

dirtyTablesNames string[]

An array of table names specifying modified tables.

Returns

DataCacheResult

A DevExpress.Xpo.DB.Helpers.DataCacheResult object specifying a Root element’s state.

ProcessCookie(DataCacheCookie)

Synchronizes table update information with a cached data store‘s Root element.

public DataCacheResult ProcessCookie(DataCacheCookie cookie)

Parameters

cookie DataCacheCookie

A Root element’s state stored by a specific cache Node.

Returns

DataCacheResult

A DevExpress.Xpo.DB.Helpers.DataCacheResult object specifying a Root element’s state.

ProcessPossibleAging() 

protected void ProcessPossibleAging()

Register()

Registers MSSql2005SqlDependencyCacheRoot as a data store provider for use with XPO.

public static void Register()

SelectData(DataCacheCookie, SelectStatement[])

Fetches data from a cached data store using specified query statements and returns the operation result.

public DataCacheSelectDataResult SelectData(DataCacheCookie cookie, SelectStatement[] selects)

Parameters

cookie DataCacheCookie

A Root element’s state stored by a specific cache Node.

selects SelectStatement[]

An array of query statements.

Returns

DataCacheSelectDataResult

A DevExpress.Xpo.DB.Helpers.DataCacheSelectDataResult object denoting the result of the data fetch.

SelectData(params SelectStatement[])

Fetches data from a cached data store using specified query statements.

public SelectedData SelectData(params SelectStatement[] selects)

Parameters

selects SelectStatement[]

An array of statements to obtain data from the cached data store.

Returns

SelectedData

Data retrieved from the cached data store.

UpdateSchema(DataCacheCookie, DBTable[], bool)

Updates a cached data store‘s schema according to specified settings.

public DataCacheUpdateSchemaResult UpdateSchema(DataCacheCookie cookie, DBTable[] tables, bool doNotCreateIfFirstTableNotExist)

Parameters

cookie DataCacheCookie

A Root element’s state stored by a specific cache Node.

tables DBTable[]

An array of tables whose structure should be saved in a cached data store.

doNotCreateIfFirstTableNotExist bool

true if the schema should not be created when the table that corresponds to the first item in the tables array doesn’t exist in a cached data store; otherwise, false.

Returns

DataCacheUpdateSchemaResult

A DevExpress.Xpo.DB.Helpers.DataCacheUpdateSchemaResult denoting the result of the update operation.

UpdateSchema(bool, params DBTable[])

Updates a cached data store‘s schema according to specified settings.

public UpdateSchemaResult UpdateSchema(bool doNotCreateIfFirstTableNotExist, params DBTable[] tables)

Parameters

doNotCreateIfFirstTableNotExist bool

true if the schema should not be created when the table that corresponds to the first item in the tables array doesn’t exist in a cached data store; otherwise, false.

tables DBTable[]

An array of tables whose structure should be saved in a cached data store.

Returns

UpdateSchemaResult

An DevExpress.Xpo.DB.UpdateSchemaResult denoting the result of the update operation.