interface

sqlite.SQLTagStore

interface SQLTagStore

This class represents a single LRU (Least Recently Used) cache for storing prepared statements.

Instances of this class are created via the database.createTagStore() method, not by using a constructor. The store caches prepared statements based on the provided SQL query string. When the same query is seen again, the store retrieves the cached statement and safely applies the new values through parameter binding, thereby preventing attacks like SQL injection.

The cache has a maxSize that defaults to 1000 statements, but a custom size can be provided (e.g., database.createTagStore(100)). All APIs exposed by this class execute synchronously.

readonly capacity: number
A read-only property that returns the maximum number of prepared statements the cache can hold.
readonly db: DatabaseSync
A read-only property that returns the DatabaseSync object associated with this SQLTagStore.
readonly size: number
A read-only property that returns the number of prepared statements currently in the cache.
all(
stringElements: TemplateStringsArray,
...boundParameters: SQLInputValue[]
): Record<string, SQLOutputValue>[];
Executes the given SQL query and returns all resulting rows as an array of objects.
This function is intended to be used as a template literal tag, not to be called directly.
@param stringElements
Template literal elements containing the SQL query.
@param boundParameters
Parameter values to be bound to placeholders in the template string.
@returns
An array of objects representing the rows returned by the query.
clear(): void;
Resets the LRU cache, clearing all stored prepared statements.
get(
stringElements: TemplateStringsArray,
...boundParameters: SQLInputValue[]
): undefined | Record<string, SQLOutputValue>;
Executes the given SQL query and returns the first resulting row as an object.
This function is intended to be used as a template literal tag, not to be called directly.
@param stringElements
Template literal elements containing the SQL query.
@param boundParameters
Parameter values to be bound to placeholders in the template string.
@returns
An object representing the first row returned by the query, or undefined if no rows are returned.
iterate(
stringElements: TemplateStringsArray,
...boundParameters: SQLInputValue[]
): Iterator<Record<string, SQLOutputValue>>;
Executes the given SQL query and returns an iterator over the resulting rows.
This function is intended to be used as a template literal tag, not to be called directly.
@param stringElements
Template literal elements containing the SQL query.
@param boundParameters
Parameter values to be bound to placeholders in the template string.
@returns
An iterator that yields objects representing the rows returned by the query.
run(
stringElements: TemplateStringsArray,
...boundParameters: SQLInputValue[]
): StatementResultingChanges;
Executes the given SQL query, which is expected to not return any rows (e.g., INSERT, UPDATE, DELETE).
This function is intended to be used as a template literal tag, not to be called directly.
@param stringElements
Template literal elements containing the SQL query.
@param boundParameters
Parameter values to be bound to placeholders in the template string.
@returns
An object containing information about the execution, including changes and lastInsertRowid.