TanStack
DB
v0
Auto
Framework
React
Version
Latest
Search...
+ K
Menu
Home
Frameworks
Contributors
GitHub
Discord
Getting Started
Overview
core
Quick Start
core
Installation
core
Guides
Live Queries
core
SSR and Hydration
core
Mutations
core
Schemas
core
Error Handling
core
Creating Collection Options Creators
core
Collections
Query Collection
core
Electric Collection
core
TrailBase Collection
core
RxDB Collection
core
PowerSync Collection
core
LocalStorage Collection
core
LocalOnly Collection
core
Frameworks
React
core
Vue
core
Angular
core
Solid
core
Svelte
core
Community
Resources & Packages
core
API Reference
Core API Reference
core
Collection
core
createCollection
core
liveQueryCollectionOptions
core
createLiveQueryCollection
core
createOptimisticAction
core
createTransaction
core
Electric DB Collection
core
electricCollectionOptions
core
Query DB Collection
core
queryCollectionOptions
core
RxDB DB Collection
core
rxdbCollectionOptions
core
PowerSync Collection
core
powerSyncCollectionOptions
core
React Hooks
react
useLiveQuery
react
TanStack
DB
v0
Auto
Search...
+ K
Framework
React
Version
Latest
Menu
Home
Frameworks
Contributors
GitHub
Discord
Getting Started
Overview
core
Quick Start
core
Installation
core
Guides
Live Queries
core
SSR and Hydration
core
Mutations
core
Schemas
core
Error Handling
core
Creating Collection Options Creators
core
Collections
Query Collection
core
Electric Collection
core
TrailBase Collection
core
RxDB Collection
core
PowerSync Collection
core
LocalStorage Collection
core
LocalOnly Collection
core
Frameworks
React
core
Vue
core
Angular
core
Solid
core
Svelte
core
Community
Resources & Packages
core
API Reference
Core API Reference
core
Collection
core
createCollection
core
liveQueryCollectionOptions
core
createLiveQueryCollection
core
createOptimisticAction
core
createTransaction
core
Electric DB Collection
core
electricCollectionOptions
core
Query DB Collection
core
queryCollectionOptions
core
RxDB DB Collection
core
rxdbCollectionOptions
core
PowerSync Collection
core
powerSyncCollectionOptions
core
React Hooks
react
useLiveQuery
react
On this page
Namespaces
Classes
Interfaces
Type Aliases
Variables
Functions
@tanstack/db
Namespaces
IR
Classes
AggregateFunctionNotInSelectError
BaseIndex
BaseQueryBuilder
BasicIndex
BTreeIndex
CannotCombineEmptyExpressionListError
CollectionConfigurationError
CollectionImpl
CollectionInErrorStateError
CollectionInputNotFoundError
CollectionIsInErrorStateError
CollectionOperationError
CollectionPreloadAbortedError
CollectionRequiresConfigError
CollectionRequiresSyncConfigError
CollectionStateError
DbClient
DeduplicatedLoadSubset
DeleteKeyNotFoundError
DistinctRequiresSelectError
DuplicateAliasInSubqueryError
DuplicateDbInstanceError
DuplicateKeyError
DuplicateKeySyncError
EmptyReferencePathError
FnSelectWithGroupByError
GroupByError
HavingRequiresGroupByError
InvalidCollectionStatusTransitionError
InvalidJoinCondition
InvalidJoinConditionLeftSourceError
InvalidJoinConditionRightSourceError
InvalidJoinConditionSameSourceError
InvalidJoinConditionSourceMismatchError
InvalidKeyError
InvalidSchemaError
InvalidSourceError
InvalidSourceTypeError
InvalidStorageDataFormatError
InvalidStorageObjectFormatError
InvalidWhereExpressionError
JoinCollectionNotFoundError
JoinConditionMustBeEqualityError
JoinError
KeyUpdateNotAllowedError
LimitOffsetRequireOrderByError
LiveQueryObserverDisposedError
LiveQueryWindowControllerDisposedError
LoadSubsetOperationAbortedError
LocalStorageCollectionError
MissingAliasInputsError
MissingDeleteHandlerError
MissingHandlerError
MissingInsertHandlerError
MissingMutationFunctionError
MissingUpdateArgumentError
MissingUpdateHandlerError
NegativeActiveSubscribersError
NoKeysPassedToDeleteError
NoKeysPassedToUpdateError
NonAggregateExpressionNotInGroupByError
NonRetriableError
NoPendingSyncTransactionCommitError
NoPendingSyncTransactionWriteError
OnlyOneSourceAllowedError
OnMutateMustBeSynchronousError
QueryBuilderError
QueryCompilationError
QueryMustHaveFromClauseError
QueryOptimizerError
ReverseIndex
SchemaMustBeSynchronousError
SchemaValidationError
SerializationError
SetWindowReentrancyError
SetWindowRequiresOrderByError
SortedMap
StorageError
StorageKeyRequiredError
SubQueryMustHaveFromClauseError
SyncCleanupError
SyncTransactionAbortedError
SyncTransactionAlreadyCommittedError
SyncTransactionAlreadyCommittedWriteError
TanStackDBError
TransactionAlreadyCompletedRollbackError
TransactionError
TransactionNotPendingCommitError
TransactionNotPendingMutateError
TransactionScope
UndefinedKeyError
UnhashableQueryIRError
UnknownExpressionTypeError
UnknownFunctionError
UnknownHavingExpressionTypeError
UnsafeAliasPathError
UnsupportedAggregateFunctionError
UnsupportedFnSelectResultError
UnsupportedFromTypeError
UnsupportedJoinSourceTypeError
UnsupportedJoinTypeError
UnsupportedRootScalarSelectError
UpdateKeyNotFoundError
Interfaces
BaseCollectionConfig
BaseStrategy
BasicIndexOptions
BTreeRangeQueryOptions
ChangeMessage
Collection
CollectionConfig
CollectionIndexMetadata
CollectionLike
Context
CreateLiveQueryObserverOptions
CreateLiveQueryWindowControllerOptions
CreateOptimisticActionsOptions
CurrentStateAsChangesOptions
DebounceStrategy
DebounceStrategyOptions
Effect
EffectConfig
EffectContext
IndexDevModeConfig
IndexInterface
IndexOptions
IndexSuggestion
InsertConfig
LiveQueryCollectionConfig
LiveQueryObserver
LiveQuerySnapshot
LiveQueryStatusFlags
LiveQueryWindowController
LiveQueryWindowSnapshot
LocalOnlyCollectionConfig
LocalOnlyCollectionUtils
LocalStorageCollectionConfig
LocalStorageCollectionUtils
OperationConfig
PacedMutationsConfig
ParsedOrderBy
Parser
ParseWhereOptions
PendingMutation
QueryOnceConfig
QueueStrategy
QueueStrategyOptions
RangeQueryOptions
SimpleComparison
SubscribeChangesOptions
SubscribeChangesSnapshotOptions
Subscription
SubscriptionLoadSubsetErrorEvent
SubscriptionStatusChangeEvent
SubscriptionStatusEvent
SubscriptionUnsubscribedEvent
SyncConfig
SyncMetadataApi
ThrottleStrategy
ThrottleStrategyOptions
Transaction
TransactionConfig
VirtualRowProps
Type Aliases
ApplyJoinOptionalityToMergedSchema
ChangeListener
ChangeMessageOrDeleteKeyMessage
ChangesPayload
CleanupFn
ClearStorageFn
CollectionConfigSingleRowOption
CollectionMaterializeOptions
CollectionOptions
CollectionStatus
ContextFromSource
ContextFromUnionBranches
ContextFromUnionSource
ContextSchema
CursorExpressions
DbClientEvent
DbClientLiveQuery
DbClientLiveQueryState
DbClientOptions
DeferredLiveQueryCollections
DehydrateDbClientOptions
DehydratedCollectionChunk
DehydratedCollectionRow
DehydratedDbState
DehydratedLiveQuery
DehydratedLiveQueryResult
DeleteKeyMessage
DeleteMutationFn
DeleteMutationFnParams
DeltaEvent
DeltaType
DemandKey
EffectQueryInput
ExtractContext
FieldPath
Fn
FunctionalHavingRow
GetResult
GetStorageSizeFn
GroupByCallback
IndexConstructor
IndexOperation
IndexOperation
IndexReader
InferCollectionType
InferResultType
InferSchemaInput
InferSchemaOutput
InitialQueryBuilder
InputRow
InsertMutationFn
InsertMutationFnParams
JoinOnCallback
KeyedNamespacedRow
KeyedStream
LiveQueryCollectionUtils
LiveQueryKey
LiveQueryObserverListener
LiveQueryOptions
LiveQueryWindowCollection
LiveQueryWindowInputKind
LoadSubsetFn
LoadSubsetOptions
LoadSubsetRequestResult
MakeOptional
MaybeSingleResult
MergeContextForJoinCallback
MergeContextWithJoinType
MutationFn
MutationFnParams
NamespacedAndKeyedStream
NamespacedRow
NonEmptyArray
NonSingleResult
OperationType
OperatorName
OptimisticChangeMessage
OrderByCallback
Prettify
QueryBuilder
QueryIdentity
QueryResult
Ref
RefsForContext
ResolvedLiveQueryWindowInput
ResolveTransactionChanges
ResultStream
ResultTypeFromSelect
Row
SchemaFromSource
SelectObject
SingleResult
SingleSource
Source
SourceClauseContext
StandardSchema
StandardSchemaAlias
StorageApi
StorageEventApi
Strategy
StrategyOptions
StringCollationConfig
SubscriptionEvents
SubscriptionStatus
SyncAppliedReceipt
SyncConfigRes
SyncMode
TransactionState
TransactionWithMutations
UnloadSubsetFn
UpdateMutationFn
UpdateMutationFnParams
UtilsRecord
VirtualOrigin
WhereCallback
WithoutVirtualProps
WithResult
WithVirtualProps
WritableDeep
Variables
operators
Query
Functions
add
and
assertLiveQueryWindowManyResult
avg
canonicalizeQueryIR
caseWhen
clearQueryPatterns
coalesce
collectionOptions
compareLiveQueryWindowDependencies
compileExpression
compileQuery
compileSingleRowExpression
concat
configureIndexDevMode
count
createArrayChangeProxy
createChangeProxy
createCollection
createEffect
createLiveQueryCollection
createLiveQueryObserver
createLiveQueryWindowController
createOptimisticAction
createPacedMutations
createTransaction
debounceStrategy
deepEquals
divide
eq
extractFieldPath
extractSimpleComparisons
extractValue
fetchNextLiveQueryWindowPage
findIndexForField
getActiveTransaction
getIndexDevModeConfig
getLiveQueryHash
getLiveQueryStatusFlags
getLiveQueryWindowCollectionWarning
getLiveQueryWindowInputKind
getLoadSubsetDemandKey
getPreparedLiveQueryIdentity
getQueryIdentity
getQueryPatterns
getStableQueryBuilderHash
getStableQueryIRHash
getStableValueHash
gt
gte
hasLiveQueryWindowLeases
hasVirtualProps
ilike
inArray
isCollection
isCollectionOptions
isDevModeEnabled
isLiveQueryWindowCollection
isNull
isSingleResultCollection
isUndefined
length
like
liveQueryCollectionOptions
localOnlyCollectionOptions
localStorageCollectionOptions
lower
lt
lte
materialize
max
min
multiply
normalizeLiveQueryWindowPageSize
not
optimizeExpressionWithIndexes
or
parseLoadSubsetOptions
parseOrderByExpression
parseWhereExpression
prepareLiveQueryValue
queryOnce
queueStrategy
resolveLiveQueryWindowInput
safeRandomUUID
shouldPreserveLiveQueryWindowPageCount
subtract
sum
throttleStrategy
toArray
toBooleanPredicate
trackQuery
upper
walkExpression
withArrayChangeTracking
withChangeTracking
withCollectionConfigFactory
withCollectionSyncConfigCleanup
withCollectionSyncConfigFactory
Edit on GitHub
On this page
Namespaces
Classes
Interfaces
Type Aliases
Variables
Functions
Resources & Packages
Collection
Our Partners
Wow, it looks like you could be our first partner for this library!
Chat with us!
TanStack
Start
Full-document SSR, Streaming, Server Functions, bundling and more, powered by TanStack Router and Vite - Ready to deploy to your favorite hosting provider.
Learn More
TanStack
React Charts
Learn More