Class SQLTagStore

SQLTagStore provides cached prepared statements via tagged template syntax.

Example

const sql = db.createTagStore();
sql.run`INSERT INTO users VALUES (${id}, ${name})`;
const user = sql.get`SELECT * FROM users WHERE id = ${id}`;

Index

Constructors

constructor

new SQLTagStore(db: DatabaseSyncInstance, capacity?: number): SQLTagStore
Parameters
- db: DatabaseSyncInstance
- capacity: number = DEFAULT_CAPACITY
Returns SQLTagStore
- Defined in sql-tag-store.ts:26

Accessors

capacity

get capacity(): number
Returns the maximum capacity of the statement cache.

Returns number
- Defined in sql-tag-store.ts:45

db

get db(): DatabaseSyncInstance
Returns the associated database instance.

Returns DatabaseSyncInstance
- Defined in sql-tag-store.ts:38

size

get size(): number
Returns the current number of cached statements.

Returns number
- Defined in sql-tag-store.ts:52

Methods

all

all(strings: TemplateStringsArray, ...values: unknown[]): unknown[]
Execute a query and return all rows as an array.
Parameters
- strings: TemplateStringsArray
- ...values: unknown[]
Returns unknown[]
- Defined in sql-tag-store.ts:86

clear

clear(): void
Clears all cached statements.

Returns void
- Defined in sql-tag-store.ts:59

get

get(strings: TemplateStringsArray, ...values: unknown[]): unknown
Execute a query and return the first row, or undefined if no rows.
Parameters
- strings: TemplateStringsArray
- ...values: unknown[]
Returns unknown
- Defined in sql-tag-store.ts:78

iterate

iterate(
strings: TemplateStringsArray,
...values: unknown[],
): IterableIterator<unknown>
Execute a query and return an iterator over the rows.
Parameters
- strings: TemplateStringsArray
- ...values: unknown[]
Returns IterableIterator<unknown>
- Defined in sql-tag-store.ts:94

run

run(
strings: TemplateStringsArray,
...values: unknown[],
): { changes: number; lastInsertRowid: number | bigint }
Execute an INSERT, UPDATE, DELETE or other statement that doesn't return rows. Returns an object with changes and lastInsertRowid.
Parameters
- strings: TemplateStringsArray
- ...values: unknown[]
Returns { changes: number; lastInsertRowid: number | bigint }
- Defined in sql-tag-store.ts:67

Class SQLTagStore

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SQLTagStore

Accessors

capacity

Returns number

db

Returns DatabaseSyncInstance

size

Returns number

Methods

all

Parameters

Returns unknown[]

clear

Returns void

get

Parameters

Returns unknown

iterate

Parameters

Returns IterableIterator<unknown>

run

Parameters

Returns { changes: number; lastInsertRowid: number | bigint }

Settings

On This Page