Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

index.md

351 lines18.2 KB

1---
2id: "@tanstack/db"
3title: "@tanstack/db"
4---
5​
6# @tanstack/db
7​
8## Namespaces
9​
10- [IR](@tanstack/namespaces/IR/index.md)
11​
12## Classes
13​
14- [AggregateFunctionNotInSelectError](classes/AggregateFunctionNotInSelectError.md)
15- [AggregateNotSupportedError](classes/AggregateNotSupportedError.md)
16- [BaseIndex](classes/BaseIndex.md)
17- [BaseQueryBuilder](classes/BaseQueryBuilder.md)
18- [BasicIndex](classes/BasicIndex.md)
19- [BTreeIndex](classes/BTreeIndex.md)
20- [CannotCombineEmptyExpressionListError](classes/CannotCombineEmptyExpressionListError.md)
21- [CollectionConfigurationError](classes/CollectionConfigurationError.md)
22- [CollectionImpl](classes/CollectionImpl.md)
23- [CollectionInErrorStateError](classes/CollectionInErrorStateError.md)
24- [CollectionInputNotFoundError](classes/CollectionInputNotFoundError.md)
25- [CollectionIsInErrorStateError](classes/CollectionIsInErrorStateError.md)
26- [CollectionOperationError](classes/CollectionOperationError.md)
27- [CollectionRequiresConfigError](classes/CollectionRequiresConfigError.md)
28- [CollectionRequiresSyncConfigError](classes/CollectionRequiresSyncConfigError.md)
29- [CollectionStateError](classes/CollectionStateError.md)
30- [DeduplicatedLoadSubset](classes/DeduplicatedLoadSubset.md)
31- [DeleteKeyNotFoundError](classes/DeleteKeyNotFoundError.md)
32- [DistinctRequiresSelectError](classes/DistinctRequiresSelectError.md)
33- [DuplicateAliasInSubqueryError](classes/DuplicateAliasInSubqueryError.md)
34- [DuplicateDbInstanceError](classes/DuplicateDbInstanceError.md)
35- [DuplicateKeyError](classes/DuplicateKeyError.md)
36- [DuplicateKeySyncError](classes/DuplicateKeySyncError.md)
37- [EmptyReferencePathError](classes/EmptyReferencePathError.md)
38- [FnSelectWithGroupByError](classes/FnSelectWithGroupByError.md)
39- [GroupByError](classes/GroupByError.md)
40- [HavingRequiresGroupByError](classes/HavingRequiresGroupByError.md)
41- [InvalidCollectionStatusTransitionError](classes/InvalidCollectionStatusTransitionError.md)
42- [InvalidJoinCondition](classes/InvalidJoinCondition.md)
43- [InvalidJoinConditionLeftSourceError](classes/InvalidJoinConditionLeftSourceError.md)
44- [InvalidJoinConditionRightSourceError](classes/InvalidJoinConditionRightSourceError.md)
45- [InvalidJoinConditionSameSourceError](classes/InvalidJoinConditionSameSourceError.md)
46- [InvalidJoinConditionSourceMismatchError](classes/InvalidJoinConditionSourceMismatchError.md)
47- [InvalidKeyError](classes/InvalidKeyError.md)
48- [InvalidSchemaError](classes/InvalidSchemaError.md)
49- [InvalidSourceError](classes/InvalidSourceError.md)
50- [InvalidSourceTypeError](classes/InvalidSourceTypeError.md)
51- [InvalidStorageDataFormatError](classes/InvalidStorageDataFormatError.md)
52- [InvalidStorageObjectFormatError](classes/InvalidStorageObjectFormatError.md)
53- [InvalidWhereExpressionError](classes/InvalidWhereExpressionError.md)
54- [JoinCollectionNotFoundError](classes/JoinCollectionNotFoundError.md)
55- [JoinConditionMustBeEqualityError](classes/JoinConditionMustBeEqualityError.md)
56- [JoinError](classes/JoinError.md)
57- [KeyUpdateNotAllowedError](classes/KeyUpdateNotAllowedError.md)
58- [LimitOffsetRequireOrderByError](classes/LimitOffsetRequireOrderByError.md)
59- [LocalStorageCollectionError](classes/LocalStorageCollectionError.md)
60- [MissingAliasInputsError](classes/MissingAliasInputsError.md)
61- [MissingDeleteHandlerError](classes/MissingDeleteHandlerError.md)
62- [MissingHandlerError](classes/MissingHandlerError.md)
63- [MissingInsertHandlerError](classes/MissingInsertHandlerError.md)
64- [MissingMutationFunctionError](classes/MissingMutationFunctionError.md)
65- [MissingUpdateArgumentError](classes/MissingUpdateArgumentError.md)
66- [MissingUpdateHandlerError](classes/MissingUpdateHandlerError.md)
67- [NegativeActiveSubscribersError](classes/NegativeActiveSubscribersError.md)
68- [NoKeysPassedToDeleteError](classes/NoKeysPassedToDeleteError.md)
69- [NoKeysPassedToUpdateError](classes/NoKeysPassedToUpdateError.md)
70- [NonAggregateExpressionNotInGroupByError](classes/NonAggregateExpressionNotInGroupByError.md)
71- [NonRetriableError](classes/NonRetriableError.md)
72- [NoPendingSyncTransactionCommitError](classes/NoPendingSyncTransactionCommitError.md)
73- [NoPendingSyncTransactionWriteError](classes/NoPendingSyncTransactionWriteError.md)
74- [OnlyOneSourceAllowedError](classes/OnlyOneSourceAllowedError.md)
75- [OnMutateMustBeSynchronousError](classes/OnMutateMustBeSynchronousError.md)
76- [QueryBuilderError](classes/QueryBuilderError.md)
77- [QueryCompilationError](classes/QueryCompilationError.md)
78- [QueryMustHaveFromClauseError](classes/QueryMustHaveFromClauseError.md)
79- [QueryOptimizerError](classes/QueryOptimizerError.md)
80- [ReverseIndex](classes/ReverseIndex.md)
81- [SchemaMustBeSynchronousError](classes/SchemaMustBeSynchronousError.md)
82- [SchemaValidationError](classes/SchemaValidationError.md)
83- [SerializationError](classes/SerializationError.md)
84- [SetWindowRequiresOrderByError](classes/SetWindowRequiresOrderByError.md)
85- [SortedMap](classes/SortedMap.md)
86- [StorageError](classes/StorageError.md)
87- [StorageKeyRequiredError](classes/StorageKeyRequiredError.md)
88- [SubQueryMustHaveFromClauseError](classes/SubQueryMustHaveFromClauseError.md)
89- [SubscriptionNotFoundError](classes/SubscriptionNotFoundError.md)
90- [SyncCleanupError](classes/SyncCleanupError.md)
91- [SyncTransactionAlreadyCommittedError](classes/SyncTransactionAlreadyCommittedError.md)
92- [SyncTransactionAlreadyCommittedWriteError](classes/SyncTransactionAlreadyCommittedWriteError.md)
93- [TanStackDBError](classes/TanStackDBError.md)
94- [TransactionAlreadyCompletedRollbackError](classes/TransactionAlreadyCompletedRollbackError.md)
95- [TransactionError](classes/TransactionError.md)
96- [TransactionNotPendingCommitError](classes/TransactionNotPendingCommitError.md)
97- [TransactionNotPendingMutateError](classes/TransactionNotPendingMutateError.md)
98- [UndefinedKeyError](classes/UndefinedKeyError.md)
99- [UnknownExpressionTypeError](classes/UnknownExpressionTypeError.md)
100- [UnknownFunctionError](classes/UnknownFunctionError.md)
101- [UnknownHavingExpressionTypeError](classes/UnknownHavingExpressionTypeError.md)
102- [UnsafeAliasPathError](classes/UnsafeAliasPathError.md)
103- [UnsupportedAggregateFunctionError](classes/UnsupportedAggregateFunctionError.md)
104- [UnsupportedFromTypeError](classes/UnsupportedFromTypeError.md)
105- [UnsupportedJoinSourceTypeError](classes/UnsupportedJoinSourceTypeError.md)
106- [UnsupportedJoinTypeError](classes/UnsupportedJoinTypeError.md)
107- [UnsupportedRootScalarSelectError](classes/UnsupportedRootScalarSelectError.md)
108- [UpdateKeyNotFoundError](classes/UpdateKeyNotFoundError.md)
109- [WhereClauseConversionError](classes/WhereClauseConversionError.md)
110​
111## Interfaces
112​
113- [BaseCollectionConfig](interfaces/BaseCollectionConfig.md)
114- [BaseStrategy](interfaces/BaseStrategy.md)
115- [BasicIndexOptions](interfaces/BasicIndexOptions.md)
116- [BTreeRangeQueryOptions](interfaces/BTreeRangeQueryOptions.md)
117- [ChangeMessage](interfaces/ChangeMessage.md)
118- [Collection](interfaces/Collection.md)
119- [CollectionConfig](interfaces/CollectionConfig.md)
120- [CollectionIndexMetadata](interfaces/CollectionIndexMetadata.md)
121- [CollectionLike](interfaces/CollectionLike.md)
122- [Context](interfaces/Context.md)
123- [CreateOptimisticActionsOptions](interfaces/CreateOptimisticActionsOptions.md)
124- [CurrentStateAsChangesOptions](interfaces/CurrentStateAsChangesOptions.md)
125- [DebounceStrategy](interfaces/DebounceStrategy.md)
126- [DebounceStrategyOptions](interfaces/DebounceStrategyOptions.md)
127- [Effect](interfaces/Effect.md)
128- [EffectConfig](interfaces/EffectConfig.md)
129- [EffectContext](interfaces/EffectContext.md)
130- [IndexDevModeConfig](interfaces/IndexDevModeConfig.md)
131- [IndexInterface](interfaces/IndexInterface.md)
132- [IndexOptions](interfaces/IndexOptions.md)
133- [IndexStats](interfaces/IndexStats.md)
134- [IndexSuggestion](interfaces/IndexSuggestion.md)
135- [InsertConfig](interfaces/InsertConfig.md)
136- [LiveQueryCollectionConfig](interfaces/LiveQueryCollectionConfig.md)
137- [LiveQueryStatusFlags](interfaces/LiveQueryStatusFlags.md)
138- [LocalOnlyCollectionConfig](interfaces/LocalOnlyCollectionConfig.md)
139- [LocalOnlyCollectionUtils](interfaces/LocalOnlyCollectionUtils.md)
140- [LocalStorageCollectionConfig](interfaces/LocalStorageCollectionConfig.md)
141- [LocalStorageCollectionUtils](interfaces/LocalStorageCollectionUtils.md)
142- [OperationConfig](interfaces/OperationConfig.md)
143- [PacedMutationsConfig](interfaces/PacedMutationsConfig.md)
144- [ParsedOrderBy](interfaces/ParsedOrderBy.md)
145- [Parser](interfaces/Parser.md)
146- [ParseWhereOptions](interfaces/ParseWhereOptions.md)
147- [PendingMutation](interfaces/PendingMutation.md)
148- [QueryOnceConfig](interfaces/QueryOnceConfig.md)
149- [QueueStrategy](interfaces/QueueStrategy.md)
150- [QueueStrategyOptions](interfaces/QueueStrategyOptions.md)
151- [RangeQueryOptions](interfaces/RangeQueryOptions.md)
152- [SimpleComparison](interfaces/SimpleComparison.md)
153- [SubscribeChangesOptions](interfaces/SubscribeChangesOptions.md)
154- [SubscribeChangesSnapshotOptions](interfaces/SubscribeChangesSnapshotOptions.md)
155- [Subscription](interfaces/Subscription.md)
156- [SubscriptionStatusChangeEvent](interfaces/SubscriptionStatusChangeEvent.md)
157- [SubscriptionStatusEvent](interfaces/SubscriptionStatusEvent.md)
158- [SubscriptionUnsubscribedEvent](interfaces/SubscriptionUnsubscribedEvent.md)
159- [SyncConfig](interfaces/SyncConfig.md)
160- [SyncMetadataApi](interfaces/SyncMetadataApi.md)
161- [ThrottleStrategy](interfaces/ThrottleStrategy.md)
162- [ThrottleStrategyOptions](interfaces/ThrottleStrategyOptions.md)
163- [Transaction](interfaces/Transaction.md)
164- [TransactionConfig](interfaces/TransactionConfig.md)
165- [VirtualRowProps](interfaces/VirtualRowProps.md)
166​
167## Type Aliases
168​
169- [ApplyJoinOptionalityToMergedSchema](type-aliases/ApplyJoinOptionalityToMergedSchema.md)
170- [ChangeListener](type-aliases/ChangeListener.md)
171- [ChangeMessageOrDeleteKeyMessage](type-aliases/ChangeMessageOrDeleteKeyMessage.md)
172- [ChangesPayload](type-aliases/ChangesPayload.md)
173- [CleanupFn](type-aliases/CleanupFn.md)
174- [ClearStorageFn](type-aliases/ClearStorageFn.md)
175- [CollectionConfigSingleRowOption](type-aliases/CollectionConfigSingleRowOption.md)
176- [CollectionStatus](type-aliases/CollectionStatus.md)
177- [ContextFromSource](type-aliases/ContextFromSource.md)
178- [ContextFromUnionBranches](type-aliases/ContextFromUnionBranches.md)
179- [ContextFromUnionSource](type-aliases/ContextFromUnionSource.md)
180- [ContextSchema](type-aliases/ContextSchema.md)
181- [CursorExpressions](type-aliases/CursorExpressions.md)
182- [DeleteKeyMessage](type-aliases/DeleteKeyMessage.md)
183- [DeleteMutationFn](type-aliases/DeleteMutationFn.md)
184- [DeleteMutationFnParams](type-aliases/DeleteMutationFnParams.md)
185- [DeltaEvent](type-aliases/DeltaEvent.md)
186- [DeltaType](type-aliases/DeltaType.md)
187- [EffectQueryInput](type-aliases/EffectQueryInput.md)
188- [ExtractContext](type-aliases/ExtractContext.md)
189- [FieldPath](type-aliases/FieldPath.md)
190- [Fn](type-aliases/Fn.md)
191- [FunctionalHavingRow](type-aliases/FunctionalHavingRow.md)
192- [GetResult](type-aliases/GetResult.md)
193- [GetStorageSizeFn](type-aliases/GetStorageSizeFn.md)
194- [GroupByCallback](type-aliases/GroupByCallback.md)
195- [IndexConstructor](type-aliases/IndexConstructor.md)
196- [IndexOperation](type-aliases/IndexOperation.md)
197- [IndexOperation](type-aliases/IndexOperation-1.md)
198- [InferCollectionType](type-aliases/InferCollectionType.md)
199- [InferResultType](type-aliases/InferResultType.md)
200- [InferSchemaInput](type-aliases/InferSchemaInput.md)
201- [InferSchemaOutput](type-aliases/InferSchemaOutput.md)
202- [InitialQueryBuilder](type-aliases/InitialQueryBuilder.md)
203- [InputRow](type-aliases/InputRow.md)
204- [InsertMutationFn](type-aliases/InsertMutationFn.md)
205- [InsertMutationFnParams](type-aliases/InsertMutationFnParams.md)
206- [JoinOnCallback](type-aliases/JoinOnCallback.md)
207- [KeyedNamespacedRow](type-aliases/KeyedNamespacedRow.md)
208- [KeyedStream](type-aliases/KeyedStream.md)
209- [LiveQueryCollectionUtils](type-aliases/LiveQueryCollectionUtils.md)
210- [LoadSubsetFn](type-aliases/LoadSubsetFn.md)
211- [LoadSubsetOptions](type-aliases/LoadSubsetOptions.md)
212- [MakeOptional](type-aliases/MakeOptional.md)
213- [MaybeSingleResult](type-aliases/MaybeSingleResult.md)
214- [MergeContextForJoinCallback](type-aliases/MergeContextForJoinCallback.md)
215- [MergeContextWithJoinType](type-aliases/MergeContextWithJoinType.md)
216- [MutationFn](type-aliases/MutationFn.md)
217- [MutationFnParams](type-aliases/MutationFnParams.md)
218- [NamespacedAndKeyedStream](type-aliases/NamespacedAndKeyedStream.md)
219- [NamespacedRow](type-aliases/NamespacedRow.md)
220- [NonEmptyArray](type-aliases/NonEmptyArray.md)
221- [NonSingleResult](type-aliases/NonSingleResult.md)
222- [OperationType](type-aliases/OperationType.md)
223- [OperatorName](type-aliases/OperatorName.md)
224- [OptimisticChangeMessage](type-aliases/OptimisticChangeMessage.md)
225- [OrderByCallback](type-aliases/OrderByCallback.md)
226- [Prettify](type-aliases/Prettify.md)
227- [QueryBuilder](type-aliases/QueryBuilder.md)
228- [QueryResult](type-aliases/QueryResult.md)
229- [Ref](type-aliases/Ref.md)
230- [RefsForContext](type-aliases/RefsForContext.md)
231- [ResolveTransactionChanges](type-aliases/ResolveTransactionChanges.md)
232- [ResultStream](type-aliases/ResultStream.md)
233- [ResultTypeFromSelect](type-aliases/ResultTypeFromSelect.md)
234- [Row](type-aliases/Row.md)
235- [SchemaFromSource](type-aliases/SchemaFromSource.md)
236- [SelectObject](type-aliases/SelectObject.md)
237- [SingleResult](type-aliases/SingleResult.md)
238- [SingleSource](type-aliases/SingleSource.md)
239- [Source](type-aliases/Source.md)
240- [SourceClauseContext](type-aliases/SourceClauseContext.md)
241- [StandardSchema](type-aliases/StandardSchema.md)
242- [StandardSchemaAlias](type-aliases/StandardSchemaAlias.md)
243- [StorageApi](type-aliases/StorageApi.md)
244- [StorageEventApi](type-aliases/StorageEventApi.md)
245- [Strategy](type-aliases/Strategy.md)
246- [StrategyOptions](type-aliases/StrategyOptions.md)
247- [StringCollationConfig](type-aliases/StringCollationConfig.md)
248- [SubscriptionEvents](type-aliases/SubscriptionEvents.md)
249- [SubscriptionStatus](type-aliases/SubscriptionStatus.md)
250- [SyncConfigRes](type-aliases/SyncConfigRes.md)
251- [SyncMode](type-aliases/SyncMode.md)
252- [TransactionState](type-aliases/TransactionState.md)
253- [TransactionWithMutations](type-aliases/TransactionWithMutations.md)
254- [UnloadSubsetFn](type-aliases/UnloadSubsetFn.md)
255- [UpdateMutationFn](type-aliases/UpdateMutationFn.md)
256- [UpdateMutationFnParams](type-aliases/UpdateMutationFnParams.md)
257- [UtilsRecord](type-aliases/UtilsRecord.md)
258- [VirtualOrigin](type-aliases/VirtualOrigin.md)
259- [WhereCallback](type-aliases/WhereCallback.md)
260- [WithoutVirtualProps](type-aliases/WithoutVirtualProps.md)
261- [WithResult](type-aliases/WithResult.md)
262- [WithVirtualProps](type-aliases/WithVirtualProps.md)
263- [WritableDeep](type-aliases/WritableDeep.md)
264​
265## Variables
266​
267- [operators](variables/operators.md)
268- [Query](variables/Query.md)
269​
270## Functions
271​
272- [add](functions/add.md)
273- [and](functions/and.md)
274- [avg](functions/avg.md)
275- [caseWhen](functions/caseWhen.md)
276- [clearQueryPatterns](functions/clearQueryPatterns.md)
277- [coalesce](functions/coalesce.md)
278- [compileExpression](functions/compileExpression.md)
279- [compileQuery](functions/compileQuery.md)
280- [compileSingleRowExpression](functions/compileSingleRowExpression.md)
281- [concat](functions/concat.md)
282- [configureIndexDevMode](functions/configureIndexDevMode.md)
283- [count](functions/count.md)
284- [createArrayChangeProxy](functions/createArrayChangeProxy.md)
285- [createChangeProxy](functions/createChangeProxy.md)
286- [createCollection](functions/createCollection.md)
287- [createEffect](functions/createEffect.md)
288- [createLiveQueryCollection](functions/createLiveQueryCollection.md)
289- [createOptimisticAction](functions/createOptimisticAction.md)
290- [createPacedMutations](functions/createPacedMutations.md)
291- [createTransaction](functions/createTransaction.md)
292- [debounceStrategy](functions/debounceStrategy.md)
293- [deepEquals](functions/deepEquals.md)
294- [divide](functions/divide.md)
295- [eq](functions/eq.md)
296- [extractFieldPath](functions/extractFieldPath.md)
297- [extractSimpleComparisons](functions/extractSimpleComparisons.md)
298- [extractValue](functions/extractValue.md)
299- [findIndexForField](functions/findIndexForField.md)
300- [getActiveTransaction](functions/getActiveTransaction.md)
301- [getIndexDevModeConfig](functions/getIndexDevModeConfig.md)
302- [getLiveQueryStatusFlags](functions/getLiveQueryStatusFlags.md)
303- [getQueryPatterns](functions/getQueryPatterns.md)
304- [gt](functions/gt.md)
305- [gte](functions/gte.md)
306- [hasVirtualProps](functions/hasVirtualProps.md)
307- [ilike](functions/ilike.md)
308- [inArray](functions/inArray.md)
309- [isCollection](functions/isCollection.md)
310- [isDevModeEnabled](functions/isDevModeEnabled.md)
311- [isLimitSubset](functions/isLimitSubset.md)
312- [isNull](functions/isNull.md)
313- [isOffsetLimitSubset](functions/isOffsetLimitSubset.md)
314- [isOrderBySubset](functions/isOrderBySubset.md)
315- [isPredicateSubset](functions/isPredicateSubset.md)
316- [isSingleResultCollection](functions/isSingleResultCollection.md)
317- [isUndefined](functions/isUndefined.md)
318- [isWhereSubset](functions/isWhereSubset.md)
319- [length](functions/length.md)
320- [like](functions/like.md)
321- [liveQueryCollectionOptions](functions/liveQueryCollectionOptions.md)
322- [localOnlyCollectionOptions](functions/localOnlyCollectionOptions.md)
323- [localStorageCollectionOptions](functions/localStorageCollectionOptions.md)
324- [lower](functions/lower.md)
325- [lt](functions/lt.md)
326- [lte](functions/lte.md)
327- [materialize](functions/materialize.md)
328- [max](functions/max.md)
329- [min](functions/min.md)
330- [minusWherePredicates](functions/minusWherePredicates.md)
331- [multiply](functions/multiply.md)
332- [not](functions/not.md)
333- [optimizeExpressionWithIndexes](functions/optimizeExpressionWithIndexes.md)
334- [or](functions/or.md)
335- [parseLoadSubsetOptions](functions/parseLoadSubsetOptions.md)
336- [parseOrderByExpression](functions/parseOrderByExpression.md)
337- [parseWhereExpression](functions/parseWhereExpression.md)
338- [queryOnce](functions/queryOnce.md)
339- [queueStrategy](functions/queueStrategy.md)
340- [safeRandomUUID](functions/safeRandomUUID.md)
341- [subtract](functions/subtract.md)
342- [sum](functions/sum.md)
343- [throttleStrategy](functions/throttleStrategy.md)
344- [toArray](functions/toArray.md)
345- [toBooleanPredicate](functions/toBooleanPredicate.md)
346- [trackQuery](functions/trackQuery.md)
347- [unionWherePredicates](functions/unionWherePredicates.md)
348- [upper](functions/upper.md)
349- [walkExpression](functions/walkExpression.md)
350- [withArrayChangeTracking](functions/withArrayChangeTracking.md)
351- [withChangeTracking](functions/withChangeTracking.md)