Search
Cache
In @workertown/search, the cache is used to in front of certain storage queries to improve performance.
When a search/suggestion is performed, the service will (if the cache is enabled - it is by default) search for a cached version of the storage scan used before it runs the search. If a cached version is found, it will not hit the storage and instead use the cached set of documents.
When a document is added/updated/deleted, the service will clear the cache for that document's tenant and index.
For more information on how cache works in Workertown services more generally, see cache
CacheAdapter
The CacheAdapter interface is defined as follows:
interface SearchDocument {
id: string;
tenant: string;
index: string;
data: Record<string, unknown>;
tags: string[];
createdAt: Date;
updatedAt: Date;
}
declare class CacheAdapter {
get<SearchDocument[]>(key: string): Promise<T | null>;
set(key: string, value: SearchDocument, ttl?: number): Promise<void>;
delete(key?: string): Promise<void>;
}
Built-in CacheAdapters
@workertown/search provides several built-in CacheAdapters that can be used via the runtime configuration option.
KVCacheAdapter
The KVCacheAdapter is the default CacheAdapter and is used when no other CacheAdapter is specified. It uses Cloudflare Workers KV to store the cached data.
import { search } from "@workertown/search";
import { KVCacheAdapter } from "@workertown/search/cache/kv";
import { StorageAdapter } from "@workertown/search/storage";
export default search({
runtime: (options, env) => ({
cache: new KVCacheAdapter({ kv: env.KV }), // `kv` is the KVNamespace bound to the Cloudflare Worker to use for the cache
storage: new StorageAdapter(/* ... */),
}),
});
UpstashRedisCacheAdapter
Coming soon...
MemoryCacheAdapter
The MemoryCacheAdapter is a simple CacheAdapter that stores the cached data in memory. It is not recommended for production use, but can be useful for development and testing.
import { search } from "@workertown/search";
import { MemoryCacheAdapter } from "@workertown/search/cache/memory";
import { StorageAdapter } from "@workertown/search/storage";
export default search({
runtime: (options, env) => ({
cache: new MemoryCacheAdapter(),
storage: new StorageAdapter(/* ... */),
}),
});
NoOpCacheAdapter
The NoOpCacheAdapter is a CacheAdapter that does nothing. It is provided simply for situations where you want to provide a CacheAdapter instance but don't want it to do anything.
import { search } from "@workertown/search";
import { NoOpCacheAdapter } from "@workertown/search/cache/no-op";
import { StorageAdapter } from "@workertown/search/storage";
export default search({
runtime: (options, env) => ({
cache: new NoOpCacheAdapter(),
storage: new StorageAdapter(/* ... */),
}),
});
Custom CacheAdapters
You can also provide your own custom CacheAdapter by extending the CacheAdapter class.
import { search } from "@workertown/search";
import { CacheAdapter, type SearchDocument } from "@workertown/search/cache";
import { StorageAdapter } from "@workertown/search/storage";
class CustomCacheAdapter extends CacheAdapter {
async get(key: string) { /* .. */ },
async set(key: string, value: SearchDocument, ttl?: number) { /* .. */ },
async delete(key?: string) { /* .. */ },
}
export default search({
runtime: (options, env) => ({
cache: new CustomCacheAdapter(),
storage: new StorageAdapter(/* ... */),
}),
});