Class: PreparedStatement

Defined in: packages/core/src/api/prepared.ts:17

An explicitly prepared statement, pinned outside the LRU cache. Re-execution costs a single round trip. Close it when done.

Properties

Property	Modifier	Type	Defined in
sql	readonly	string	packages/core/src/api/prepared.ts:26

Accessors

inputs

Get Signature

get inputs(): readonly SqlVarDesc[];

Defined in: packages/core/src/api/prepared.ts:48

Described input parameters.

Returns

readonly SqlVarDesc[]

---

outputs

Get Signature

get outputs(): readonly SqlVarDesc[];

Defined in: packages/core/src/api/prepared.ts:53

Described output columns.

Returns

readonly SqlVarDesc[]

Methods

[asyncDispose]()

asyncDispose: Promise<void>;

Defined in: packages/core/src/api/prepared.ts:151

await using stmt = await db.prepare(…) → closes at scope exit.

Returns

Promise<void>

---

close()

close(): Promise<void>;

Defined in: packages/core/src/api/prepared.ts:156

Release the server-side handle (deferred; rides with the next packet).

Returns

Promise<void>

---

execute()

execute(
   params?, 
   tx?, 
options?): Promise<number>;

Defined in: packages/core/src/api/prepared.ts:114

Parameters

Parameter	Type	Default value
params	QueryParams	[]
tx?	Transaction	undefined
options?	QueryOptions	undefined

Returns

Promise<number>

---

executeBatch()

executeBatch(
   rows, 
   tx?, 
options?): Promise<BatchResult>;

Defined in: packages/core/src/api/prepared.ts:124

Bulk-run this statement against many parameter rows via the wire batch API (Firebird 4+) — in the given transaction, or a one-shot one. Repeat calls reuse the prepared handle: zero prepare cost per batch. See Attachment.executeBatch.

Parameters

Parameter	Type
rows	BatchRows
tx?	Transaction
options?	BatchOptions

Returns

Promise<BatchResult>

---

query()

query<T>(
   params?, 
   tx?, 
options?): Promise<T[]>;

Defined in: packages/core/src/api/prepared.ts:105

Type Parameters

Type Parameter	Default type
T	Row

Parameters

Parameter	Type	Default value
params	QueryParams	[]
tx?	Transaction	undefined
options?	QueryOptions	undefined

Returns

Promise<T[]>

---

queryOne()

queryOne<T>(
   params?, 
   tx?, 
options?): Promise<T | undefined>;

Defined in: packages/core/src/api/prepared.ts:110

First row or undefined (see Attachment.queryOne).

Type Parameters

Type Parameter	Default type
T	Row

Parameters

Parameter	Type	Default value
params	QueryParams	[]
tx?	Transaction	undefined
options?	QueryOptions	undefined

Returns

Promise<T | undefined>

---

run()

run<T>(
   params?, 
   tx?, 
options?): Promise<QueryResult<T>>;

Defined in: packages/core/src/api/prepared.ts:67

Run inside an explicit transaction, or a one-shot one when omitted.

Type Parameters

Type Parameter	Default type
T	Row

Parameters

Parameter	Type	Default value
params	QueryParams	[]
tx?	Transaction	undefined
options?	QueryOptions	undefined

Returns

Promise<QueryResult<T>>