Function: useLiveQuery()#
Call Signature#
function useLiveQuery<TContext>(queryFn): object;
Defined in: useLiveQuery.ts:80
Create a live query using a query function
Type Parameters#
TContext#
TContext extends Context
Parameters#
queryFn#
(q) => QueryBuilder<TContext>
Query function that defines what data to fetch
Returns#
object
Object with reactive data, state, and status information
collection#
collection: Accessor<Collection<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }, string | number, {
}, StandardSchemaV1<unknown, unknown>, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>>;
data#
data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];
isCleanedUp#
isCleanedUp: Accessor<boolean>;
isError#
isError: Accessor<boolean>;
isIdle#
isIdle: Accessor<boolean>;
isLoading#
isLoading: Accessor<boolean>;
isReady#
isReady: Accessor<boolean>;
state#
state: ReactiveMap<string | number, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
status#
status: Accessor<CollectionStatus>;
Examples#
// Basic query with object syntax
const todosQuery = useLiveQuery((q) =>
q.from({ todos: todosCollection })
.where(({ todos }) => eq(todos.completed, false))
.select(({ todos }) => ({ id: todos.id, text: todos.text }))
)
// With dependencies that trigger re-execution
const todosQuery = useLiveQuery(
(q) => q.from({ todos: todosCollection })
.where(({ todos }) => gt(todos.priority, minPriority())),
)
// Join pattern
const personIssues = useLiveQuery((q) =>
q.from({ issues: issueCollection })
.join({ persons: personCollection }, ({ issues, persons }) =>
eq(issues.userId, persons.id)
)
.select(({ issues, persons }) => ({
id: issues.id,
title: issues.title,
userName: persons.name
}))
)
// Handle loading and error states
const todosQuery = useLiveQuery((q) =>
q.from({ todos: todoCollection })
)
return (
<Switch>
<Match when={todosQuery.isLoading()}>
<div>Loading...</div>
</Match>
<Match when={todosQuery.isError()}>
<div>Error: {todosQuery.status()}</div>
</Match>
<Match when={todosQuery.isReady()}>
<For each={todosQuery.data()}>
{(todo) => <li key={todo.id}>{todo.text}</li>}
</For>
</Match>
</Switch>
)
Call Signature#
function useLiveQuery<TContext>(config): object;
Defined in: useLiveQuery.ts:135
Create a live query using configuration object
Type Parameters#
TContext#
TContext extends Context
Parameters#
config#
Accessor<LiveQueryCollectionConfig<TContext, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] } & object>>
Configuration object with query and options
Returns#
object
Object with reactive data, state, and status information
collection#
collection: Accessor<Collection<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }, string | number, {
}, StandardSchemaV1<unknown, unknown>, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>>;
data#
data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];
isCleanedUp#
isCleanedUp: Accessor<boolean>;
isError#
isError: Accessor<boolean>;
isIdle#
isIdle: Accessor<boolean>;
isLoading#
isLoading: Accessor<boolean>;
isReady#
isReady: Accessor<boolean>;
state#
state: ReactiveMap<string | number, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
status#
status: Accessor<CollectionStatus>;
Examples#
// Basic config object usage
const todosQuery = useLiveQuery(() => ({
query: (q) => q.from({ todos: todosCollection }),
gcTime: 60000
}))
// With query builder and options
const queryBuilder = new Query()
.from({ persons: collection })
.where(({ persons }) => gt(persons.age, 30))
.select(({ persons }) => ({ id: persons.id, name: persons.name }))
const personsQuery = useLiveQuery(() => ({ query: queryBuilder }))
// Handle all states uniformly
const itemsQuery = useLiveQuery(() => ({
query: (q) => q.from({ items: itemCollection })
}))
return (
<Switch fallback={<div>{itemsQuery.data.length} items loaded</div>}>
<Match when={itemsQuery.isLoading()}>
<div>Loading...</div>
</Match>
<Match when={itemsQuery.isError()}>
<div>Something went wrong</div>
</Match>
<Match when={!itemsQuery.isReady()}>
<div>Preparing...</div>
</Match>
</Switch>
)
Call Signature#
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
Defined in: useLiveQuery.ts:185
Subscribe to an existing live query collection
Type Parameters#
TResult#
TResult extends object
TKey#
TKey extends string | number
TUtils#
TUtils extends Record<string, any>
Parameters#
liveQueryCollection#
Accessor<Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>>
Pre-created live query collection to subscribe to
Returns#
object
Object with reactive data, state, and status information
collection#
collection: Accessor<Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>>;
data#
data: TResult[];
isCleanedUp#
isCleanedUp: Accessor<boolean>;
isError#
isError: Accessor<boolean>;
isIdle#
isIdle: Accessor<boolean>;
isLoading#
isLoading: Accessor<boolean>;
isReady#
isReady: Accessor<boolean>;
state#
state: ReactiveMap<TKey, TResult>;
status#
status: Accessor<CollectionStatus>;
Examples#
// Using pre-created live query collection
const myLiveQuery = createLiveQueryCollection((q) =>
q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
)
const todosQuery = useLiveQuery(() => myLiveQuery)
// Access collection methods directly
const existingQuery = useLiveQuery(() => existingCollection)
// Use collection for mutations
const handleToggle = (id) => {
existingQuery.collection().update(id, draft => { draft.completed = !draft.completed })
}
// Handle states consistently
const sharedQuery = useLiveQuery(() => sharedCollection)
return (
<Switch fallback={<div><For each={sharedQuery.data()}>{(item) => <Item key={item.id} {...item} />}</For></div>}>
<Match when={sharedQuery.isLoading()}>
<div>Loading...</div>
</Match>
<Match when={sharedQuery.isError()}>
<div>Error loading data</div>
</Match>
</Switch>
)