TanStack
DB v0
Auto
Framework
Version
Menü
Erste Schritte
Anleitungen
Collections
API-Referenz

useLiveQuery

Funktion: useLiveQuery()

Aufruf-Signatur

ts
function useLiveQuery<TContext>(queryFn, deps?): object

function useLiveQuery<TContext>(queryFn, deps?): object

Definiert in: useLiveQuery.ts:64

Erstellt eine Live-Abfrage mit einer Abfragefunktion

Typparameter

• TContext erweitert Context

Parameter

queryFn

(q) => QueryBuilder<TContext>

Abfragefunktion, die definiert, welche Daten abgerufen werden sollen

deps?

unbekannt[]

Array von Abhängigkeiten, die die erneute Ausführung der Abfrage auslösen, wenn sie sich ändern

Gibt zurück

Objekt

Objekt mit reaktiven Daten, Zustand und Statusinformationen

collection
ts
collection: 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, {}>;

collection: 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, {}>;

data
ts
data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];

data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];

isCleanedUp
ts
isCleanedUp: boolean;

isCleanedUp: boolean;

isError
ts
isError: boolean;

isError: boolean;

isIdle
ts
isIdle: boolean;

isIdle: boolean;

isLoading
ts
isLoading: boolean;

isLoading: boolean;

isReady
ts
isReady: boolean;

isReady: boolean;

state
ts
state: Map<string | number, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;

state: Map<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
ts
status: CollectionStatus;

status: CollectionStatus;

Beispiele
ts
// Basic query with object syntax
const { data, isLoading } = useLiveQuery((q) =>
  q.from({ todos: todosCollection })
   .where(({ todos }) => eq(todos.completed, false))
   .select(({ todos }) => ({ id: todos.id, text: todos.text }))
)

// Basic query with object syntax
const { data, isLoading } = useLiveQuery((q) =>
  q.from({ todos: todosCollection })
   .where(({ todos }) => eq(todos.completed, false))
   .select(({ todos }) => ({ id: todos.id, text: todos.text }))
)
ts
// With dependencies that trigger re-execution
const { data, state } = useLiveQuery(
  (q) => q.from({ todos: todosCollection })
         .where(({ todos }) => gt(todos.priority, minPriority)),
  [minPriority] // Re-run when minPriority changes
)

// With dependencies that trigger re-execution
const { data, state } = useLiveQuery(
  (q) => q.from({ todos: todosCollection })
         .where(({ todos }) => gt(todos.priority, minPriority)),
  [minPriority] // Re-run when minPriority changes
)
ts
// Join pattern
const { data } = 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
   }))
)

// Join pattern
const { data } = 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
   }))
)
ts
// Handle loading and error states
const { data, isLoading, isError, status } = useLiveQuery((q) =>
  q.from({ todos: todoCollection })
)

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Error: {status}</div>

return (
  <ul>
    {data.map(todo => <li key={todo.id}>{todo.text}</li>)}
  </ul>
)

// Handle loading and error states
const { data, isLoading, isError, status } = useLiveQuery((q) =>
  q.from({ todos: todoCollection })
)

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Error: {status}</div>

return (
  <ul>
    {data.map(todo => <li key={todo.id}>{todo.text}</li>)}
  </ul>
)

Aufruf-Signatur
ts
function useLiveQuery<TContext>(config, deps?): object

function useLiveQuery<TContext>(config, deps?): object

Definiert in: useLiveQuery.ts:113

Erstellt eine Live-Abfrage mit einem Konfigurationsobjekt

Typparameter

• TContext erweitert Context

Parameter

config

LiveQueryCollectionConfig<TContext>

Konfigurationsobjekt mit Abfrage und Optionen

deps?

unbekannt[]

Array von Abhängigkeiten, die die erneute Ausführung der Abfrage auslösen, wenn sie sich ändern

Gibt zurück

Objekt

Objekt mit reaktiven Daten, Zustand und Statusinformationen

collection
ts
collection: 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, {}>;

collection: 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, {}>;

data
ts
data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];

data: { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[];

isCleanedUp
ts
isCleanedUp: boolean;

isCleanedUp: boolean;

isError
ts
isError: boolean;

isError: boolean;

isIdle
ts
isIdle: boolean;

isIdle: boolean;

isLoading
ts
isLoading: boolean;

isLoading: boolean;

isReady
ts
isReady: boolean;

isReady: boolean;

state
ts
state: Map<string | number, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;

state: Map<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
ts
status: CollectionStatus;

status: CollectionStatus;

Beispiele
ts
// Basic config object usage
const { data, status } = useLiveQuery({
  query: (q) => q.from({ todos: todosCollection }),
  gcTime: 60000
})

// Basic config object usage
const { data, status } = useLiveQuery({
  query: (q) => q.from({ todos: todosCollection }),
  gcTime: 60000
})
ts
// 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 { data, isReady } = useLiveQuery({ query: queryBuilder })

// 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 { data, isReady } = useLiveQuery({ query: queryBuilder })
ts
// Handle all states uniformly
const { data, isLoading, isReady, isError } = useLiveQuery({
  query: (q) => q.from({ items: itemCollection })
})

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Something went wrong</div>
if (!isReady) return <div>Preparing...</div>

return <div>{data.length} items loaded</div>

// Handle all states uniformly
const { data, isLoading, isReady, isError } = useLiveQuery({
  query: (q) => q.from({ items: itemCollection })
})

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Something went wrong</div>
if (!isReady) return <div>Preparing...</div>

return <div>{data.length} items loaded</div>

Aufruf-Signatur
ts
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object

function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object

Definiert in: useLiveQuery.ts:158

Abonniert eine bestehende Live-Abfragesammlung

Typparameter

• TResult erweitert object

• TKey erweitert string | number

• TUtils erweitert Record<string, any>

Parameter

liveQueryCollection

Collection<TResult, TKey, TUtils>

Vorher erstellte Live-Abfragesammlung zum Abonnieren

Gibt zurück

Objekt

Objekt mit reaktiven Daten, Zustand und Statusinformationen

collection
ts
collection: Collection<TResult, TKey, TUtils>;

collection: Collection<TResult, TKey, TUtils>;

data
ts
data: TResult[];

data: TResult[];

isCleanedUp
ts
isCleanedUp: boolean;

isCleanedUp: boolean;

isError
ts
isError: boolean;

isError: boolean;

isIdle
ts
isIdle: boolean;

isIdle: boolean;

isLoading
ts
isLoading: boolean;

isLoading: boolean;

isReady
ts
isReady: boolean;

isReady: boolean;

state
ts
state: Map<TKey, TResult>;

state: Map<TKey, TResult>;

status
ts
status: CollectionStatus;

status: CollectionStatus;

Beispiele
ts
// Using pre-created live query collection
const myLiveQuery = createLiveQueryCollection((q) =>
  q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
)
const { data, collection } = useLiveQuery(myLiveQuery)

// Using pre-created live query collection
const myLiveQuery = createLiveQueryCollection((q) =>
  q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
)
const { data, collection } = useLiveQuery(myLiveQuery)
ts
// Access collection methods directly
const { data, collection, isReady } = useLiveQuery(existingCollection)

// Use collection for mutations
const handleToggle = (id) => {
  collection.update(id, draft => { draft.completed = !draft.completed })
}

// Access collection methods directly
const { data, collection, isReady } = useLiveQuery(existingCollection)

// Use collection for mutations
const handleToggle = (id) => {
  collection.update(id, draft => { draft.completed = !draft.completed })
}
ts
// Handle states consistently
const { data, isLoading, isError } = useLiveQuery(sharedCollection)

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Error loading data</div>

return <div>{data.map(item => <Item key={item.id} {...item} />)}</div>

// Handle states consistently
const { data, isLoading, isError } = useLiveQuery(sharedCollection)

if (isLoading) return <div>Loading...</div>
if (isError) return <div>Error loading data</div>

return <div>{data.map(item => <Item key={item.id} {...item} />)}</div>
Auf GitHub bearbeiten
React Hooks
Unsere Partner
Code Rabbit
Electric
Prisma
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.