@tanstack/db

Namespaces#

• IR

Classes#

• AggregateFunctionNotInSelectError

• BaseIndex

• BaseQueryBuilder

• BasicIndex

• BTreeIndex

• CannotCombineEmptyExpressionListError

• CollectionConfigurationError

• CollectionImpl

• CollectionInErrorStateError

• CollectionInputNotFoundError

• CollectionIsInErrorStateError

• CollectionOperationError

• CollectionPreloadAbortedError

• CollectionRequiresConfigError

• CollectionRequiresSyncConfigError

• CollectionStateError

• DatabaseRequiredError

• DbClient

• DebounceCallDroppedError

• DeduplicatedLoadSubset

• DeleteKeyNotFoundError

• DistinctRequiresSelectError

• DuplicateAliasInSubqueryError

• DuplicateDbInstanceError

• DuplicateKeyError

• DuplicateKeySyncError

• DuplicateTransactionIdError

• EmptyReferencePathError

• FnSelectWithGroupByError

• GetKeyRequiredError

• GroupByError

• HavingRequiresGroupByError

• InvalidCollectionStatusTransitionError

• InvalidJoinCondition

• InvalidJoinConditionLeftSourceError

• InvalidJoinConditionRightSourceError

• InvalidJoinConditionSameSourceError

• InvalidJoinConditionSourceMismatchError

• InvalidKeyError

• InvalidSchemaError

• InvalidSourceError

• InvalidSourceTypeError

• InvalidStorageDataFormatError

• InvalidStorageObjectFormatError

• InvalidSyncPersistenceCapabilityError

• InvalidWhereExpressionError

• JoinCollectionNotFoundError

• JoinConditionMustBeEqualityError

• JoinError

• KeyUpdateNotAllowedError

• LimitOffsetRequireOrderByError

• LiveQueryObserverDisposedError

• LiveQueryWindowControllerDisposedError

• LoadSubsetOperationAbortedError

• LocalStorageCollectionError

• MissingAliasInputsError

• MissingDeleteHandlerError

• MissingHandlerError

• MissingInsertHandlerError

• MissingMutationFunctionError

• MissingUpdateArgumentError

• MissingUpdateHandlerError

• NameRequiredError

• NegativeActiveSubscribersError

• NoKeysPassedToDeleteError

• NoKeysPassedToUpdateError

• NonAggregateExpressionNotInGroupByError

• NonRetriableError

• NoPendingSyncTransactionCommitError

• NoPendingSyncTransactionWriteError

• ObjectStoreNotFoundError

• OnlyOneSourceAllowedError

• OnMutateMustBeSynchronousError

• PacedTransactionManualCommitError

• QueryBuilderError

• QueryCompilationError

• QueryMustHaveFromClauseError

• QueryOptimizerError

• QueueCapacityExceededError

• QueueDisposedError

• ReverseIndex

• SchemaMustBeSynchronousError

• SchemaValidationError

• SerializationError

• SetWindowReentrancyError

• SetWindowRequiresOrderByError

• SortedMap

• StorageError

• StorageKeyRequiredError

• SubQueryMustHaveFromClauseError

• SyncCleanupError

• SyncQueueInvariantError

• SyncRowReusedWithoutPreviousValueError

• SyncTransactionAbortedError

• SyncTransactionAlreadyCommittedError

• SyncTransactionAlreadyCommittedWriteError

• TanStackDBError

• ThrottleCallDroppedError

• 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

• CreateIndexedDBOptions

• CreateLiveQueryObserverOptions

• CreateLiveQueryWindowControllerOptions

• CreateOptimisticActionsOptions

• CurrentStateAsChangesOptions

• DatabaseInfo

• DebounceStrategy

• DebounceStrategyOptions

• Effect

• EffectConfig

• EffectContext

• IndexDevModeConfig

• IndexedDBCollectionConfig

• IndexedDBCollectionUtils

• IndexedDBInstance

• IndexInterface

• IndexOptions

• IndexSuggestion

• InsertConfig

• LiveQueryCollectionConfig

• LiveQueryObserver

• LiveQuerySnapshot

• LiveQueryStatusFlags

• LiveQueryWindowController

• LiveQueryWindowSnapshot

• LocalOnlyCollectionConfig

• LocalOnlyCollectionUtils

• LocalStorageCollectionConfig

• LocalStorageCollectionUtils

• OperationConfig

• PacedMutationsConfig

• ParsedOrderBy

• Parser

• ParseWhereOptions

• PendingMutation

• PersistedReadinessSource

• 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

• CollectionBase

• 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

• LiveQueryPersistedStatus

• LiveQueryWindowCollection

• LiveQueryWindowInputKind

• LoadSubsetFn

• LoadSubsetOptions

• LoadSubsetRequestResult

• MakeOptional

• MaybeSingleResult

• MergeContextForJoinCallback

• MergeContextWithJoinType

• MutationFn

• MutationFnParams

• NamespacedAndKeyedStream

• NamespacedRow

• NonEmptyArray

• NonSingleResult

• OperationType

• OperatorName

• OptimisticChangeMessage

• OrderByCallback

• PersistedReadinessSnapshot

• 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

• SyncPersistenceCapabilityV1

• SyncPersistenceKeySetEvidence

• SyncPersistenceScannedRow

• SyncPersistenceScanOptions

• TransactionState

• TransactionWithMutations

• UnloadSubsetFn

• UpdateMutationFn

• UpdateMutationFnParams

• UtilsRecord

• VirtualOrigin

• WhereCallback

• WithoutVirtualProps

• WithResult

• WithVirtualProps

• WritableDeep

Variables#

• operators

• PERSISTED_READINESS

• Query

• SYNC_PERSISTENCE_PROTOCOL

• SYNC_PERSISTENCE_VERSION

Functions#

• add
• and
• assertLiveQueryWindowManyResult
• avg
• canonicalizeQueryIR
• caseWhen
• clear
• clearQueryPatterns
• coalesce
• collectionOptions
• compareLiveQueryWindowDependencies
• compareTemporalValues
• compileExpression
• compileQuery
• compileSingleRowExpression
• concat
• configureIndexDevMode
• count
• createArrayChangeProxy
• createChangeProxy
• createCollection
• createEffect
• createIndexedDB
• createLiveQueryCollection
• createLiveQueryObserver
• createLiveQueryWindowController
• createObjectStore
• createOptimisticAction
• createPacedMutations
• createTransaction
• debounceStrategy
• deepEquals
• deleteByKey
• deleteDatabase
• divide
• eq
• equalPersistedSnapshotValues
• executeTransaction
• extractFieldPath
• extractSimpleComparisons
• extractValue
• fetchNextLiveQueryWindowPage
• findIndexForField
• getActiveTransaction
• getAll
• getAllKeys
• getByKey
• getIndexDevModeConfig
• getLiveQueryHash
• getLiveQueryStatusFlags
• getLiveQueryWindowCollectionWarning
• getLiveQueryWindowInputKind
• getLoadSubsetDemandKey
• getPersistedReadinessSource
• getPreparedLiveQueryIdentity
• getPublicCollection
• getQueryIdentity
• getQueryPatterns
• getStableQueryBuilderHash
• getStableQueryIRHash
• getStableValueHash
• gt
• gte
• hasLiveQueryWindowLeases
• hasVirtualProps
• ilike
• inArray
• indexedDBCollectionOptions
• isCollection
• isCollectionOptions
• isDevModeEnabled
• isLiveQueryWindowCollection
• isNull
• isSingleResultCollection
• isUndefined
• length
• like
• liveQueryCollectionOptions
• liveQueryWindowMatches
• localOnlyCollectionOptions
• localStorageCollectionOptions
• lower
• lt
• lte
• materialize
• max
• min
• multiply
• normalizeLiveQueryWindowPageSize
• not
• openDatabase
• optimizeExpressionWithIndexes
• or
• parseLoadSubsetOptions
• parseOrderByExpression
• parseWhereExpression
• prepareLiveQueryValue
• put
• queryOnce
• queueStrategy
• resetWarnings
• resolveLiveQueryValue
• resolveLiveQueryWindowInput
• safeRandomUUID
• shouldPreserveLiveQueryWindowPageCount
• subtract
• sum
• throttleStrategy
• toArray
• toBooleanPredicate
• trackQuery
• upper
• validateSyncPersistenceCapability
• walkExpression
• warnOnce
• whenSyncAccepted
• withAcceptedReceipt
• withArrayChangeTracking
• withChangeTracking
• withCollectionConfigFactory
• withCollectionSyncConfigCleanup
• withCollectionSyncConfigFactory
• withFlatChangeTracking