NitroSQLitePreparedQuery
TypeScriptSource files: TypeScript
Reusable compiled Drizzle query with asynchronous execution and row decoding. Each execution binds fresh placeholder values. No native prepared statement is retained, so no finalization is needed. A transaction-bound query must finish before its callback returns; other queries require an open connection.
Extends
SQLitePreparedQuery<{all:T["all"];execute:T["execute"];get:T["get"];run:NitroSQLiteRawQueryResult;type:"async";values:T["values"]; }>
Type Parameters
T
T extends PreparedQueryConfig = PreparedQueryConfig
Result types supplied by Drizzle for each execution method.
Constructors
Constructor
new NitroSQLitePreparedQuery<T>(client, query, logger, fields, executeMethod, _isResponseInArrayMode, customResultMapper?): NitroSQLitePreparedQuery<T>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/session.ts:224
Create a query wrapper without executing SQL.
Parameters
client
NitroSQLiteConnection | Transaction
Open connection or active transaction used for execution.
query
Query
Compiled SQL and positional parameters, including placeholders.
logger
Logger
Receives each query before execution.
fields
SelectedFieldsOrdered | undefined
Ordered selected fields used to decode result rows.
executeMethod
SQLiteExecuteMethod
Method invoked by execute().
_isResponseInArrayMode
boolean
Whether Drizzle expects positional rows.
customResultMapper?
(rows) => unknown
Optional decoder for relational query results.
Returns
NitroSQLitePreparedQuery<T>
Overrides
SQLitePreparedQuery<{ type: 'async' run: NitroSQLiteRawQueryResult all: T['all'] get: T['get'] values: T['values'] execute: T['execute'] }>.constructor
Properties
joinsNotNullableMap?
optional joinsNotNullableMap?: Record<string, boolean>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/drizzle-orm.ts:25
Inherited from
SQLitePreparedQuery.joinsNotNullableMap
Methods
all()
all(placeholderValues?): Promise<T["all"]>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/session.ts:259
Execute SQL and decode every row with the selected fields or custom mapper. Without either, rows are objects keyed by SQLite column names.
Parameters
placeholderValues?
Record<string, unknown>
Values for every named placeholder in the query.
Returns
Promise<T["all"]>
All decoded rows, or the custom mapper's result.
Throws
Rejects on binding, query, or decoding errors, including an inactive client.
Overrides
SQLitePreparedQuery.all
get()
get(placeholderValues?): Promise<T["get"]>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/session.ts:284
Execute SQL and decode its first row.
Parameters
placeholderValues?
Record<string, unknown>
Values for every named placeholder in the query.
Returns
Promise<T["get"]>
The first decoded row, undefined if empty, or the custom mapper's result.
Throws
Rejects on binding, query, or decoding errors, including an inactive client.
Overrides
SQLitePreparedQuery.get
run()
run(placeholderValues?): Promise<NitroSQLiteRawQueryResult>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/session.ts:243
Execute SQL and return Nitro SQLite's raw result, including affected rows.
Parameters
placeholderValues?
Record<string, unknown>
Values for every named placeholder in the query.
Returns
Promise<NitroSQLiteRawQueryResult>
Raw positional rows, column names, and execution metadata.
Throws
Rejects on missing placeholders, invalid bindings, SQLite errors, or a closed connection or finalized transaction.
Overrides
SQLitePreparedQuery.run
values()
values(placeholderValues?): Promise<T["values"]>
Defined in: packages/react-native-nitro-sqlite-drizzle/src/session.ts:311
Execute SQL and return positional rows without Drizzle field decoding.
Parameters
placeholderValues?
Record<string, unknown>
Values for every named placeholder in the query.
Returns
Promise<T["values"]>
Row arrays in SQLite's selected-column order.
Throws
Rejects on binding or query errors, including an inactive client.
Overrides
SQLitePreparedQuery.values