Export (0) Print
Expand All

SqlCacheDependencyDatabase Class

Configures the SQL cache dependencies databases for an ASP.NET application. This class cannot be inherited.

System.Object
  System.Configuration.ConfigurationElement
    System.Web.Configuration.SqlCacheDependencyDatabase

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class SqlCacheDependencyDatabase : ConfigurationElement

The SqlCacheDependencyDatabase type exposes the following members.

  NameDescription
Public methodSqlCacheDependencyDatabase(String, String)Initializes a new instance of the SqlCacheDependencyDatabase class with the passed parameters.
Public methodSqlCacheDependencyDatabase(String, String, Int32)Initializes a new instance of the SqlCacheDependencyDatabase class.
Top

  NameDescription
Public propertyConnectionStringNameGets or sets the connection name for the database.
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyNameGets or sets the name of the database.
Public propertyPollTimeGets or sets the frequency with which the SqlCacheDependency polls the database table for changes.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The SqlCacheDependencyDatabase allows you to programmatically access and modify the databases element of the sqlCacheDependency node within the caching configuration section.

The SQL cache dependency allows the cached data to be synchronized with the original source. After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the SqlCacheDependency class monitors the table for possible changes.

The following code example shows how to obtain the SqlCacheDependencyDatabase object from the configuration file of an existing Web application.

        // Get the Web application configuration.
        System.Configuration.Configuration webConfig =
        WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

        // Get the section. 
        string configPath = "system.web/cache/sqlCacheDependency";
        System.Web.Configuration.SqlCacheDependencySection sqlDs =
        (System.Web.Configuration.SqlCacheDependencySection)webConfig.GetSection(
        configPath);

        // Get the databases element at 0 index.
        System.Web.Configuration.SqlCacheDependencyDatabase sqlCdd =
            sqlDs.Databases[0];

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft