Cache SQL Server Reference Documentation
Cache
Current Version: 11.6.0
Chilkat.Cache
Store and retrieve cached items by unique key, without the application
needing to manage the underlying cache filenames directly.
Cache strings, byte data, files, or Chilkat buffer objects depending on
the data form used by the application.
Associate cached items with expiration times, update expiration metadata,
and check whether cached content is still usable.
Store and retrieve ETag values for workflows that need HTTP-style cache
validation or conditional re-fetch logic.
Choose the cache root directory and use an optional multi-level directory
structure to avoid too many files in a single folder.
Delete a single cached item, remove expired items, remove older items, or
clear the entire cache when needed.
For an extended overview, see
Cache Class Overview.
Store, retrieve, expire, and clean up cached text or binary data on disk.
Chilkat.Cache is a disk-based cache class for storing and
retrieving text or binary items by unique key. It provides configurable cache
roots, optional multi-level directory layout, expiration metadata, ETag
metadata, cache lookup, fetch-status properties, expiration updates, and
cleanup methods for deleting individual items, expired items, older items, or
the entire cache.
Key-based storage
Text and binary data
Expiration control
ETag metadata
Configurable layout
Cleanup operations
Object Creation
DECLARE @hr int
DECLARE @cache int
EXEC @hr = sp_OACreate 'Chilkat.Cache', @cache OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @cache ...
EXEC @hr = sp_OADestroy @cacheT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.Cache.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @cache, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
DebugLogFilePath
EXEC sp_OASetProperty @cache, 'DebugLogFilePath', @sValue
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastEtagFetched
Returns the ETag metadata associated with the most recently fetched cache item. An empty string means that the fetched item has no stored ETag.
FetchBd, FetchSb, or FetchText.If-None-Match.LastExpirationFetchedStr
Returns the expiration date and time stored for the most recently fetched cache item, formatted as an RFC 822-style Internet date. An empty string represents an item with no expiration date.
LastHitExpired after the fetch to determine whether the returned entry is stale.LastHitExpired
Returns 1 when the expiration time of the most recently fetched item is earlier than the current system date and time; otherwise returns 0.
DeleteAllExpired or DeleteFromCache.LastKeyFetched
Returns the application-defined key associated with the most recently fetched cache item.
LastMethodSuccess
EXEC sp_OASetProperty @cache, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topLevel
EXEC sp_OASetProperty @cache, 'Level', @iValue
Gets or sets the number of directory levels used beneath each cache root. Valid values are 0, 1, and 2.
| Value | Directory layout |
|---|---|
0 | All cache files are stored directly in the cache root. |
1 | Files are distributed among 256 first-level directories named 0 through 255. |
2 | Files are distributed through two levels of 256 directories, allowing as many as 65,536 leaf directories per root. |
NumRoots
Returns the number of cache-root directories that have been registered by calling AddRoot.
VerboseLogging
EXEC sp_OASetProperty @cache, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddRoot
Adds path as a root directory for the disk cache. Call this method once for each root that should participate in the cache.
For example, a cache distributed across D:\cacheRoot, E:\cacheRoot, and F:\cacheRoot is configured by calling this method three times.
Level setting before accessing a cache created by an earlier process or application run.DeleteAll
Deletes every cache item from all configured roots and returns the number of cache files removed. Multi-level subdirectories are retained.
DeleteAllExpired
Deletes all cache items whose stored expiration time is earlier than the current system time and returns the number of files removed.
DeleteFromCache
Deletes the cache item identified by key.
| Return value | Meaning |
|---|---|
1 | The item was deleted, or no item existed for the key. |
0 | The item exists but could not be deleted, for example because of a filesystem permission or sharing error. |
Returns 1 for success, 0 for failure.
topDeleteOlderDt
Deletes cache items older than the cutoff date and time supplied in dateTime.
Returns the number of cache files deleted, or -1 if an error occurs.
DeleteAllExpired when the decision should be based specifically on each item's expiration metadata.DeleteOlderStr
Deletes cache items older than the cutoff date and time supplied in dateTimeStr as an RFC 822-style Internet date string.
Returns the number of cache files deleted, or -1 if an error occurs.
Mon, 03 Aug 2026 12:00:00 GMT. Use DeleteOlderDt when the cutoff is already available as a CkDateTime.FetchBd
Retrieves the binary item identified by key and loads its bytes into the BinData object supplied in bd.
The key is application-defined, may contain any characters, and must uniquely identify the intended item.
1. A failed lookup or filesystem error returns 0.LastHitExpired immediately afterward when stale data must not be used.Returns 1 for success, 0 for failure.
topFetchSb
Retrieves the text item identified by key and loads its content into the StringBuilder supplied in sb.
The key is application-defined, may contain any characters, and must uniquely identify the intended item.
1. A failed lookup or filesystem error returns 0.LastHitExpired immediately afterward when stale data must not be used.Returns 1 for success, 0 for failure.
topFetchText
Retrieves the text item identified by key and returns its string content.
The key is application-defined, may contain any characters, and must uniquely identify the intended item.
LastHitExpired immediately afterward when the application requires only fresh data.Returns NULL on failure
GetEtag
Returns the ETag metadata stored with the cache item identified by key.
Returns NULL on failure
GetExpirationStr
Returns the expiration date and time stored for the item identified by url, formatted as an RFC 822-style Internet date string.
url url for historical reasons. It is the cache key and does not need to be a URL.Returns NULL on failure
GetFilename
Returns the absolute filesystem path of the cache file associated with key.
Cache API rather than modifying cache files directly.Returns NULL on failure
GetRoot
Returns the directory path of the cache root at zero-based index. Valid indexes range from 0 through NumRoots - 1.
Returns NULL on failure
IsCached
Returns 1 if an item exists for key, or 0 if the key is not present.
LastHitExpired, or read its expiration metadata, when freshness matters.SaveBd
Stores the contents of bd as binary cache data under key. If the key already exists, its data and metadata are replaced.
| Argument | Purpose |
|---|---|
key | The unique application-defined cache key. |
expiration | Expiration as an RFC 822-style Internet date string. Pass an empty string for no expiration. |
etag | Optional ETag or application metadata. Pass an empty string when unused. |
bd | The BinData containing the bytes to save. |
Returns 1 for success, 0 for failure.
topSaveTextDt
Stores itemTextData as a text cache item under key, with the expiration date and time supplied in expireDateTime. If the key already exists, its data and metadata are replaced.
eTag is optional ETag or application metadata and may be an empty string. The key may contain any characters and may be any length, but it must uniquely identify the item.
LastHitExpired to detect staleness and a deletion method to remove it.Returns 1 for success, 0 for failure.
topSaveTextNoExpire
Stores itemTextData as a non-expiring text cache item under key. If the key already exists, its data and metadata are replaced.
eTag is optional ETag or application metadata and may be an empty string.
Returns 1 for success, 0 for failure.
SaveTextStr
Stores itemTextData as a text cache item under key, with expireDateTime providing the expiration time as an RFC 822-style Internet date string. If the key already exists, its data and metadata are replaced.
eTag is optional ETag or application metadata and may be empty.
SaveTextDt when the expiration is available as a CkDateTime, or SaveTextNoExpire for an entry without expiration.Returns 1 for success, 0 for failure.
topUpdateExpirationDt
Replaces the expiration date and time of the cache item identified by key with the CkDateTime value supplied in expireDateTime. The cached data and ETag are unchanged.
Returns 1 for success, 0 for failure.
topUpdateExpirationStr
Replaces the expiration date and time of the cache item identified by key with the RFC 822-style Internet date string supplied in expireDateTime. The cached data and ETag are unchanged.
key url; it is the cache key and does not need to be a URL. Use UpdateExpirationDt for a CkDateTime value.Returns 1 for success, 0 for failure.
topDeprecated
GetExpirationDt
GetExpirationStr and load the returned value into a CkDateTime when an object representation is required.Returns the expiration date and time for the item identified by key as a newly returned CkDateTime object.
Returns NULL on failure