キャッシュ

キャッシュ

キャッシュのプロパティとメソッドを含むクラスを表します


コンストラクタ

# 新しいキャッシュ()

メソッド

# (非同期) 加えます(キー、アイテム、writeThruOptions) →{キャッシュアイテムのバージョン}

CacheItemをキャッシュに追加します。 また、WriteThruOptionsを指定することもできます。 CacheItemを使用すると、有効期限や優先度など、キャッシュアイテムのプロパティを指定することもできます。

パラメーター:
名前 タイプ デフォルト 詳細説明
key string

キャッシュアイテムを識別するための一意のキー。

item キャッシュ項目

CacheItemはキャッシュに保存されます。

writeThruOptions ライトスルー オプション ヌル

データソースの更新に関するWriteThruOptins。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

例:
const ncache  = require('ncache-client');

let cache = await ncache.CacheManager.getCache("test-Cache"); 

await cache.add('key', new ncache.CacheItem("Value"));

const cacheValue = await cache.get('key', ncache.JsonDataType.Scaler);

await cache.close();

# (非同期) 一括追加(アイテム、writeThruOptions) →{地図。 }

CacheItemを使用してキャッシュキーのマップをWriteThruOptionsを使用してキャッシュに追加します。 CacheItemには、有効期限、依存関係、削除情報など、アイテムに関連付けるプロパティが含まれています。

パラメーター:
名前 タイプ デフォルト 詳細説明
items 地図。 キャッシュ項目>

キーとCacheItemの辞書。 キーは一意である必要があります。

writeThruOptions ライトスルー オプション ヌル

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

戻り値:

キャッシュに保存できなかった例外とともにキーのディクショナリ。

タイプ
地図。
例:
//The following example demonstrates how to add items to the cache with an absolute expiration 2 minutes from now, a priority of high, 
//and that notifies the application when the item is removed from the cache.

let cache = await ncache.CacheManager.getCache("myCache");
let cacheItems = new Array[2];

let product_1 = new Product();
product_1.Id = 1;
product_1.Name = "Chai";

let product_2 = new Product();
product_2.Id = 2;
product_2.Name = "Chang";


cacheItems[0] = new CacheItem(product_1);
cacheItems[0].setExpiration(new ncache.Expiration(ncache.ExpirationType.Absolute, new ncache.TimeSpan(0, 2, 0)));
cacheItems[0].setPriority(ncache.CacheItemPriority.High);

cacheItems[1] = new CacheItem(product_2);
cacheItems[1].setExpiration(new ncache.Expiration(ncache.ExpirationType.Absolute, new ncache.TimeSpan(0, 2, 0)));
cacheItems[1].setPriority(ncache.CacheItemPriority.Normal);

let map = new Map();
map.set("Product0",cacheItems[0]);
map.set("Product1",cacheItems[1]);
    
let writeThruOptions = new ncache.WriteThruOptions(ncache.WriteMode.WriteThru, "ProdDataSource1");

await cache.addBulk(map, writeThruOptions);

# クリア()

キャッシュをクリアする

# (非同期) クライアントキャッシュのクリア()

クライアントキャッシュをクリアする

# (非同期) 閉じる()

キャッシュ接続を閉じます

# (非同期) 含まれています(キー)

キーに対するCacheItemがキャッシュにあるかどうかをチェックします

パラメーター:
名前 タイプ 詳細説明
key string

キャッシュ内で見つけるためのキー。

戻り値:

true キャッシュに指定されたキーを持つ要素が含まれている場合。 そうでなければ、 false.

例:
//The following example demonstrates how to check for containment of an item in the Cache

let cache = await  ncache.CacheManager.getCache("myCache");

if(await cache.Contains("Product0")){
		Response.Write("Item found!");
}

# (非同期) 含むバルク(キー)

キーに対するCacheItemsがキャッシュにあるかどうかをチェックします

パラメーター:
名前 タイプ 詳細説明
keys IterableIterator

キーのコレクション。

戻り値:

キャッシュ内の各キーの存在を判別するためのフラグ付きキーのディクショナリ。 true キャッシュに指定されたキーを持つ要素が含まれている場合。 そうでなければ、 false.

例:
//The following example demonstrates how to check for containment of an item in the Cache.
let cache = await CacheManager.getCache("myCache");

let keys = ["Product0","Product1"];

let result = await cache.ContainsBulk(keys);

# (非同期) 削除(key、lockHandle、version、writeThruOptions)

指定されたアイテムをICacheから削除します。 アイテムがキャッシュとデータソースの両方から削除されるように、書き込みオプションを指定することもできます。 バージョンが指定されている場合、アイテムは、指定されたバージョンがまだキャッシュ内の最新バージョンである場合にのみ削除されます。

パラメーター:
名前 タイプ 詳細説明
key string

削除するアイテムの一意のキー。

lockHandle ロックハンドル

アイテムがロックされている場合、正しいlockHandleが指定されている場合にのみアイテムを削除できます。 lockHandleは、アイテムをロックするために最初に使用されたものと同じである必要があります。そうでない場合、「OperationFailedException」が発生します。

version キャッシュアイテムのバージョン

削除するアイテムのバージョン。 これがまだキャッシュ内の最新バージョンである場合にのみ、アイテムはキャッシュから削除されます。

writeThruOptions ライトスルー オプション

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

例:
//Example demonstrates how to delete a locked item in the cache with write through options.
let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

let version = await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let lockHandle = new ncache.LockHandle();

let item = cache.get(key, ncache.JsonDataType.Object, null, null, true, new ncache.TimeSpan(0,0,2), lockHandle);

if (item !== null)
{
    try
    {
        let writeThruOptions = new ncache.WriteThruOptions(ncache.WriteMode.WriteThru, "ProdDataSource1");

        await cache.delete(key, ncache.JsonDataType.Object ,lockHandle, version, writeThruOptions);
    }
    catch (ex)
    {
    ...
    }
}

# (非同期) 一括削除(キー、writeThruOptions)

指定されたアイテムをキャッシュから削除します。 アイテムがキャッシュとデータソースの両方から削除されるように、書き込みオプションを指定することもできます。

パラメーター:
名前 タイプ 詳細説明
keys IterableIterator

アイテムを参照するための一意のキーのリスト。

writeThruOptions ライトスルー オプション

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

# (非同期) 取得する(key、c​​lassObj、version、readThruOptions、acquireLock、lockTimeout、lockHandle)

リードスルーキャッシュオプションを使用して、指定されたアイテムをCacheオブジェクトから取得します。 リードスルーのオプションが設定されている場合、オブジェクトがキャッシュに存在しない場合、オブジェクトはデータソースからフェッチされます。 参照によりCacheItemVersionを受け入れます。 CacheItemVersionにnullが渡されると、キャッシュからのオブジェクトのバージョンが返されます。 null以外のCacheItemVersionが渡された場合、それがキャッシュ内のオブジェクトの現在のバージョンである場合にのみ、オブジェクトがキャッシュから返されます。

パラメーター:
名前 タイプ 詳細説明
key string

取得するキャッシュアイテムの一意の識別子。

classObj JsonDataType

キャッシュから取得する値のタイプを指定します。

version キャッシュアイテムのバージョン

オブジェクトのバージョン。

readThruOptions リードスルーオプション

データソースから読み取るためのReadThruOptions。 これらは、ReadThru、ReadThruForced、またはNoneのいずれかになります。

acquireLock boolean

ロックを取得するかどうかを決定するフラグ。

lockTimeout 期間

その後、ロックが自動的に解放されるTimeSpan。

lockHandle ロックハンドル

ロック情報を保持するためのLockHandleのインスタンス。

戻り値:

取得されたキャッシュアイテム、またはキーが見つからない場合はnull参照。

例
//Example demonstrates how to retrieve the value cached with read thru option and version
let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

let version = await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let readThruOptions = new ncache.ReadThruOptions(ncache.ReadMode.ReadThru);

let product = await cache.get(key,ncache.JsonDataType.Object, readThruOptions, version);
//Example demonstrates how to retrieve the cached value and acquire a lock at the same time for minutes.
let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let lockHandle = new ncache.LockHandle();
 
let cachedItem = await cache.get(key, ncache.JsonDataType.Object, null, null, true, new ncache.TimeSpan(0, 2, 0),lockHandle);

# (非同期) バルク取得(キー、classOb、readThruOptions) →{地図。 キャッシュ項目>}

指定されたキーのオブジェクトをキーと値のペアとしてキャッシュから取得します。 データソースからの読み取り(リードスルー)に関するオプションを設定できます。

パラメーター:
名前 タイプ デフォルト 詳細説明
keys IterableIterator

アイテムがキャッシュからフェッチされる対象となるキー。

classOb JsonDataType

キャッシュから取得する値のタイプを指定します。

readThruOptions リードスルーオプション ヌル

データソースから読み取るためのReadThruOptions。 これらは、ReadThru、ReadThruForced、またはNoneのいずれかになります。

戻り値:

キーと値のペアとして取得されたキャッシュアイテム。

タイプ
地図。 キャッシュ項目>
例:
//Example demonstrates how to retrieve the value cached against multiple keys with Read through Options.
let cache = await ncache.CacheManager.getCache("myCache");

let keys = ["Product0", "Product1", "Product2"]

let readThruOptions = new ncache.ReadThruOptions(ncache.ReadMode.ReadThru);

let items = await cache.getBulk(keys, readThruOptions);

# (非同期) getCacheItem(key、version、readThruOptions、acquireLock、lockTimeout、lockHandle) →{キャッシュ項目}

リードスルーキャッシュオプションを使用して、指定されたアイテムをCacheオブジェクトから取得します。 リードスルーのオプションが設定されている場合、オブジェクトがキャッシュに存在しない場合、オブジェクトはデータソースからフェッチされます。 参照によりCacheItemVersionを受け入れます。 CacheItemVersionにnullが渡されると、キャッシュからのオブジェクトのバージョンが返されます。 null以外のCacheItemVersionが渡された場合、それがキャッシュ内のオブジェクトの現在のバージョンである場合にのみ、オブジェクトがキャッシュから返されます。

パラメーター:
名前 タイプ 詳細説明
key string

取得するキャッシュアイテムの一意の識別子。

version キャッシュアイテムのバージョン

オブジェクトのCacheItemVersion。

readThruOptions リードスルーオプション

データソースからの読み取りに関するReadThruOptions。 ReadThru、ReadThruForced、またはNoneのいずれかになります。

acquireLock boolean

ロックを取得するかどうかを決定するフラグ。

lockTimeout 期間

その後、ロックが自動的に解放されるTimeSpan。

lockHandle ロックハンドル

ロック情報を保持するためのLockHandleのインスタンス。

戻り値:

指定されたCacheItem。 キーが存在しない場合は、null参照を返します。

タイプ
キャッシュ項目
例
//Example demonstrates how to retrieve cache item with lock handle, timeout and flag box server control.
let cache = await ncache.CacheManager.getCache("myCache");
let key = "Product0";
let lockHandle = new ncache.LockHandle();
let item = cache.getCacheItem(key, null, null, true, TimeSpan.FromSeconds(30), lockHandle);
//Example demonstrates how to retrieve the cache item with read thru option and cache item version.
let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

let version = await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let readThruOptions = new ncache.ReadThruOptions(ncache.ReadMode.ReadThru);

let item = await cache.getCacheItem(key, readThruOptions, version);

# (非同期) getCacheItemBulk(キー、readThruOptions)

指定されたCacheItemsをCacheオブジェクトから取得します。 このオーバーロードにより、リードスルーオプションを指定することもできます。 リードスルーが設定されていて、オブジェクトがキャッシュに存在しない場合、オブジェクトはデータソースからフェッチされ、キャッシュに追加されます。

パラメーター:
名前 タイプ デフォルト 詳細説明
keys IterableIterator

取得するキャッシュアイテムの一意の識別子のリスト。

readThruOptions リードスルーオプション ヌル

データソースからの読み取りに関するReadThruOptions。 ReadThru、ReadThruForced、またはNoneのいずれかになります。

戻り値:

地図

例:
//Example demonstrates how to retrieve the cache items with read thru option.
let cache = await ncache.CacheManager.getCache("myCache");

let keys = 
[
    "Product0",
    "Product1",
    "Product2"
]

let readThruOptions = new ncache.ReadThruOptions(ncache.ReadMode.ReadThru);
let items = await cache.getCacheItemBulk(keys, readThruOptions);

# (非同期) クライアント情報の取得() →{クライアント情報}

このクライアントに関連する情報を表示します。

戻り値:
タイプ
クライアント情報

# (非同期) getConnectedClientList() →{配列。クライアント情報>}

キャッシュに接続されているすべてのクライアントの情報を取得します。

戻り値:
タイプ
配列。クライアント情報>

# (非同期) getCount() →{長い}

キャッシュ内のCacheItemの数を取得します

戻り値:
タイプ
長い

# (非同期) getDataStructuresManager() →{データ構造マネージャー}

{DataStructureManager}のインスタンスを返します

戻り値:
タイプ
データ構造マネージャー

# (非同期) getIfNewer(キー、cls、バージョン)

オブジェクトの新しいバージョンがキャッシュに存在する場合にのみ、キャッシュからオブジェクトを取得します。

パラメーター:
名前 タイプ 詳細説明
key string

目的のオブジェクトを参照するために使用される一意のキー。

cls クラスタイプ

キャッシュから取得する値のタイプを指定します。

version キャッシュアイテムのバージョン

指定されたオブジェクトのバージョン。

戻り値:

キャッシュに新しいオブジェクトが存在する場合、そのオブジェクトが返されます。 それ以外の場合は、nullが返されます。

例:
//Example demonstrates how to get a newer version of the item from cache if it exists.
let cache =await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

let version = await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let product = await cache.getIfNewer(key, ncache.JsonDataType.Object, version);

# (非同期) getIfNewerCacheItem(キー、バージョン) →{キャッシュ項目}

オブジェクトの新しいバージョンがキャッシュに存在する場合にのみ、キャッシュからCacheItemを取得します。

パラメーター:
名前 タイプ 詳細説明
key string

目的のオブジェクトを参照するために使用される一意のキー。

version キャッシュアイテムのバージョン

指定されたオブジェクトのバージョン。

戻り値:
タイプ
キャッシュ項目

# (非同期) getMessagingService() →{メッセージングサービス}

{MessagingService}のインスタンスを返します

戻り値:
タイプ
メッセージングサービス

# (非同期) getNotificationService() →{通知サービス}

{NotificationService}のインスタンスを返します

戻り値:
タイプ
通知サービス

# (非同期) getSearchService() →{検索サービス}

{SearchService}のインスタンスを返します

戻り値:
タイプ
検索サービス

# (非同期) insert(key、item、writeThruOptions、lockHandle、releaseLock) →{キャッシュアイテムのバージョン}

CacheItemをキャッシュに挿入し、Write-Throughオプションを指定できるようにします

パラメーター:
名前 タイプ 詳細説明
key string

キャッシュアイテムを識別するための一意のキー。

item キャッシュ項目

キャッシュに挿入されるCacheItem。

writeThruOptions ライトスルー オプション

データソースの更新に関するWriteThruOptins。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

lockHandle ロックハンドル

ロック情報を保持するLockHandleのインスタンス。 アイテムがロックされている場合、正しいlockHandleが指定されている場合にのみ更新できます。

releaseLock ブーリアン

操作実行後にロックを解除するかどうかを決定するフラグ。

例:
const ncache  = require('ncache-client');

let cache = await ncache.CacheManager.getCache("test-Cache"); 

await cache.insert('key', new ncache.CacheItem("Value"));

const cacheValue = await cache.get('key', ncache.JsonDataType.Scaler);

await cache.close();

# (非同期) 一括挿入(アイテム、writeThruOptions) →{地図。 }

CacheItemを含むキャッシュキーのマップをWriteThruOptionsを使用してキャッシュに挿入します。 CacheItemには、有効期限、依存関係、削除情報など、アイテムに関連付けるプロパティが含まれています。

パラメーター:
名前 タイプ デフォルト 詳細説明
items 地図。 キャッシュ項目>

キーとCacheItemの辞書。 キーは一意である必要があります。

writeThruOptions ライトスルー オプション ヌル

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

戻り値:

キャッシュに保存できなかった例外とともにキーのマップ。

タイプ
地図。
例:
//The following example demonstrates how to insert items to the cache with an absolute expiration 2 minutes from now, a priority of high, 
//and that notifies the application when the item is removed from the cache.

let cache = await ncache.CacheManager.getCache("myCache");
let cacheItems = new Array[2];

let product_1 = new Product();
product_1.Id = 1;
product_1.Name = "Chai";

let product_2 = new Product();
product_2.Id = 2;
product_2.Name = "Chang";


cacheItems[0] = new CacheItem(product_1);
cacheItems[0].setExpiration(new ncache.Expiration(ncache.ExpirationType.Absolute, new ncache.TimeSpan(0, 2, 0)));
cacheItems[0].setPriority(ncache.CacheItemPriority.High);

cacheItems[1] = new CacheItem(product_2);
cacheItems[1].setExpiration(new ncache.Expiration(ncache.ExpirationType.Absolute, new ncache.TimeSpan(0, 2, 0)));
cacheItems[1].setPriority(ncache.CacheItemPriority.Normal);

let map = new Map();
map.set("Product0",cacheItems[0]);
map.set("Product1",cacheItems[1]);
    
let writeThruOptions = new ncache.WriteThruOptions(ncache.WriteMode.WriteThru, "ProdDataSource1");

await cache.insertBulk(map, writeThruOptions);
       

# (非同期) ロック(key、lockTimeout、lockHandle)

キャッシュ内のアイテムのロックを取得します。

パラメーター:
名前 タイプ 詳細説明
key string

ロックするキャッシュアイテムのキー。

lockTimeout 期間

ロックが自動的に解放された後のTimeSpanのインスタンス。

lockHandle ロックハンドル

ロックが正常に取得された場合にロック情報が入力されるLockHandleのインスタンス。

戻り値:

ロックが正常に取得されたかどうか。

例:
//Example demonstrates how to lock a cached item.
let key = "Product0";
let lockHandle = new ncache.LockHandle();
let locked = theCache.lock(key, new ncache.TimeSpan(0,0,10), lockHandle);
...

# (非同期) 削除します(key、c​​ls、lockHandle、version、writeThruOptions) →{キャッシュ項目}

指定されたアイテムをICacheから削除します。 アイテムがキャッシュとデータソースの両方から削除されるように、書き込みオプションを指定することもできます。 バージョンが指定されている場合、アイテムは、指定されたバージョンがまだキャッシュ内の最新バージョンである場合にのみ削除されます。

パラメーター:
名前 タイプ 詳細説明
key string

削除するアイテムの一意のキー。

cls JsonDataType

キャッシュから削除される値のタイプを指定します。

lockHandle ロックハンドル

アイテムがロックされている場合、正しいlockHandleが指定されている場合にのみアイテムを削除できます。 lockHandleは、アイテムをロックするために最初に使用されたものと同じである必要があります。そうでない場合、「OperationFailedException」が発生します。

version キャッシュアイテムのバージョン

削除するアイテムのバージョン。 これがまだキャッシュ内の最新バージョンである場合にのみ、アイテムはキャッシュから削除されます。

writeThruOptions ライトスルー オプション

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

戻り値:
タイプ
キャッシュ項目
例:
//Example demonstrates how to remove a locked item in the cache with write through options.
let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

let version = await cache.add(key, new ncache.CacheItem(product, "FQN.Product"));

let lockHandle = new ncache.LockHandle();

let item = cache.get(key, ncache.JsonDataType.Object, null, null, true, new ncache.TimeSpan(0,0,2), lockHandle);

if (item !== null)
{
    try
    {
        let writeThruOptions = new ncache.WriteThruOptions(ncache.WriteMode.WriteThru, "ProdDataSource1");

        await cache.remove(key, ncache.JsonDataType.Object ,lockHandle, version, writeThruOptions);
    }
    catch (ex)
    {
    ...
    }
}

# (非同期) 一括削除(キー、classOb、writeThruOptions)

指定されたアイテムをキャッシュから削除します。 アイテムがキャッシュとデータソースの両方から削除されるように、書き込みオプションを指定することもできます。

パラメーター:
名前 タイプ 詳細説明
keys IterableIterator

アイテムを参照するための一意のキーのリスト。

classOb JsonDataType

キャッシュから削除される値のタイプを指定します。

writeThruOptions ライトスルー オプション

データソースの更新に関するWriteThruOptions。 これは、WriteThru、WriteBehind、またはNoneのいずれかになります。

戻り値:

削除されたオブジェクト

例:
//The following example demonstrates how you can remove an item from your application's Cache object.
let cache = await ncache.CacheManager.getCache("myCache");

let keys = 
[
    "Product0",
    "Product1",
    "Product2"
];

let writeThruOptions = new ncache.WriteThruOptions(ncache.WriteMode.WriteThru, "ProdDataSource1");

await cache.removeBulk(keys, writeThruOptions);

# toString()

キャッシュの名前を返します

# (非同期) アンロック(キー、lockHandle)

正しいLockHandleが指定されている場合、ロックされたキャッシュアイテムのロックを解除します。 LockHandleがnullの場合、ロックされたキャッシュアイテムのロックを強制的に解除します。

パラメーター:
名前 タイプ デフォルト 詳細説明
key string

ロックを解除するキャッシュされたアイテムのキー。

lockHandle ロックハンドル ヌル

ロックが取得されたときに生成されるLockHandleのインスタンス。

例:
// Following example demonstrates how to unlock a cached item.
...
let key = "Product0";
...
await cache.Unlock(key, lockHandle);
...

# (非同期) 属性の更新(キー、属性)

キャッシュ内の既存のアイテムの{CacheItemAttributes}を更新します。

パラメーター:
名前 タイプ 詳細説明
key string

キャッシュアイテムを識別するための一意のキー。

attributes キャッシュアイテム属性

キャッシュ内のアイテムを更新するCacheItemAttributesのインスタンス。

戻り値:

更新操作のステータスを決定するフラグ。true キャッシュ内のアイテムの属性が正常に更新された場合 false 操作が失敗した場合。

例:
// Example demonstrates how to update Absolute Expiration of 5 minutes on an existing item in cache. 

let cache = await ncache.CacheManager.getCache("myCache");

let product = new Product();
product.Id = 1;
product.Name = "Chai";

let key = "Product0";

await cache.insert(key, product);

let attributes = new ncache.CacheItemAttributes();
attributes.setAbsoluteExpiration(new Date().setMinutes(5));

if(await cache.UpdateAttributes(key, attributes)) {
...
}