@dxos/echo-pipeline 0.8.4-main.ae835ea → 0.8.4-main.bc674ce

package/src/pipeline/pipeline.ts

@@ -19,7 +19,7 @@ import { createMappedFeedWriter } from '../common';
 import { createMessageSelector } from './message-selector';
 import { TimeframeClock, mapFeedIndexesToTimeframe, startAfter } from './timeframe-clock';
 
-export type WaitUntilReachedTargetParams = {
+export type WaitUntilReachedTargetProps = {
   /**
    * For cancellation.
    */
@@ -132,7 +132,7 @@ export class PipelineState {
     ctx = new Context(),
     timeout,
     breakOnStall = true,
-  }: WaitUntilReachedTargetParams = {}): Promise<void> {
+  }: WaitUntilReachedTargetProps = {}): Promise<void> {
     log('waitUntilReachedTargetTimeframe', {
       timeout,
       current: this.timeframe,

package/src/query/errors.ts

@@ -4,6 +4,6 @@
 
 import { BaseError } from '@dxos/errors';
 
-export class QueryError extends BaseError.extend('QUERY_ERROR') {}
+export class QueryError extends BaseError.extend('QueryError') {}
 
-export class InvalidQueryError extends QueryError.extend('INVALID_QUERY') {}
+export class InvalidQueryError extends QueryError.extend('InvalidQueryError') {}

package/src/query/plan.ts

@@ -33,7 +33,8 @@ export namespace QueryPlan {
     | TraverseStep
     | UnionStep
     | SetDifferenceStep
-    | OrderStep;
+    | OrderStep
+    | LimitStep;
 
   /**
    * Clear the current working set.
@@ -44,13 +45,36 @@ export namespace QueryPlan {
 
   /**
    * Select objects based on id, typename, or other predicates.
-   * Specifies the spaces to select from.
+   * Specifies the spaces and/or queues to select from.
+   * The results from spaces and queues are unioned together.
    */
   export type SelectStep = {
     _tag: 'SelectStep';
 
+    // TODO(dmaretskyi): Extract the object container spec into a separate type in ECHO-protocol that we can share with the indexer.
+
+    /**
+     * Select from specific spaces.
+     */
     spaces: readonly SpaceId[];
+
+    /**
+     * If true, select from all queues in the spaces specified by `spaces`.
+     */
+    allQueuesFromSpaces: boolean;
+
+    /**
+     * Select from specific queues.
+     */
+    queues: readonly DXN.String[];
+
     selector: Selector;
+
+    /**
+     * Optional limit on the number of results to select.
+     * When set, the index scan can be optimized to stop early.
+     */
+    limit?: number;
   };
 
   /**
@@ -91,6 +115,11 @@ export namespace QueryPlan {
 
     text: string;
     searchKind: TextSearchKind;
+
+    /**
+     * Optionally select only objects of the given typenames.
+     */
+    typename: DXN.String[] | null;
   };
 
   /**
@@ -151,8 +180,9 @@ export namespace QueryPlan {
 
     /**
      * Property path where the reference is located.
+     * If null, matches references from any property (only valid for incoming direction).
      */
-    property: EscapedPropPath;
+    property: EscapedPropPath | null;
 
     /**
      * outgoing: the reference points from the anchor object to the target.
@@ -203,5 +233,20 @@ export namespace QueryPlan {
 
     // Defaults to natural order if empty.
     order: readonly QueryAST.Order[];
+
+    /**
+     * Optional limit on the number of results to return after ordering.
+     * When set, the sorting can be optimized to only track the top N elements.
+     */
+    limit?: number;
+  };
+
+  /**
+   * Limit the number of results.
+   */
+  export type LimitStep = {
+    _tag: 'LimitStep';
+
+    limit: number;
   };
 }