@tanstack/db#

Namespaces#

• IR

Classes#

• AggregateFunctionNotInSelectError
• AggregateNotSupportedError
• BaseIndex
• BaseQueryBuilder
• BasicIndex
• BTreeIndex
• CannotCombineEmptyExpressionListError
• CollectionConfigurationError
• CollectionImpl
• CollectionInErrorStateError
• CollectionInputNotFoundError
• CollectionIsInErrorStateError
• CollectionOperationError
• CollectionRequiresConfigError
• CollectionRequiresSyncConfigError
• CollectionStateError
• 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
• 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
• SetWindowRequiresOrderByError
• SortedMap
• StorageError
• StorageKeyRequiredError
• SubQueryMustHaveFromClauseError
• SubscriptionNotFoundError
• SyncCleanupError
• SyncTransactionAlreadyCommittedError
• SyncTransactionAlreadyCommittedWriteError
• TanStackDBError
• TransactionAlreadyCompletedRollbackError
• TransactionError
• TransactionNotPendingCommitError
• TransactionNotPendingMutateError
• UndefinedKeyError
• UnknownExpressionTypeError
• UnknownFunctionError
• UnknownHavingExpressionTypeError
• UnsafeAliasPathError
• UnsupportedAggregateFunctionError
• UnsupportedFromTypeError
• UnsupportedJoinSourceTypeError
• UnsupportedJoinTypeError
• UnsupportedRootScalarSelectError
• UpdateKeyNotFoundError
• WhereClauseConversionError

Interfaces#

• BaseCollectionConfig
• BaseStrategy
• BasicIndexOptions
• BTreeRangeQueryOptions
• ChangeMessage
• Collection
• CollectionConfig
• CollectionIndexMetadata
• CollectionLike
• Context
• CreateOptimisticActionsOptions
• CurrentStateAsChangesOptions
• DebounceStrategy
• DebounceStrategyOptions
• Effect
• EffectConfig
• EffectContext
• IndexDevModeConfig
• IndexInterface
• IndexOptions
• IndexStats
• IndexSuggestion
• InsertConfig
• LiveQueryCollectionConfig
• LiveQueryStatusFlags
• LocalOnlyCollectionConfig
• LocalOnlyCollectionUtils
• LocalStorageCollectionConfig
• LocalStorageCollectionUtils
• OperationConfig
• PacedMutationsConfig
• ParsedOrderBy
• Parser
• ParseWhereOptions
• PendingMutation
• QueryOnceConfig
• QueueStrategy
• QueueStrategyOptions
• RangeQueryOptions
• SimpleComparison
• SubscribeChangesOptions
• SubscribeChangesSnapshotOptions
• Subscription
• SubscriptionStatusChangeEvent
• SubscriptionStatusEvent
• SubscriptionUnsubscribedEvent
• SyncConfig
• SyncMetadataApi
• ThrottleStrategy
• ThrottleStrategyOptions
• Transaction
• TransactionConfig
• VirtualRowProps

Type Aliases#

• ApplyJoinOptionalityToMergedSchema
• ChangeListener
• ChangeMessageOrDeleteKeyMessage
• ChangesPayload
• CleanupFn
• ClearStorageFn
• CollectionConfigSingleRowOption
• CollectionStatus
• ContextFromSource
• ContextFromUnionBranches
• ContextFromUnionSource
• ContextSchema
• CursorExpressions
• DeleteKeyMessage
• DeleteMutationFn
• DeleteMutationFnParams
• DeltaEvent
• DeltaType
• EffectQueryInput
• ExtractContext
• FieldPath
• Fn
• FunctionalHavingRow
• GetResult
• GetStorageSizeFn
• GroupByCallback
• IndexConstructor
• IndexOperation
• IndexOperation
• InferCollectionType
• InferResultType
• InferSchemaInput
• InferSchemaOutput
• InitialQueryBuilder
• InputRow
• InsertMutationFn
• InsertMutationFnParams
• JoinOnCallback
• KeyedNamespacedRow
• KeyedStream
• LiveQueryCollectionUtils
• LoadSubsetFn
• LoadSubsetOptions
• MakeOptional
• MaybeSingleResult
• MergeContextForJoinCallback
• MergeContextWithJoinType
• MutationFn
• MutationFnParams
• NamespacedAndKeyedStream
• NamespacedRow
• NonEmptyArray
• NonSingleResult
• OperationType
• OperatorName
• OptimisticChangeMessage
• OrderByCallback
• Prettify
• QueryBuilder
• QueryResult
• Ref
• RefsForContext
• ResolveTransactionChanges
• ResultStream
• ResultTypeFromSelect
• Row
• SchemaFromSource
• SelectObject
• SingleResult
• SingleSource
• Source
• SourceClauseContext
• StandardSchema
• StandardSchemaAlias
• StorageApi
• StorageEventApi
• Strategy
• StrategyOptions
• StringCollationConfig
• SubscriptionEvents
• SubscriptionStatus
• SyncConfigRes
• SyncMode
• TransactionState
• TransactionWithMutations
• UnloadSubsetFn
• UpdateMutationFn
• UpdateMutationFnParams
• UtilsRecord
• VirtualOrigin
• WhereCallback
• WithoutVirtualProps
• WithResult
• WithVirtualProps
• WritableDeep

Variables#

• operators
• Query

Functions#

• add
• and
• avg
• caseWhen
• clearQueryPatterns
• coalesce
• compileExpression
• compileQuery
• compileSingleRowExpression
• concat
• configureIndexDevMode
• count
• createArrayChangeProxy
• createChangeProxy
• createCollection
• createEffect
• createLiveQueryCollection
• createOptimisticAction
• createPacedMutations
• createTransaction
• debounceStrategy
• deepEquals
• divide
• eq
• extractFieldPath
• extractSimpleComparisons
• extractValue
• findIndexForField
• getActiveTransaction
• getIndexDevModeConfig
• getLiveQueryStatusFlags
• getQueryPatterns
• gt
• gte
• hasVirtualProps
• ilike
• inArray
• isCollection
• isDevModeEnabled
• isLimitSubset
• isNull
• isOffsetLimitSubset
• isOrderBySubset
• isPredicateSubset
• isSingleResultCollection
• isUndefined
• isWhereSubset
• length
• like
• liveQueryCollectionOptions
• localOnlyCollectionOptions
• localStorageCollectionOptions
• lower
• lt
• lte
• materialize
• max
• min
• minusWherePredicates
• multiply
• not
• optimizeExpressionWithIndexes
• or
• parseLoadSubsetOptions
• parseOrderByExpression
• parseWhereExpression
• queryOnce
• queueStrategy
• safeRandomUUID
• subtract
• sum
• throttleStrategy
• toArray
• toBooleanPredicate
• trackQuery
• unionWherePredicates
• upper
• walkExpression
• withArrayChangeTracking
• withChangeTracking