function queryOnce<TQueryFn, TQuery>(queryFn): Promise<InferResultType<ExtractContext<TQuery>>>;
Defined in: packages/db/src/query/query-once.ts:59
Executes a one-shot query and returns the results as an array.
This function creates a live query collection, preloads it, extracts the results, and automatically cleans up the collection. It's ideal for:
TQueryFn extends (q) => QueryBuilder<any>
TQuery extends QueryBuilder<any> = ReturnType<TQueryFn>
TQueryFn & RootQueryFn<TQuery>
A function that receives the query builder and returns a query
Promise<InferResultType<ExtractContext<TQuery>>>
A promise that resolves to an array of query results
// Basic query
const users = await queryOnce((q) =>
q.from({ user: usersCollection })
)
// With filtering and projection
const activeUserNames = await queryOnce((q) =>
q.from({ user: usersCollection })
.where(({ user }) => eq(user.active, true))
.select(({ user }) => ({ name: user.name }))
)
function queryOnce<TQuery>(config): Promise<InferResultType<ExtractContext<TQuery>>>;
Defined in: packages/db/src/query/query-once.ts:83
Executes a one-shot query using a configuration object.
TQuery extends QueryBuilder<any>
QueryOnceConfig<ExtractContext<TQuery>> & object
Configuration object with the query function
Promise<InferResultType<ExtractContext<TQuery>>>
A promise that resolves to an array of query results
const recentOrders = await queryOnce({
query: (q) =>
q.from({ order: ordersCollection })
.orderBy(({ order }) => desc(order.createdAt))
.limit(100),
})