# @tanstack/db # @tanstack/db ## Namespaces - [IR](@tanstack/namespaces/IR/index.md) ## Classes - [AggregateFunctionNotInSelectError](classes/AggregateFunctionNotInSelectError.md) - [AggregateNotSupportedError](classes/AggregateNotSupportedError.md) - [BaseIndex](classes/BaseIndex.md) - [BaseQueryBuilder](classes/BaseQueryBuilder.md) - [BasicIndex](classes/BasicIndex.md) - [BTreeIndex](classes/BTreeIndex.md) - [CannotCombineEmptyExpressionListError](classes/CannotCombineEmptyExpressionListError.md) - [CollectionConfigurationError](classes/CollectionConfigurationError.md) - [CollectionImpl](classes/CollectionImpl.md) - [CollectionInErrorStateError](classes/CollectionInErrorStateError.md) - [CollectionInputNotFoundError](classes/CollectionInputNotFoundError.md) - [CollectionIsInErrorStateError](classes/CollectionIsInErrorStateError.md) - [CollectionOperationError](classes/CollectionOperationError.md) - [CollectionRequiresConfigError](classes/CollectionRequiresConfigError.md) - [CollectionRequiresSyncConfigError](classes/CollectionRequiresSyncConfigError.md) - [CollectionStateError](classes/CollectionStateError.md) - [DeduplicatedLoadSubset](classes/DeduplicatedLoadSubset.md) - [DeleteKeyNotFoundError](classes/DeleteKeyNotFoundError.md) - [DistinctRequiresSelectError](classes/DistinctRequiresSelectError.md) - [DuplicateAliasInSubqueryError](classes/DuplicateAliasInSubqueryError.md) - [DuplicateDbInstanceError](classes/DuplicateDbInstanceError.md) - [DuplicateKeyError](classes/DuplicateKeyError.md) - [DuplicateKeySyncError](classes/DuplicateKeySyncError.md) - [EmptyReferencePathError](classes/EmptyReferencePathError.md) - [FnSelectWithGroupByError](classes/FnSelectWithGroupByError.md) - [GroupByError](classes/GroupByError.md) - [HavingRequiresGroupByError](classes/HavingRequiresGroupByError.md) - [InvalidCollectionStatusTransitionError](classes/InvalidCollectionStatusTransitionError.md) - [InvalidJoinCondition](classes/InvalidJoinCondition.md) - [InvalidJoinConditionLeftSourceError](classes/InvalidJoinConditionLeftSourceError.md) - [InvalidJoinConditionRightSourceError](classes/InvalidJoinConditionRightSourceError.md) - [InvalidJoinConditionSameSourceError](classes/InvalidJoinConditionSameSourceError.md) - [InvalidJoinConditionSourceMismatchError](classes/InvalidJoinConditionSourceMismatchError.md) - [InvalidKeyError](classes/InvalidKeyError.md) - [InvalidSchemaError](classes/InvalidSchemaError.md) - [InvalidSourceError](classes/InvalidSourceError.md) - [InvalidSourceTypeError](classes/InvalidSourceTypeError.md) - [InvalidStorageDataFormatError](classes/InvalidStorageDataFormatError.md) - [InvalidStorageObjectFormatError](classes/InvalidStorageObjectFormatError.md) - [InvalidWhereExpressionError](classes/InvalidWhereExpressionError.md) - [JoinCollectionNotFoundError](classes/JoinCollectionNotFoundError.md) - [JoinConditionMustBeEqualityError](classes/JoinConditionMustBeEqualityError.md) - [JoinError](classes/JoinError.md) - [KeyUpdateNotAllowedError](classes/KeyUpdateNotAllowedError.md) - [LimitOffsetRequireOrderByError](classes/LimitOffsetRequireOrderByError.md) - [LocalStorageCollectionError](classes/LocalStorageCollectionError.md) - [MissingAliasInputsError](classes/MissingAliasInputsError.md) - [MissingDeleteHandlerError](classes/MissingDeleteHandlerError.md) - [MissingHandlerError](classes/MissingHandlerError.md) - [MissingInsertHandlerError](classes/MissingInsertHandlerError.md) - [MissingMutationFunctionError](classes/MissingMutationFunctionError.md) - [MissingUpdateArgumentError](classes/MissingUpdateArgumentError.md) - [MissingUpdateHandlerError](classes/MissingUpdateHandlerError.md) - [NegativeActiveSubscribersError](classes/NegativeActiveSubscribersError.md) - [NoKeysPassedToDeleteError](classes/NoKeysPassedToDeleteError.md) - [NoKeysPassedToUpdateError](classes/NoKeysPassedToUpdateError.md) - [NonAggregateExpressionNotInGroupByError](classes/NonAggregateExpressionNotInGroupByError.md) - [NonRetriableError](classes/NonRetriableError.md) - [NoPendingSyncTransactionCommitError](classes/NoPendingSyncTransactionCommitError.md) - [NoPendingSyncTransactionWriteError](classes/NoPendingSyncTransactionWriteError.md) - [OnlyOneSourceAllowedError](classes/OnlyOneSourceAllowedError.md) - [OnMutateMustBeSynchronousError](classes/OnMutateMustBeSynchronousError.md) - [QueryBuilderError](classes/QueryBuilderError.md) - [QueryCompilationError](classes/QueryCompilationError.md) - [QueryMustHaveFromClauseError](classes/QueryMustHaveFromClauseError.md) - [QueryOptimizerError](classes/QueryOptimizerError.md) - [ReverseIndex](classes/ReverseIndex.md) - [SchemaMustBeSynchronousError](classes/SchemaMustBeSynchronousError.md) - [SchemaValidationError](classes/SchemaValidationError.md) - [SerializationError](classes/SerializationError.md) - [SetWindowRequiresOrderByError](classes/SetWindowRequiresOrderByError.md) - [SortedMap](classes/SortedMap.md) - [StorageError](classes/StorageError.md) - [StorageKeyRequiredError](classes/StorageKeyRequiredError.md) - [SubQueryMustHaveFromClauseError](classes/SubQueryMustHaveFromClauseError.md) - [SubscriptionNotFoundError](classes/SubscriptionNotFoundError.md) - [SyncCleanupError](classes/SyncCleanupError.md) - [SyncTransactionAlreadyCommittedError](classes/SyncTransactionAlreadyCommittedError.md) - [SyncTransactionAlreadyCommittedWriteError](classes/SyncTransactionAlreadyCommittedWriteError.md) - [TanStackDBError](classes/TanStackDBError.md) - [TransactionAlreadyCompletedRollbackError](classes/TransactionAlreadyCompletedRollbackError.md) - [TransactionError](classes/TransactionError.md) - [TransactionNotPendingCommitError](classes/TransactionNotPendingCommitError.md) - [TransactionNotPendingMutateError](classes/TransactionNotPendingMutateError.md) - [UndefinedKeyError](classes/UndefinedKeyError.md) - [UnknownExpressionTypeError](classes/UnknownExpressionTypeError.md) - [UnknownFunctionError](classes/UnknownFunctionError.md) - [UnknownHavingExpressionTypeError](classes/UnknownHavingExpressionTypeError.md) - [UnsupportedAggregateFunctionError](classes/UnsupportedAggregateFunctionError.md) - [UnsupportedFromTypeError](classes/UnsupportedFromTypeError.md) - [UnsupportedJoinSourceTypeError](classes/UnsupportedJoinSourceTypeError.md) - [UnsupportedJoinTypeError](classes/UnsupportedJoinTypeError.md) - [UnsupportedRootScalarSelectError](classes/UnsupportedRootScalarSelectError.md) - [UpdateKeyNotFoundError](classes/UpdateKeyNotFoundError.md) - [WhereClauseConversionError](classes/WhereClauseConversionError.md) ## Interfaces - [BaseCollectionConfig](interfaces/BaseCollectionConfig.md) - [BaseStrategy](interfaces/BaseStrategy.md) - [BasicIndexOptions](interfaces/BasicIndexOptions.md) - [BTreeRangeQueryOptions](interfaces/BTreeRangeQueryOptions.md) - [ChangeMessage](interfaces/ChangeMessage.md) - [Collection](interfaces/Collection.md) - [CollectionConfig](interfaces/CollectionConfig.md) - [CollectionIndexMetadata](interfaces/CollectionIndexMetadata.md) - [CollectionLike](interfaces/CollectionLike.md) - [Context](interfaces/Context.md) - [CreateOptimisticActionsOptions](interfaces/CreateOptimisticActionsOptions.md) - [CurrentStateAsChangesOptions](interfaces/CurrentStateAsChangesOptions.md) - [DebounceStrategy](interfaces/DebounceStrategy.md) - [DebounceStrategyOptions](interfaces/DebounceStrategyOptions.md) - [Effect](interfaces/Effect.md) - [EffectConfig](interfaces/EffectConfig.md) - [EffectContext](interfaces/EffectContext.md) - [IndexDevModeConfig](interfaces/IndexDevModeConfig.md) - [IndexInterface](interfaces/IndexInterface.md) - [IndexOptions](interfaces/IndexOptions.md) - [IndexStats](interfaces/IndexStats.md) - [IndexSuggestion](interfaces/IndexSuggestion.md) - [InsertConfig](interfaces/InsertConfig.md) - [LiveQueryCollectionConfig](interfaces/LiveQueryCollectionConfig.md) - [LocalOnlyCollectionConfig](interfaces/LocalOnlyCollectionConfig.md) - [LocalOnlyCollectionUtils](interfaces/LocalOnlyCollectionUtils.md) - [LocalStorageCollectionConfig](interfaces/LocalStorageCollectionConfig.md) - [LocalStorageCollectionUtils](interfaces/LocalStorageCollectionUtils.md) - [OperationConfig](interfaces/OperationConfig.md) - [PacedMutationsConfig](interfaces/PacedMutationsConfig.md) - [ParsedOrderBy](interfaces/ParsedOrderBy.md) - [Parser](interfaces/Parser.md) - [ParseWhereOptions](interfaces/ParseWhereOptions.md) - [PendingMutation](interfaces/PendingMutation.md) - [QueryOnceConfig](interfaces/QueryOnceConfig.md) - [QueueStrategy](interfaces/QueueStrategy.md) - [QueueStrategyOptions](interfaces/QueueStrategyOptions.md) - [RangeQueryOptions](interfaces/RangeQueryOptions.md) - [SimpleComparison](interfaces/SimpleComparison.md) - [SubscribeChangesOptions](interfaces/SubscribeChangesOptions.md) - [SubscribeChangesSnapshotOptions](interfaces/SubscribeChangesSnapshotOptions.md) - [Subscription](interfaces/Subscription.md) - [SubscriptionStatusChangeEvent](interfaces/SubscriptionStatusChangeEvent.md) - [SubscriptionStatusEvent](interfaces/SubscriptionStatusEvent.md) - [SubscriptionUnsubscribedEvent](interfaces/SubscriptionUnsubscribedEvent.md) - [SyncConfig](interfaces/SyncConfig.md) - [SyncMetadataApi](interfaces/SyncMetadataApi.md) - [ThrottleStrategy](interfaces/ThrottleStrategy.md) - [ThrottleStrategyOptions](interfaces/ThrottleStrategyOptions.md) - [Transaction](interfaces/Transaction.md) - [TransactionConfig](interfaces/TransactionConfig.md) - [VirtualRowProps](interfaces/VirtualRowProps.md) ## Type Aliases - [ApplyJoinOptionalityToMergedSchema](type-aliases/ApplyJoinOptionalityToMergedSchema.md) - [ChangeListener](type-aliases/ChangeListener.md) - [ChangeMessageOrDeleteKeyMessage](type-aliases/ChangeMessageOrDeleteKeyMessage.md) - [ChangesPayload](type-aliases/ChangesPayload.md) - [CleanupFn](type-aliases/CleanupFn.md) - [ClearStorageFn](type-aliases/ClearStorageFn.md) - [CollectionConfigSingleRowOption](type-aliases/CollectionConfigSingleRowOption.md) - [CollectionStatus](type-aliases/CollectionStatus.md) - [ContextSchema](type-aliases/ContextSchema.md) - [CursorExpressions](type-aliases/CursorExpressions.md) - [DeleteKeyMessage](type-aliases/DeleteKeyMessage.md) - [DeleteMutationFn](type-aliases/DeleteMutationFn.md) - [DeleteMutationFnParams](type-aliases/DeleteMutationFnParams.md) - [DeltaEvent](type-aliases/DeltaEvent.md) - [DeltaType](type-aliases/DeltaType.md) - [EffectQueryInput](type-aliases/EffectQueryInput.md) - [ExtractContext](type-aliases/ExtractContext.md) - [FieldPath](type-aliases/FieldPath.md) - [Fn](type-aliases/Fn.md) - [FunctionalHavingRow](type-aliases/FunctionalHavingRow.md) - [GetResult](type-aliases/GetResult.md) - [GetStorageSizeFn](type-aliases/GetStorageSizeFn.md) - [GroupByCallback](type-aliases/GroupByCallback.md) - [IndexConstructor](type-aliases/IndexConstructor.md) - [IndexOperation](type-aliases/IndexOperation.md) - [IndexOperation](type-aliases/IndexOperation-1.md) - [InferCollectionType](type-aliases/InferCollectionType.md) - [InferResultType](type-aliases/InferResultType.md) - [InferSchemaInput](type-aliases/InferSchemaInput.md) - [InferSchemaOutput](type-aliases/InferSchemaOutput.md) - [InitialQueryBuilder](type-aliases/InitialQueryBuilder.md) - [InputRow](type-aliases/InputRow.md) - [InsertMutationFn](type-aliases/InsertMutationFn.md) - [InsertMutationFnParams](type-aliases/InsertMutationFnParams.md) - [JoinOnCallback](type-aliases/JoinOnCallback.md) - [KeyedNamespacedRow](type-aliases/KeyedNamespacedRow.md) - [KeyedStream](type-aliases/KeyedStream.md) - [LiveQueryCollectionUtils](type-aliases/LiveQueryCollectionUtils.md) - [LoadSubsetFn](type-aliases/LoadSubsetFn.md) - [LoadSubsetOptions](type-aliases/LoadSubsetOptions.md) - [MakeOptional](type-aliases/MakeOptional.md) - [MaybeSingleResult](type-aliases/MaybeSingleResult.md) - [MergeContextForJoinCallback](type-aliases/MergeContextForJoinCallback.md) - [MergeContextWithJoinType](type-aliases/MergeContextWithJoinType.md) - [MutationFn](type-aliases/MutationFn.md) - [MutationFnParams](type-aliases/MutationFnParams.md) - [NamespacedAndKeyedStream](type-aliases/NamespacedAndKeyedStream.md) - [NamespacedRow](type-aliases/NamespacedRow.md) - [NonEmptyArray](type-aliases/NonEmptyArray.md) - [NonSingleResult](type-aliases/NonSingleResult.md) - [OperationType](type-aliases/OperationType.md) - [OperatorName](type-aliases/OperatorName.md) - [OptimisticChangeMessage](type-aliases/OptimisticChangeMessage.md) - [OrderByCallback](type-aliases/OrderByCallback.md) - [Prettify](type-aliases/Prettify.md) - [QueryBuilder](type-aliases/QueryBuilder.md) - [QueryResult](type-aliases/QueryResult.md) - [Ref](type-aliases/Ref.md) - [RefsForContext](type-aliases/RefsForContext.md) - [ResolveTransactionChanges](type-aliases/ResolveTransactionChanges.md) - [ResultStream](type-aliases/ResultStream.md) - [ResultTypeFromSelect](type-aliases/ResultTypeFromSelect.md) - [Row](type-aliases/Row.md) - [SchemaFromSource](type-aliases/SchemaFromSource.md) - [SelectObject](type-aliases/SelectObject.md) - [SingleResult](type-aliases/SingleResult.md) - [Source](type-aliases/Source.md) - [StandardSchema](type-aliases/StandardSchema.md) - [StandardSchemaAlias](type-aliases/StandardSchemaAlias.md) - [StorageApi](type-aliases/StorageApi.md) - [StorageEventApi](type-aliases/StorageEventApi.md) - [Strategy](type-aliases/Strategy.md) - [StrategyOptions](type-aliases/StrategyOptions.md) - [StringCollationConfig](type-aliases/StringCollationConfig.md) - [SubscriptionEvents](type-aliases/SubscriptionEvents.md) - [SubscriptionStatus](type-aliases/SubscriptionStatus.md) - [SyncConfigRes](type-aliases/SyncConfigRes.md) - [SyncMode](type-aliases/SyncMode.md) - [TransactionState](type-aliases/TransactionState.md) - [TransactionWithMutations](type-aliases/TransactionWithMutations.md) - [UnloadSubsetFn](type-aliases/UnloadSubsetFn.md) - [UpdateMutationFn](type-aliases/UpdateMutationFn.md) - [UpdateMutationFnParams](type-aliases/UpdateMutationFnParams.md) - [UtilsRecord](type-aliases/UtilsRecord.md) - [VirtualOrigin](type-aliases/VirtualOrigin.md) - [WhereCallback](type-aliases/WhereCallback.md) - [WithoutVirtualProps](type-aliases/WithoutVirtualProps.md) - [WithResult](type-aliases/WithResult.md) - [WithVirtualProps](type-aliases/WithVirtualProps.md) - [WritableDeep](type-aliases/WritableDeep.md) ## Variables - [operators](variables/operators.md) - [Query](variables/Query.md) ## Functions - [add](functions/add.md) - [and](functions/and.md) - [avg](functions/avg.md) - [clearQueryPatterns](functions/clearQueryPatterns.md) - [coalesce](functions/coalesce.md) - [compileExpression](functions/compileExpression.md) - [compileQuery](functions/compileQuery.md) - [compileSingleRowExpression](functions/compileSingleRowExpression.md) - [concat](functions/concat.md) - [configureIndexDevMode](functions/configureIndexDevMode.md) - [count](functions/count.md) - [createArrayChangeProxy](functions/createArrayChangeProxy.md) - [createChangeProxy](functions/createChangeProxy.md) - [createCollection](functions/createCollection.md) - [createEffect](functions/createEffect.md) - [createLiveQueryCollection](functions/createLiveQueryCollection.md) - [createOptimisticAction](functions/createOptimisticAction.md) - [createPacedMutations](functions/createPacedMutations.md) - [createTransaction](functions/createTransaction.md) - [debounceStrategy](functions/debounceStrategy.md) - [deepEquals](functions/deepEquals.md) - [eq](functions/eq.md) - [extractFieldPath](functions/extractFieldPath.md) - [extractSimpleComparisons](functions/extractSimpleComparisons.md) - [extractValue](functions/extractValue.md) - [findIndexForField](functions/findIndexForField.md) - [getActiveTransaction](functions/getActiveTransaction.md) - [getIndexDevModeConfig](functions/getIndexDevModeConfig.md) - [getQueryPatterns](functions/getQueryPatterns.md) - [gt](functions/gt.md) - [gte](functions/gte.md) - [hasVirtualProps](functions/hasVirtualProps.md) - [ilike](functions/ilike.md) - [inArray](functions/inArray.md) - [isDevModeEnabled](functions/isDevModeEnabled.md) - [isLimitSubset](functions/isLimitSubset.md) - [isNull](functions/isNull.md) - [isOffsetLimitSubset](functions/isOffsetLimitSubset.md) - [isOrderBySubset](functions/isOrderBySubset.md) - [isPredicateSubset](functions/isPredicateSubset.md) - [isUndefined](functions/isUndefined.md) - [isWhereSubset](functions/isWhereSubset.md) - [length](functions/length.md) - [like](functions/like.md) - [liveQueryCollectionOptions](functions/liveQueryCollectionOptions.md) - [localOnlyCollectionOptions](functions/localOnlyCollectionOptions.md) - [localStorageCollectionOptions](functions/localStorageCollectionOptions.md) - [lower](functions/lower.md) - [lt](functions/lt.md) - [lte](functions/lte.md) - [max](functions/max.md) - [min](functions/min.md) - [minusWherePredicates](functions/minusWherePredicates.md) - [not](functions/not.md) - [optimizeExpressionWithIndexes](functions/optimizeExpressionWithIndexes.md) - [or](functions/or.md) - [parseLoadSubsetOptions](functions/parseLoadSubsetOptions.md) - [parseOrderByExpression](functions/parseOrderByExpression.md) - [parseWhereExpression](functions/parseWhereExpression.md) - [queryOnce](functions/queryOnce.md) - [queueStrategy](functions/queueStrategy.md) - [sum](functions/sum.md) - [throttleStrategy](functions/throttleStrategy.md) - [toArray](functions/toArray.md) - [toBooleanPredicate](functions/toBooleanPredicate.md) - [trackQuery](functions/trackQuery.md) - [unionWherePredicates](functions/unionWherePredicates.md) - [upper](functions/upper.md) - [walkExpression](functions/walkExpression.md) - [withArrayChangeTracking](functions/withArrayChangeTracking.md) - [withChangeTracking](functions/withChangeTracking.md)