@protobase/query 0.25.1 → 0.25.2

package/dist/index-coverage.d.ts

@@ -1,5 +1,5 @@
 import { Scope } from "./scope.js";
-import { TableIndexes } from "./table-indexes.js";
+import { TableIndex, TableIndexes } from "./table-indexes.js";
 import { CheckedFilter, ResourceModel, SortSpec } from "@protobase/schema";
 //#region src/index-coverage.d.ts
 /**
@@ -24,6 +24,8 @@ export type CoverageQuery = {
   sort?: SortSpec;
   groupBy?: string;
 };
+/** Whether the index serves reading the column with the given need, while the query pins the `pinned` columns. */
+export declare const indexServes: (index: TableIndex, column: string, need: IndexNeed, pinned: ReadonlySet<string>) => boolean;
 /**
  * The columns a read of the resource would read without an index serving them; empty when every one is served. The
  * filter's and the access row filter's columns each need an index of the kind their operator uses, the sort's first

package/dist/index-coverage.js

@@ -31,7 +31,8 @@ const mentions = (definition, column) => {
 	const name = column.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 	return new RegExp(`(^|[^\\w"])("${name}"|${name})([^\\w"]|$)`).test(definition);
 };
-const serves = (index, column, need, pinned) => {
+/** Whether the index serves reading the column with the given need, while the query pins the `pinned` columns. */
+const indexServes = (index, column, need, pinned) => {
 	if (index.partial) return false;
 	switch (need) {
 		case "btree": return btreeServes(index, column, pinned);
@@ -40,7 +41,7 @@ const serves = (index, column, need, pinned) => {
 		case "gin": return index.method === "gin" && index.keys.some((key) => key.column === column);
 	}
 };
-const need = (ctx, field, kind, pinned, also) => ctx.indexes.some((index) => serves(index, field.column, kind, pinned) || also !== void 0 && serves(index, field.column, also, pinned)) ? [] : [{
+const need = (ctx, field, kind, pinned, also) => ctx.indexes.some((index) => indexServes(index, field.column, kind, pinned) || also !== void 0 && indexServes(index, field.column, also, pinned)) ? [] : [{
 	field: field.name,
 	column: field.column,
 	use: ctx.use,
@@ -103,4 +104,4 @@ const uncoveredColumns = (model, table, query, scope) => {
 	]);
 };
 //#endregion
-export { uncoveredColumns };
+export { indexServes, uncoveredColumns };

package/dist/index.d.ts

@@ -17,7 +17,7 @@ import { MapBounds, MapBucket, MapBuckets, MapPosition, cellsAcross, checkMapPos
 import { withoutField } from "./prune-filter.js";
 import { ScrollMode, scrollMode } from "./scroll-mode.js";
 import { IndexKey, TableIndex, TableIndexes, tableIndexes } from "./table-indexes.js";
-import { ColumnUse, CoverageQuery, IndexNeed, UncoveredColumn, uncoveredColumns } from "./index-coverage.js";
+import { ColumnUse, CoverageQuery, IndexNeed, UncoveredColumn, indexServes, uncoveredColumns } from "./index-coverage.js";
 import { QueryError, QueryErrorCode } from "./fields/query-error.js";
 import { SeekRequest, seekToPosition } from "./seek-to-position.js";
-export { type ColumnUse, type CompileOptions, type CoverageQuery, type Db, type ExtraColumn, type FacetCount, type FacetOptions, type Granularity, type GroupTotal, type GroupTotalsOptions, type Histogram, type HistogramBucket, type IndexKey, type IndexNeed, type ListOptions, type ListPlan, type ListResult, type MapBounds, type MapBucket, type MapBuckets, type MapPosition, type Measure, QueryError, type QueryErrorCode, type RelatedRowsQuery, type Scope, type ScrollMode, type SeekRequest, type SeriesOptions, type SeriesPoint, type SplitPoint, type SplitSeriesOptions, type TableIndex, type TableIndexes, type UncoveredColumn, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };
+export { type ColumnUse, type CompileOptions, type CoverageQuery, type Db, type ExtraColumn, type FacetCount, type FacetOptions, type Granularity, type GroupTotal, type GroupTotalsOptions, type Histogram, type HistogramBucket, type IndexKey, type IndexNeed, type ListOptions, type ListPlan, type ListResult, type MapBounds, type MapBucket, type MapBuckets, type MapPosition, type Measure, QueryError, type QueryErrorCode, type RelatedRowsQuery, type Scope, type ScrollMode, type SeekRequest, type SeriesOptions, type SeriesPoint, type SplitPoint, type SplitSeriesOptions, type TableIndex, type TableIndexes, type UncoveredColumn, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };

package/dist/index.js

@@ -14,6 +14,6 @@ import { histogram } from "./histogram.js";
 import { cellsAcross, checkMapPosition, mapBuckets, mapCellPixels, maxMapBuckets, maxMapZoom } from "./map-buckets.js";
 import { scrollMode } from "./scroll-mode.js";
 import { tableIndexes } from "./table-indexes.js";
-import { uncoveredColumns } from "./index-coverage.js";
+import { indexServes, uncoveredColumns } from "./index-coverage.js";
 import { seekToPosition } from "./seek-to-position.js";
-export { QueryError, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };
+export { QueryError, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/query",
-  "version": "0.25.1",
+  "version": "0.25.2",
   "description": "Kysely list, filter, count and aggregate queries over Protobase resources.",
   "license": "Apache-2.0",
   "repository": {
@@ -29,7 +29,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/schema": "0.25.1",
+    "@protobase/schema": "0.25.2",
     "kysely": "^0.29.6"
   }
 }