SqlIndexedCache Class

This is a version of the InMemoryIndexCache that adds the ability to store index information in a persistent SQL database.

Inheritance Hierarchy

SystemObject
  Microsoft.Ddue.Tools.CommandsIndexedCache
    Microsoft.Ddue.Tools.CommandsInMemoryIndexedCache
      SandcastleBuilder.Components.CommandsSqlIndexedCache

Namespace: SandcastleBuilder.Components.Commands
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class SqlIndexedCache : InMemoryIndexedCache

Public Class SqlIndexedCache
	Inherits InMemoryIndexedCache

public ref class SqlIndexedCache : public InMemoryIndexedCache

type SqlIndexedCache =  
    class
        inherit InMemoryIndexedCache
    end

The SqlIndexedCache type exposes the following members.

Constructors

	Name	Description
	SqlIndexedCache	Constructor

Top

Methods

	Name	Description
	AddDocuments	This is used to index documents and add their key/file mappings to the cache (Overrides InMemoryIndexedCacheAddDocuments(XPathNavigator).)
	Dispose	This implements the Dispose() interface to properly dispose of the indexed cache (Inherited from IndexedCache.)
	Dispose(Boolean)	This can be overridden by derived classes to add their own disposal code if necessary. (Overrides IndexedCacheDispose(Boolean).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	This handles garbage collection to ensure proper disposal of the indexed cache if not done explicitly with Dispose. (Inherited from IndexedCache.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetKeys	This returns an enumerable list of all key values from the specified XML file based on the expressions for this cache. (Inherited from IndexedCache.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValues	This returns an enumerable list of all key/value pairs from the specified XML file based on the expressions for this cache. (Inherited from IndexedCache.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReportCacheStatistics	Report the cache usage for the build (Overrides InMemoryIndexedCacheReportCacheStatistics.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Component	This read-only property returns a reference to the CopyFromIndexComponent that owns it (Inherited from IndexedCache.)
	Count	This read-only property returns a count of the items in the indexed cache (Overrides InMemoryIndexedCacheCount.)
	IsDisposed	This read-only property can be used to determine whether or not the indexed cache has been disposed (Inherited from IndexedCache.)
	Item	This read-only property returns the value in the indexed cache for the given key (Overrides InMemoryIndexedCacheItemString.)
	KeyExpression	This read-only property returns the XPath expression used to extract the key from values (Inherited from IndexedCache.)
	Name	This read-only property returns the name of the index cache (Inherited from IndexedCache.)
	ValueExpression	This read-only property returns the XPath expression used to search for values in the XML files (Inherited from IndexedCache.)

Top

Reference

SandcastleBuilder.Components.Commands Namespace