@math.gl/sql 0.0.0-stage → 5.0.0-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +249 -0
- package/README.md +26 -2
- package/THIRD-PARTY-NOTICES.md +5 -0
- package/dist/arrow/aggregates.d.ts +46 -0
- package/dist/arrow/aggregates.d.ts.map +1 -0
- package/dist/arrow/aggregates.js +289 -0
- package/dist/arrow/aggregates.js.map +1 -0
- package/dist/arrow/buffers.d.ts +30 -0
- package/dist/arrow/buffers.d.ts.map +1 -0
- package/dist/arrow/buffers.js +177 -0
- package/dist/arrow/buffers.js.map +1 -0
- package/dist/arrow/cast.d.ts +19 -0
- package/dist/arrow/cast.d.ts.map +1 -0
- package/dist/arrow/cast.js +138 -0
- package/dist/arrow/cast.js.map +1 -0
- package/dist/arrow/compiler.d.ts +10 -0
- package/dist/arrow/compiler.d.ts.map +1 -0
- package/dist/arrow/compiler.js +1538 -0
- package/dist/arrow/compiler.js.map +1 -0
- package/dist/arrow/float16.d.ts +7 -0
- package/dist/arrow/float16.d.ts.map +1 -0
- package/dist/arrow/float16.js +26 -0
- package/dist/arrow/float16.js.map +1 -0
- package/dist/arrow/index.cjs +3321 -0
- package/dist/arrow/index.cjs.map +6 -0
- package/dist/arrow/index.d.ts +5 -0
- package/dist/arrow/index.d.ts.map +1 -0
- package/dist/arrow/index.js +7 -0
- package/dist/arrow/index.js.map +1 -0
- package/dist/arrow/like.d.ts +3 -0
- package/dist/arrow/like.d.ts.map +1 -0
- package/dist/arrow/like.js +75 -0
- package/dist/arrow/like.js.map +1 -0
- package/dist/arrow/list-values.d.ts +14 -0
- package/dist/arrow/list-values.d.ts.map +1 -0
- package/dist/arrow/list-values.js +201 -0
- package/dist/arrow/list-values.js.map +1 -0
- package/dist/arrow/predicate.d.ts +7 -0
- package/dist/arrow/predicate.d.ts.map +1 -0
- package/dist/arrow/predicate.js +10 -0
- package/dist/arrow/predicate.js.map +1 -0
- package/dist/arrow/query-arrow-aggregate-snapshots.d.ts +24 -0
- package/dist/arrow/query-arrow-aggregate-snapshots.d.ts.map +1 -0
- package/dist/arrow/query-arrow-aggregate-snapshots.js +64 -0
- package/dist/arrow/query-arrow-aggregate-snapshots.js.map +1 -0
- package/dist/arrow/query-arrow-sql.d.ts +8 -0
- package/dist/arrow/query-arrow-sql.d.ts.map +1 -0
- package/dist/arrow/query-arrow-sql.js +223 -0
- package/dist/arrow/query-arrow-sql.js.map +1 -0
- package/dist/arrow/query-arrow-table.d.ts +36 -0
- package/dist/arrow/query-arrow-table.d.ts.map +1 -0
- package/dist/arrow/query-arrow-table.js +208 -0
- package/dist/arrow/query-arrow-table.js.map +1 -0
- package/dist/arrow/query-worker-entry.d.ts +2 -0
- package/dist/arrow/query-worker-entry.d.ts.map +1 -0
- package/dist/arrow/query-worker-entry.js +7 -0
- package/dist/arrow/query-worker-entry.js.map +1 -0
- package/dist/arrow/query-worker.d.ts +65 -0
- package/dist/arrow/query-worker.d.ts.map +1 -0
- package/dist/arrow/query-worker.js +135 -0
- package/dist/arrow/query-worker.js.map +1 -0
- package/dist/arrow/registry.d.ts +4 -0
- package/dist/arrow/registry.d.ts.map +1 -0
- package/dist/arrow/registry.js +66 -0
- package/dist/arrow/registry.js.map +1 -0
- package/dist/arrow/relational-query.d.ts +36 -0
- package/dist/arrow/relational-query.d.ts.map +1 -0
- package/dist/arrow/relational-query.js +174 -0
- package/dist/arrow/relational-query.js.map +1 -0
- package/dist/arrow/replace-arrow-columns.d.ts +8 -0
- package/dist/arrow/replace-arrow-columns.d.ts.map +1 -0
- package/dist/arrow/replace-arrow-columns.js +63 -0
- package/dist/arrow/replace-arrow-columns.js.map +1 -0
- package/dist/arrow/signature.d.ts +6 -0
- package/dist/arrow/signature.d.ts.map +1 -0
- package/dist/arrow/signature.js +51 -0
- package/dist/arrow/signature.js.map +1 -0
- package/dist/arrow/temporal-cast.d.ts +9 -0
- package/dist/arrow/temporal-cast.d.ts.map +1 -0
- package/dist/arrow/temporal-cast.js +60 -0
- package/dist/arrow/temporal-cast.js.map +1 -0
- package/dist/arrow/types.d.ts +62 -0
- package/dist/arrow/types.d.ts.map +1 -0
- package/dist/arrow/types.js +5 -0
- package/dist/arrow/types.js.map +1 -0
- package/dist/arrow/unnest-arrow-column.d.ts +22 -0
- package/dist/arrow/unnest-arrow-column.d.ts.map +1 -0
- package/dist/arrow/unnest-arrow-column.js +112 -0
- package/dist/arrow/unnest-arrow-column.js.map +1 -0
- package/dist/arrow/worker-entry.d.ts +2 -0
- package/dist/arrow/worker-entry.d.ts.map +1 -0
- package/dist/arrow/worker-entry.js +9 -0
- package/dist/arrow/worker-entry.js.map +1 -0
- package/dist/arrow/worker.cjs +4074 -0
- package/dist/arrow/worker.cjs.map +6 -0
- package/dist/arrow/worker.d.ts +58 -0
- package/dist/arrow/worker.d.ts.map +1 -0
- package/dist/arrow/worker.js +84 -0
- package/dist/arrow/worker.js.map +1 -0
- package/dist/color-functions/index.cjs +382 -0
- package/dist/color-functions/index.cjs.map +6 -0
- package/dist/color-functions/index.d.ts +26 -0
- package/dist/color-functions/index.d.ts.map +1 -0
- package/dist/color-functions/index.js +306 -0
- package/dist/color-functions/index.js.map +1 -0
- package/dist/diagnostic-log.d.ts +8 -0
- package/dist/diagnostic-log.d.ts.map +1 -0
- package/dist/diagnostic-log.js +15 -0
- package/dist/diagnostic-log.js.map +1 -0
- package/dist/expressions/ast.d.ts +12 -0
- package/dist/expressions/ast.d.ts.map +1 -0
- package/dist/expressions/ast.js +114 -0
- package/dist/expressions/ast.js.map +1 -0
- package/dist/expressions/columnar-predicate.d.ts +56 -0
- package/dist/expressions/columnar-predicate.d.ts.map +1 -0
- package/dist/expressions/columnar-predicate.js +176 -0
- package/dist/expressions/columnar-predicate.js.map +1 -0
- package/dist/expressions/evaluation-error.d.ts +14 -0
- package/dist/expressions/evaluation-error.d.ts.map +1 -0
- package/dist/expressions/evaluation-error.js +26 -0
- package/dist/expressions/evaluation-error.js.map +1 -0
- package/dist/expressions/expression-eval.d.ts +105 -0
- package/dist/expressions/expression-eval.d.ts.map +1 -0
- package/dist/expressions/expression-eval.js +330 -0
- package/dist/expressions/expression-eval.js.map +1 -0
- package/dist/expressions/function-libraries.d.ts +63 -0
- package/dist/expressions/function-libraries.d.ts.map +1 -0
- package/dist/expressions/function-libraries.js +69 -0
- package/dist/expressions/function-libraries.js.map +1 -0
- package/dist/expressions/function-registry.d.ts +93 -0
- package/dist/expressions/function-registry.d.ts.map +1 -0
- package/dist/expressions/function-registry.js +139 -0
- package/dist/expressions/function-registry.js.map +1 -0
- package/dist/expressions/get.d.ts +9 -0
- package/dist/expressions/get.d.ts.map +1 -0
- package/dist/expressions/get.js +32 -0
- package/dist/expressions/get.js.map +1 -0
- package/dist/expressions/index.cjs +1888 -0
- package/dist/expressions/index.cjs.map +6 -0
- package/dist/expressions/index.d.ts +13 -0
- package/dist/expressions/index.d.ts.map +1 -0
- package/dist/expressions/index.js +14 -0
- package/dist/expressions/index.js.map +1 -0
- package/dist/expressions/numeric-functions.d.ts +277 -0
- package/dist/expressions/numeric-functions.d.ts.map +1 -0
- package/dist/expressions/numeric-functions.js +52 -0
- package/dist/expressions/numeric-functions.js.map +1 -0
- package/dist/expressions/parse-expression-string.d.ts +21 -0
- package/dist/expressions/parse-expression-string.d.ts.map +1 -0
- package/dist/expressions/parse-expression-string.js +61 -0
- package/dist/expressions/parse-expression-string.js.map +1 -0
- package/dist/expressions/predicate-expression.d.ts +7 -0
- package/dist/expressions/predicate-expression.d.ts.map +1 -0
- package/dist/expressions/predicate-expression.js +112 -0
- package/dist/expressions/predicate-expression.js.map +1 -0
- package/dist/expressions/scalar-type.d.ts +6 -0
- package/dist/expressions/scalar-type.d.ts.map +1 -0
- package/dist/expressions/scalar-type.js +23 -0
- package/dist/expressions/scalar-type.js.map +1 -0
- package/dist/expressions/vendor/jsep/runtime.d.ts +3 -0
- package/dist/expressions/vendor/jsep/runtime.d.ts.map +1 -0
- package/dist/expressions/vendor/jsep/runtime.js +972 -0
- package/dist/expressions/vendor/jsep/runtime.js.map +1 -0
- package/dist/expressions/vendor/jsep/types.d.ts +148 -0
- package/dist/expressions/vendor/jsep/types.d.ts.map +1 -0
- package/dist/expressions/vendor/jsep/types.js +6 -0
- package/dist/expressions/vendor/jsep/types.js.map +1 -0
- package/dist/index.cjs +5294 -0
- package/dist/index.cjs.map +6 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -0
- package/dist/math-functions/index.cjs +444 -0
- package/dist/math-functions/index.cjs.map +6 -0
- package/dist/math-functions/index.d.ts +44 -0
- package/dist/math-functions/index.d.ts.map +1 -0
- package/dist/math-functions/index.js +182 -0
- package/dist/math-functions/index.js.map +1 -0
- package/dist/parser/bind-sql-predicate.d.ts +4 -0
- package/dist/parser/bind-sql-predicate.d.ts.map +1 -0
- package/dist/parser/bind-sql-predicate.js +11 -0
- package/dist/parser/bind-sql-predicate.js.map +1 -0
- package/dist/parser/index.cjs +1807 -0
- package/dist/parser/index.cjs.map +6 -0
- package/dist/parser/index.d.ts +12 -0
- package/dist/parser/index.d.ts.map +1 -0
- package/dist/parser/index.js +11 -0
- package/dist/parser/index.js.map +1 -0
- package/dist/parser/parameter-snapshots.d.ts +21 -0
- package/dist/parser/parameter-snapshots.d.ts.map +1 -0
- package/dist/parser/parameter-snapshots.js +85 -0
- package/dist/parser/parameter-snapshots.js.map +1 -0
- package/dist/parser/parse-sql-expression.d.ts +50 -0
- package/dist/parser/parse-sql-expression.d.ts.map +1 -0
- package/dist/parser/parse-sql-expression.js +501 -0
- package/dist/parser/parse-sql-expression.js.map +1 -0
- package/dist/parser/parse-sql-predicate.d.ts +13 -0
- package/dist/parser/parse-sql-predicate.d.ts.map +1 -0
- package/dist/parser/parse-sql-predicate.js +365 -0
- package/dist/parser/parse-sql-predicate.js.map +1 -0
- package/dist/parser/parse-sql-query.d.ts +9 -0
- package/dist/parser/parse-sql-query.d.ts.map +1 -0
- package/dist/parser/parse-sql-query.js +81 -0
- package/dist/parser/parse-sql-query.js.map +1 -0
- package/dist/parser/parse-sql-select.d.ts +57 -0
- package/dist/parser/parse-sql-select.d.ts.map +1 -0
- package/dist/parser/parse-sql-select.js +247 -0
- package/dist/parser/parse-sql-select.js.map +1 -0
- package/dist/parser/parse-sql-statement.d.ts +54 -0
- package/dist/parser/parse-sql-statement.d.ts.map +1 -0
- package/dist/parser/parse-sql-statement.js +207 -0
- package/dist/parser/parse-sql-statement.js.map +1 -0
- package/dist/parser/query-types.d.ts +56 -0
- package/dist/parser/query-types.d.ts.map +1 -0
- package/dist/parser/query-types.js +5 -0
- package/dist/parser/query-types.js.map +1 -0
- package/dist/parser/sql-parameters.d.ts +29 -0
- package/dist/parser/sql-parameters.d.ts.map +1 -0
- package/dist/parser/sql-parameters.js +110 -0
- package/dist/parser/sql-parameters.js.map +1 -0
- package/dist/parser/sql-parse-error.d.ts +13 -0
- package/dist/parser/sql-parse-error.d.ts.map +1 -0
- package/dist/parser/sql-parse-error.js +20 -0
- package/dist/parser/sql-parse-error.js.map +1 -0
- package/dist/parser/sql-predicate-schema.d.ts +164 -0
- package/dist/parser/sql-predicate-schema.d.ts.map +1 -0
- package/dist/parser/sql-predicate-schema.js +249 -0
- package/dist/parser/sql-predicate-schema.js.map +1 -0
- package/dist/parser/sql-predicate-types.d.ts +48 -0
- package/dist/parser/sql-predicate-types.d.ts.map +1 -0
- package/dist/parser/sql-predicate-types.js +9 -0
- package/dist/parser/sql-predicate-types.js.map +1 -0
- package/dist/parser/sql-predicate.d.ts +6 -0
- package/dist/parser/sql-predicate.d.ts.map +1 -0
- package/dist/parser/sql-predicate.js +8 -0
- package/dist/parser/sql-predicate.js.map +1 -0
- package/dist/scales/arrow-domains.d.ts +22 -0
- package/dist/scales/arrow-domains.d.ts.map +1 -0
- package/dist/scales/arrow-domains.js +166 -0
- package/dist/scales/arrow-domains.js.map +1 -0
- package/dist/scales/arrow-scales.d.ts +44 -0
- package/dist/scales/arrow-scales.d.ts.map +1 -0
- package/dist/scales/arrow-scales.js +255 -0
- package/dist/scales/arrow-scales.js.map +1 -0
- package/dist/scales/compile-scale.d.ts +2 -0
- package/dist/scales/compile-scale.d.ts.map +1 -0
- package/dist/scales/compile-scale.js +5 -0
- package/dist/scales/compile-scale.js.map +1 -0
- package/dist/scales/conformance.cjs +180 -0
- package/dist/scales/conformance.cjs.map +6 -0
- package/dist/scales/conformance.d.ts +26 -0
- package/dist/scales/conformance.d.ts.map +1 -0
- package/dist/scales/conformance.js +164 -0
- package/dist/scales/conformance.js.map +1 -0
- package/dist/scales/hdr-colors.d.ts +2 -0
- package/dist/scales/hdr-colors.d.ts.map +1 -0
- package/dist/scales/hdr-colors.js +5 -0
- package/dist/scales/hdr-colors.js.map +1 -0
- package/dist/scales/index.cjs +4334 -0
- package/dist/scales/index.cjs.map +6 -0
- package/dist/scales/index.d.ts +10 -0
- package/dist/scales/index.d.ts.map +1 -0
- package/dist/scales/index.js +11 -0
- package/dist/scales/index.js.map +1 -0
- package/dist/scales/palettes.d.ts +2 -0
- package/dist/scales/palettes.d.ts.map +1 -0
- package/dist/scales/palettes.js +5 -0
- package/dist/scales/palettes.js.map +1 -0
- package/dist/scales/parse-sql-scale.d.ts +27 -0
- package/dist/scales/parse-sql-scale.d.ts.map +1 -0
- package/dist/scales/parse-sql-scale.js +257 -0
- package/dist/scales/parse-sql-scale.js.map +1 -0
- package/dist/scales/quantile-sketch.d.ts +2 -0
- package/dist/scales/quantile-sketch.d.ts.map +1 -0
- package/dist/scales/quantile-sketch.js +5 -0
- package/dist/scales/quantile-sketch.js.map +1 -0
- package/dist/scales/scale-types.d.ts +2 -0
- package/dist/scales/scale-types.d.ts.map +1 -0
- package/dist/scales/scale-types.js +5 -0
- package/dist/scales/scale-types.js.map +1 -0
- package/dist/scales/streaming-domains.d.ts +18 -0
- package/dist/scales/streaming-domains.d.ts.map +1 -0
- package/dist/scales/streaming-domains.js +115 -0
- package/dist/scales/streaming-domains.js.map +1 -0
- package/package.json +92 -4
- package/src/arrow/aggregates.ts +386 -0
- package/src/arrow/buffers.ts +177 -0
- package/src/arrow/cast.ts +160 -0
- package/src/arrow/compiler.ts +1778 -0
- package/src/arrow/float16.ts +25 -0
- package/src/arrow/index.ts +22 -0
- package/src/arrow/like.ts +72 -0
- package/src/arrow/list-values.ts +221 -0
- package/src/arrow/predicate.ts +19 -0
- package/src/arrow/query-arrow-aggregate-snapshots.ts +107 -0
- package/src/arrow/query-arrow-sql.ts +255 -0
- package/src/arrow/query-arrow-table.ts +298 -0
- package/src/arrow/query-worker-entry.ts +8 -0
- package/src/arrow/query-worker.ts +194 -0
- package/src/arrow/registry.ts +87 -0
- package/src/arrow/relational-query.ts +247 -0
- package/src/arrow/replace-arrow-columns.ts +71 -0
- package/src/arrow/signature.ts +50 -0
- package/src/arrow/temporal-cast.ts +66 -0
- package/src/arrow/types.ts +76 -0
- package/src/arrow/unnest-arrow-column.ts +145 -0
- package/src/arrow/worker-entry.ts +10 -0
- package/src/arrow/worker.ts +143 -0
- package/src/color-functions/index.ts +405 -0
- package/src/diagnostic-log.ts +20 -0
- package/src/expressions/ast.ts +143 -0
- package/src/expressions/columnar-predicate.ts +293 -0
- package/src/expressions/evaluation-error.ts +29 -0
- package/src/expressions/expression-eval.ts +489 -0
- package/src/expressions/function-libraries.ts +126 -0
- package/src/expressions/function-registry.ts +171 -0
- package/src/expressions/get.ts +37 -0
- package/src/expressions/index.ts +40 -0
- package/src/expressions/numeric-functions.ts +99 -0
- package/src/expressions/parse-expression-string.ts +80 -0
- package/src/expressions/predicate-expression.ts +128 -0
- package/src/expressions/scalar-type.ts +39 -0
- package/src/expressions/vendor/jsep/LICENSE.txt +23 -0
- package/src/expressions/vendor/jsep/runtime.ts +949 -0
- package/src/expressions/vendor/jsep/types.ts +191 -0
- package/src/index.ts +54 -0
- package/src/math-functions/index.ts +235 -0
- package/src/parser/bind-sql-predicate.ts +21 -0
- package/src/parser/index.ts +43 -0
- package/src/parser/parameter-snapshots.ts +103 -0
- package/src/parser/parse-sql-expression.ts +500 -0
- package/src/parser/parse-sql-predicate.ts +454 -0
- package/src/parser/parse-sql-query.ts +90 -0
- package/src/parser/parse-sql-select.ts +272 -0
- package/src/parser/parse-sql-statement.ts +260 -0
- package/src/parser/query-types.ts +71 -0
- package/src/parser/sql-parameters.ts +174 -0
- package/src/parser/sql-parse-error.ts +33 -0
- package/src/parser/sql-predicate-schema.ts +279 -0
- package/src/parser/sql-predicate-types.ts +91 -0
- package/src/parser/sql-predicate.ts +28 -0
- package/src/scales/arrow-domains.ts +190 -0
- package/src/scales/arrow-scales.ts +363 -0
- package/src/scales/compile-scale.ts +5 -0
- package/src/scales/conformance.ts +186 -0
- package/src/scales/hdr-colors.ts +5 -0
- package/src/scales/index.ts +37 -0
- package/src/scales/palettes.ts +5 -0
- package/src/scales/parse-sql-scale.ts +300 -0
- package/src/scales/quantile-sketch.ts +5 -0
- package/src/scales/scale-types.ts +5 -0
- package/src/scales/streaming-domains.ts +139 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
isSQLParameterSnapshot,
|
|
7
|
+
snapshotParameter,
|
|
8
|
+
type SQLParameterSnapshot
|
|
9
|
+
} from './parameter-snapshots';
|
|
10
|
+
import type {Expression} from '../expressions';
|
|
11
|
+
import {
|
|
12
|
+
isColumnarPredicateValue,
|
|
13
|
+
type ColumnarPredicateValue
|
|
14
|
+
} from '../expressions/columnar-predicate';
|
|
15
|
+
|
|
16
|
+
/** Numeric typed arrays accepted as array parameters (Uint8Array is binary unless tagged). */
|
|
17
|
+
export type SQLNumericArray =
|
|
18
|
+
| Float32Array
|
|
19
|
+
| Float64Array
|
|
20
|
+
| Int8Array
|
|
21
|
+
| Uint8Array
|
|
22
|
+
| Uint8ClampedArray
|
|
23
|
+
| Int16Array
|
|
24
|
+
| Uint16Array
|
|
25
|
+
| Int32Array
|
|
26
|
+
| Uint32Array;
|
|
27
|
+
|
|
28
|
+
/** Explicit interpretation of byte storage; numeric arrays may also use this form. */
|
|
29
|
+
export type SQLBinaryParameter =
|
|
30
|
+
| Readonly<{type: 'utf8' | 'binary'; value: Uint8Array}>
|
|
31
|
+
| Readonly<{type: 'array'; value: SQLNumericArray}>;
|
|
32
|
+
|
|
33
|
+
/** Bound SQL value, including flat lists and numeric tuples used by color palettes. */
|
|
34
|
+
export type SQLParameterValue =
|
|
35
|
+
| ColumnarPredicateValue
|
|
36
|
+
| SQLNumericArray
|
|
37
|
+
| SQLBinaryParameter
|
|
38
|
+
| null
|
|
39
|
+
| readonly number[]
|
|
40
|
+
| readonly string[]
|
|
41
|
+
| readonly (readonly number[] | SQLNumericArray)[];
|
|
42
|
+
|
|
43
|
+
/** Caller-owned values keyed by case-sensitive names without the leading colon. */
|
|
44
|
+
export type SQLParameters = Readonly<Record<string, SQLParameterValue>>;
|
|
45
|
+
|
|
46
|
+
/** Bind values directly, or retain the existing custom AST interpretation callback. */
|
|
47
|
+
export type SQLParameterOptions = Readonly<{
|
|
48
|
+
/** Values referenced by SQL placeholders such as `:minimum` or `:colors`. */
|
|
49
|
+
parameters?: SQLParameters | SQLParameterSnapshot;
|
|
50
|
+
/** Custom interpretation of a placeholder; mutually exclusive with parameters. */
|
|
51
|
+
parseParameter?: (name: string) => Expression;
|
|
52
|
+
}>;
|
|
53
|
+
|
|
54
|
+
/** Rejects ambiguous binding configuration even when a statement has no placeholders. */
|
|
55
|
+
export function validateSQLParameterOptions(options: SQLParameterOptions): void {
|
|
56
|
+
if (options.parameters !== undefined && options.parseParameter !== undefined) {
|
|
57
|
+
throw new Error('SQL parameters and parseParameter are mutually exclusive');
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** Resolves a named value into a copied literal AST without interpreting it as SQL. */
|
|
62
|
+
export function bindSQLParameter(name: string, options: SQLParameterOptions): Expression {
|
|
63
|
+
if (options.parseParameter) return options.parseParameter(name);
|
|
64
|
+
if (isSQLParameterSnapshot(options.parameters))
|
|
65
|
+
return snapshotParameter(options.parameters as SQLParameterSnapshot, name);
|
|
66
|
+
if (!Object.prototype.hasOwnProperty.call(options.parameters ?? {}, name)) {
|
|
67
|
+
throw new Error(`SQL parameter ":${name}" requires a value`);
|
|
68
|
+
}
|
|
69
|
+
const value = options.parameters![name];
|
|
70
|
+
if (isNumericArray(value) && !(value instanceof Uint8Array))
|
|
71
|
+
return typedArrayLiteral(value, name);
|
|
72
|
+
if (value && typeof value === 'object' && 'type' in value) {
|
|
73
|
+
if (value.type === 'array' && isNumericArray(value.value))
|
|
74
|
+
return typedArrayLiteral(value.value, name);
|
|
75
|
+
if ((value.type === 'utf8' || value.type === 'binary') && value.value instanceof Uint8Array) {
|
|
76
|
+
const data = new Uint8Array(value.value);
|
|
77
|
+
if (value.type === 'binary') return literal(data);
|
|
78
|
+
try {
|
|
79
|
+
// Retain the portable string value and its supplied physical representation.
|
|
80
|
+
// Scalar evaluators use value; Arrow comparisons consume utf8 directly.
|
|
81
|
+
return {
|
|
82
|
+
type: 'Literal',
|
|
83
|
+
value: new TextDecoder('utf-8', {fatal: true, ignoreBOM: true}).decode(data),
|
|
84
|
+
utf8: data
|
|
85
|
+
} as Expression;
|
|
86
|
+
} catch {
|
|
87
|
+
throw new Error(`SQL parameter ":${name}" requires valid UTF-8 bytes`);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
throw new Error(`SQL parameter ":${name}" has an unsupported binary format`);
|
|
91
|
+
}
|
|
92
|
+
if (Array.isArray(value)) {
|
|
93
|
+
if (
|
|
94
|
+
value.length > 4096 ||
|
|
95
|
+
!(
|
|
96
|
+
Array.from(value).every(item => typeof item === 'number' && Number.isFinite(item)) ||
|
|
97
|
+
Array.from(value).every(item => typeof item === 'string') ||
|
|
98
|
+
Array.from(value).every(
|
|
99
|
+
item =>
|
|
100
|
+
(Array.isArray(item) || isNumericArray(item)) &&
|
|
101
|
+
item.length <= 4096 &&
|
|
102
|
+
Array.from(item).every(
|
|
103
|
+
component => typeof component === 'number' && Number.isFinite(component)
|
|
104
|
+
)
|
|
105
|
+
)
|
|
106
|
+
)
|
|
107
|
+
)
|
|
108
|
+
throw new Error(`SQL parameter ":${name}" has an unsupported array value`);
|
|
109
|
+
return arrayLiteral(value, name);
|
|
110
|
+
}
|
|
111
|
+
if (value !== null && !isColumnarPredicateValue(value)) {
|
|
112
|
+
throw new Error(`SQL parameter ":${name}" has an unsupported value`);
|
|
113
|
+
}
|
|
114
|
+
return literal(
|
|
115
|
+
value instanceof Date
|
|
116
|
+
? new Date(value.getTime())
|
|
117
|
+
: value instanceof Uint8Array
|
|
118
|
+
? new Uint8Array(value)
|
|
119
|
+
: value
|
|
120
|
+
);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/** Builds an independent array tree; array elements are never identifiers or executable text. */
|
|
124
|
+
function arrayLiteral(values: readonly unknown[], name: string): Expression {
|
|
125
|
+
return {
|
|
126
|
+
type: 'ArrayExpression',
|
|
127
|
+
elements: Array.from(values, value =>
|
|
128
|
+
Array.isArray(value)
|
|
129
|
+
? arrayLiteral(value, name)
|
|
130
|
+
: isNumericArray(value)
|
|
131
|
+
? typedArrayLiteral(value, name)
|
|
132
|
+
: literal(value)
|
|
133
|
+
)
|
|
134
|
+
} as Expression;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** Creates a typed literal, including scalar values that cannot be represented in JSON. */
|
|
138
|
+
function literal(value: unknown): Expression {
|
|
139
|
+
if (value instanceof Uint8Array || value instanceof Date)
|
|
140
|
+
return {type: 'Literal', value} as Expression;
|
|
141
|
+
return {
|
|
142
|
+
type: 'Literal',
|
|
143
|
+
value,
|
|
144
|
+
raw: typeof value === 'bigint' ? String(value) : JSON.stringify(value)
|
|
145
|
+
} as Expression;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
/** Recognizes supported numeric storage without treating DataView or bigint arrays as numbers. */
|
|
149
|
+
function isNumericArray(value: unknown): value is SQLNumericArray {
|
|
150
|
+
return (
|
|
151
|
+
value instanceof Float32Array ||
|
|
152
|
+
value instanceof Float64Array ||
|
|
153
|
+
value instanceof Int8Array ||
|
|
154
|
+
value instanceof Uint8Array ||
|
|
155
|
+
value instanceof Uint8ClampedArray ||
|
|
156
|
+
value instanceof Int16Array ||
|
|
157
|
+
value instanceof Uint16Array ||
|
|
158
|
+
value instanceof Int32Array ||
|
|
159
|
+
value instanceof Uint32Array
|
|
160
|
+
);
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/** Snapshots typed input and supplies equivalent portable elements for non-Arrow evaluators. */
|
|
164
|
+
function typedArrayLiteral(value: SQLNumericArray, name: string): Expression {
|
|
165
|
+
if (value.length > 4096 || !value.every(Number.isFinite)) {
|
|
166
|
+
throw new Error(`SQL parameter ":${name}" has an unsupported numeric array`);
|
|
167
|
+
}
|
|
168
|
+
const typedValues = value instanceof Uint8Array ? new Uint8Array(value) : value.slice();
|
|
169
|
+
return {
|
|
170
|
+
type: 'ArrayExpression',
|
|
171
|
+
elements: Array.from(typedValues, item => literal(item)),
|
|
172
|
+
typedValues
|
|
173
|
+
} as Expression;
|
|
174
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
/** A syntax error with a position in the original SQL input. */
|
|
6
|
+
export class SQLParseError extends SyntaxError {
|
|
7
|
+
/** Zero-based UTF-16 offset. */
|
|
8
|
+
readonly offset: number;
|
|
9
|
+
/** One-based line and column, with CRLF counted as one newline. */
|
|
10
|
+
readonly line: number;
|
|
11
|
+
readonly column: number;
|
|
12
|
+
/** Bounded source preview at the cursor, or null at end of input. */
|
|
13
|
+
readonly token: string | null;
|
|
14
|
+
|
|
15
|
+
constructor(
|
|
16
|
+
readonly reason: string,
|
|
17
|
+
source: string,
|
|
18
|
+
offset: number
|
|
19
|
+
) {
|
|
20
|
+
const lines = source.slice(0, offset).split(/\r\n|\r|\n/);
|
|
21
|
+
const line = lines.length;
|
|
22
|
+
const column = lines[line - 1]!.length + 1;
|
|
23
|
+
const token = source.slice(offset, offset + 32).match(/^:?\w+|^\S/u)?.[0] ?? null;
|
|
24
|
+
super(
|
|
25
|
+
`${reason} (line ${line}, column ${column}${token ? `, near ${JSON.stringify(token)}` : ''})`
|
|
26
|
+
);
|
|
27
|
+
this.name = 'SQLParseError';
|
|
28
|
+
this.offset = offset;
|
|
29
|
+
this.line = line;
|
|
30
|
+
this.column = column;
|
|
31
|
+
this.token = token;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import {isColumnarScalarType, COLUMNAR_SCALAR_TYPES} from '../expressions/scalar-type';
|
|
6
|
+
|
|
7
|
+
import {
|
|
8
|
+
isSQLPredicateParameter,
|
|
9
|
+
type SQLPredicate,
|
|
10
|
+
type SQLPredicateValue
|
|
11
|
+
} from './sql-predicate-types';
|
|
12
|
+
|
|
13
|
+
const MAXIMUM_PREDICATE_DEPTH = 64;
|
|
14
|
+
const MAXIMUM_PREDICATE_NODES = 4096;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* JSON Schema for the JSON-serializable portion of the math.gl SQL predicate AST.
|
|
18
|
+
*
|
|
19
|
+
* In-process predicates additionally accept `bigint`, `Date`, and `Uint8Array` values, which JSON
|
|
20
|
+
* Schema cannot represent directly.
|
|
21
|
+
*/
|
|
22
|
+
export const SQL_PREDICATE_JSON_SCHEMA = {
|
|
23
|
+
$schema: 'https://json-schema.org/draft/2020-12/schema',
|
|
24
|
+
$id: 'https://math.gl/schemas/sql-predicate.schema.json',
|
|
25
|
+
title: 'math.gl SQL predicate',
|
|
26
|
+
oneOf: [
|
|
27
|
+
{$ref: '#/$defs/comparison'},
|
|
28
|
+
{$ref: '#/$defs/in'},
|
|
29
|
+
{$ref: '#/$defs/isNull'},
|
|
30
|
+
{$ref: '#/$defs/logical'},
|
|
31
|
+
{$ref: '#/$defs/not'}
|
|
32
|
+
],
|
|
33
|
+
$defs: {
|
|
34
|
+
property: {
|
|
35
|
+
type: 'object',
|
|
36
|
+
required: ['property'],
|
|
37
|
+
properties: {
|
|
38
|
+
property: {type: 'string', minLength: 1},
|
|
39
|
+
quoted: {type: 'boolean'},
|
|
40
|
+
casts: {
|
|
41
|
+
type: 'array',
|
|
42
|
+
minItems: 1,
|
|
43
|
+
maxItems: 64,
|
|
44
|
+
items: {enum: COLUMNAR_SCALAR_TYPES as readonly string[]}
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
additionalProperties: false
|
|
48
|
+
},
|
|
49
|
+
value: {
|
|
50
|
+
oneOf: [
|
|
51
|
+
{type: ['boolean', 'number', 'string']},
|
|
52
|
+
{
|
|
53
|
+
type: 'object',
|
|
54
|
+
required: ['parameter'],
|
|
55
|
+
properties: {parameter: {type: 'string', minLength: 1}},
|
|
56
|
+
additionalProperties: false
|
|
57
|
+
}
|
|
58
|
+
]
|
|
59
|
+
},
|
|
60
|
+
comparison: {
|
|
61
|
+
type: 'object',
|
|
62
|
+
required: ['op', 'args'],
|
|
63
|
+
properties: {
|
|
64
|
+
op: {enum: ['=', '<>', '<', '<=', '>', '>=']},
|
|
65
|
+
args: {
|
|
66
|
+
type: 'array',
|
|
67
|
+
prefixItems: [{$ref: '#/$defs/property'}, {$ref: '#/$defs/value'}],
|
|
68
|
+
minItems: 2,
|
|
69
|
+
maxItems: 2
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
additionalProperties: false
|
|
73
|
+
},
|
|
74
|
+
in: {
|
|
75
|
+
type: 'object',
|
|
76
|
+
required: ['op', 'args'],
|
|
77
|
+
properties: {
|
|
78
|
+
op: {const: 'in'},
|
|
79
|
+
args: {
|
|
80
|
+
type: 'array',
|
|
81
|
+
prefixItems: [
|
|
82
|
+
{$ref: '#/$defs/property'},
|
|
83
|
+
{type: 'array', items: {$ref: '#/$defs/value'}, minItems: 1}
|
|
84
|
+
],
|
|
85
|
+
minItems: 2,
|
|
86
|
+
maxItems: 2
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
additionalProperties: false
|
|
90
|
+
},
|
|
91
|
+
isNull: {
|
|
92
|
+
type: 'object',
|
|
93
|
+
required: ['op', 'args'],
|
|
94
|
+
properties: {
|
|
95
|
+
op: {const: 'isNull'},
|
|
96
|
+
args: {
|
|
97
|
+
type: 'array',
|
|
98
|
+
prefixItems: [{$ref: '#/$defs/property'}],
|
|
99
|
+
minItems: 1,
|
|
100
|
+
maxItems: 1
|
|
101
|
+
}
|
|
102
|
+
},
|
|
103
|
+
additionalProperties: false
|
|
104
|
+
},
|
|
105
|
+
logical: {
|
|
106
|
+
type: 'object',
|
|
107
|
+
required: ['op', 'args'],
|
|
108
|
+
properties: {
|
|
109
|
+
op: {enum: ['and', 'or']},
|
|
110
|
+
args: {type: 'array', items: {$ref: '#'}, minItems: 2}
|
|
111
|
+
},
|
|
112
|
+
additionalProperties: false
|
|
113
|
+
},
|
|
114
|
+
not: {
|
|
115
|
+
type: 'object',
|
|
116
|
+
required: ['op', 'args'],
|
|
117
|
+
properties: {
|
|
118
|
+
op: {const: 'not'},
|
|
119
|
+
args: {
|
|
120
|
+
type: 'array',
|
|
121
|
+
prefixItems: [{$ref: '#'}],
|
|
122
|
+
minItems: 1,
|
|
123
|
+
maxItems: 1
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
additionalProperties: false
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
} as const;
|
|
130
|
+
|
|
131
|
+
/** Returns whether an unknown value is a valid portable SQL predicate. */
|
|
132
|
+
export function isSQLPredicate(value: unknown): value is SQLPredicate {
|
|
133
|
+
try {
|
|
134
|
+
validateSQLPredicate(value);
|
|
135
|
+
return true;
|
|
136
|
+
} catch {
|
|
137
|
+
return false;
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/** Validates an unknown portable SQL predicate or throws a path-specific error. */
|
|
142
|
+
export function validateSQLPredicate(value: unknown): asserts value is SQLPredicate {
|
|
143
|
+
const state = {nodes: 0};
|
|
144
|
+
validatePredicateNode(value, '$', 0, state);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/** Validates one recursive predicate node. */
|
|
148
|
+
function validatePredicateNode(
|
|
149
|
+
value: unknown,
|
|
150
|
+
path: string,
|
|
151
|
+
depth: number,
|
|
152
|
+
state: {nodes: number}
|
|
153
|
+
): asserts value is SQLPredicate {
|
|
154
|
+
if (depth > MAXIMUM_PREDICATE_DEPTH) {
|
|
155
|
+
throw new Error(`SQL predicate ${path} exceeds the maximum nesting depth`);
|
|
156
|
+
}
|
|
157
|
+
state.nodes++;
|
|
158
|
+
if (state.nodes > MAXIMUM_PREDICATE_NODES) {
|
|
159
|
+
throw new Error('SQL predicate exceeds the maximum node count');
|
|
160
|
+
}
|
|
161
|
+
if (!isRecord(value) || !hasExactKeys(value, ['op', 'args'])) {
|
|
162
|
+
throw new Error(`SQL predicate ${path} must contain only op and args`);
|
|
163
|
+
}
|
|
164
|
+
if (typeof value['op'] !== 'string' || !Array.isArray(value['args'])) {
|
|
165
|
+
throw new Error(`SQL predicate ${path} requires string op and array args`);
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
switch (value['op']) {
|
|
169
|
+
case 'and':
|
|
170
|
+
case 'or':
|
|
171
|
+
if (value['args'].length < 2) {
|
|
172
|
+
throw new Error(`SQL predicate ${path}.${value['op']} requires at least two arguments`);
|
|
173
|
+
}
|
|
174
|
+
for (let index = 0; index < value['args'].length; index++) {
|
|
175
|
+
validatePredicateNode(value['args'][index], `${path}.args[${index}]`, depth + 1, state);
|
|
176
|
+
}
|
|
177
|
+
return;
|
|
178
|
+
case 'not':
|
|
179
|
+
if (value['args'].length !== 1) {
|
|
180
|
+
throw new Error(`SQL predicate ${path}.not requires exactly one argument`);
|
|
181
|
+
}
|
|
182
|
+
validatePredicateNode(value['args'][0], `${path}.args[0]`, depth + 1, state);
|
|
183
|
+
return;
|
|
184
|
+
case 'isNull':
|
|
185
|
+
if (value['args'].length !== 1) {
|
|
186
|
+
throw new Error(`SQL predicate ${path}.isNull requires exactly one argument`);
|
|
187
|
+
}
|
|
188
|
+
validatePredicateProperty(value['args'][0], `${path}.args[0]`);
|
|
189
|
+
return;
|
|
190
|
+
case 'in':
|
|
191
|
+
if (
|
|
192
|
+
value['args'].length !== 2 ||
|
|
193
|
+
!Array.isArray(value['args'][1]) ||
|
|
194
|
+
value['args'][1].length === 0
|
|
195
|
+
) {
|
|
196
|
+
throw new Error(`SQL predicate ${path}.in requires a property and non-empty value list`);
|
|
197
|
+
}
|
|
198
|
+
validatePredicateProperty(value['args'][0], `${path}.args[0]`);
|
|
199
|
+
for (let index = 0; index < value['args'][1].length; index++) {
|
|
200
|
+
validatePredicateValue(value['args'][1][index], `${path}.args[1][${index}]`);
|
|
201
|
+
}
|
|
202
|
+
return;
|
|
203
|
+
case '=':
|
|
204
|
+
case '<>':
|
|
205
|
+
case '<':
|
|
206
|
+
case '<=':
|
|
207
|
+
case '>':
|
|
208
|
+
case '>=':
|
|
209
|
+
if (value['args'].length !== 2) {
|
|
210
|
+
throw new Error(`SQL predicate ${path}.${value['op']} requires exactly two arguments`);
|
|
211
|
+
}
|
|
212
|
+
validatePredicateProperty(value['args'][0], `${path}.args[0]`);
|
|
213
|
+
validatePredicateValue(value['args'][1], `${path}.args[1]`);
|
|
214
|
+
return;
|
|
215
|
+
default:
|
|
216
|
+
throw new Error(
|
|
217
|
+
`SQL predicate ${path} has unsupported operator ${JSON.stringify(value['op'])}`
|
|
218
|
+
);
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/** Validates one property reference. */
|
|
223
|
+
function validatePredicateProperty(value: unknown, path: string): void {
|
|
224
|
+
if (
|
|
225
|
+
!isRecord(value) ||
|
|
226
|
+
!hasAllowedKeys(value, ['property', 'quoted', 'casts']) ||
|
|
227
|
+
typeof value['property'] !== 'string' ||
|
|
228
|
+
value['property'].length === 0 ||
|
|
229
|
+
(value['quoted'] !== undefined && typeof value['quoted'] !== 'boolean')
|
|
230
|
+
) {
|
|
231
|
+
throw new Error(`SQL predicate ${path} requires a non-empty property reference`);
|
|
232
|
+
}
|
|
233
|
+
const casts = value['casts'];
|
|
234
|
+
if (
|
|
235
|
+
casts !== undefined &&
|
|
236
|
+
(!Array.isArray(casts) ||
|
|
237
|
+
!casts.length ||
|
|
238
|
+
casts.length > 64 ||
|
|
239
|
+
Array.from(casts).some(type => !isColumnarScalarType(type)))
|
|
240
|
+
)
|
|
241
|
+
throw new Error(`SQL predicate ${path} has invalid casts`);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/** Validates one structured-cloneable predicate scalar. */
|
|
245
|
+
function validatePredicateValue(value: unknown, path: string): asserts value is SQLPredicateValue {
|
|
246
|
+
if (isSQLPredicateParameter(value)) {
|
|
247
|
+
return;
|
|
248
|
+
}
|
|
249
|
+
if (
|
|
250
|
+
typeof value === 'boolean' ||
|
|
251
|
+
typeof value === 'bigint' ||
|
|
252
|
+
typeof value === 'string' ||
|
|
253
|
+
value instanceof Uint8Array
|
|
254
|
+
) {
|
|
255
|
+
return;
|
|
256
|
+
}
|
|
257
|
+
if (typeof value === 'number' && Number.isFinite(value)) {
|
|
258
|
+
return;
|
|
259
|
+
}
|
|
260
|
+
if (value instanceof Date && Number.isFinite(value.getTime())) {
|
|
261
|
+
return;
|
|
262
|
+
}
|
|
263
|
+
throw new Error(`SQL predicate ${path} contains an unsupported scalar value`);
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/** Returns whether an unknown value is a non-null object. */
|
|
267
|
+
function isRecord(value: unknown): value is Record<string, unknown> {
|
|
268
|
+
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
/** Returns whether an object contains exactly the expected enumerable keys. */
|
|
272
|
+
function hasExactKeys(value: Record<string, unknown>, expectedKeys: readonly string[]): boolean {
|
|
273
|
+
const keys = Object.keys(value);
|
|
274
|
+
return keys.length === expectedKeys.length && expectedKeys.every(key => keys.includes(key));
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
function hasAllowedKeys(value: Record<string, unknown>, allowedKeys: readonly string[]): boolean {
|
|
278
|
+
return Object.keys(value).every(key => allowedKeys.includes(key));
|
|
279
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import type {ColumnarScalarType} from '../expressions/scalar-type';
|
|
6
|
+
|
|
7
|
+
import {
|
|
8
|
+
isColumnarPredicateParameter,
|
|
9
|
+
type ColumnarComparisonPredicate,
|
|
10
|
+
type ColumnarInPredicate,
|
|
11
|
+
type ColumnarLogicalPredicate,
|
|
12
|
+
type ColumnarNotPredicate,
|
|
13
|
+
type ColumnarNullPredicate,
|
|
14
|
+
type ColumnarPredicate,
|
|
15
|
+
type ColumnarPredicateInputValue,
|
|
16
|
+
type ColumnarPredicateParameter,
|
|
17
|
+
type ColumnarPredicateParameterValues,
|
|
18
|
+
type ColumnarPredicateValue
|
|
19
|
+
} from '../expressions/columnar-predicate';
|
|
20
|
+
|
|
21
|
+
/** Scalar values supported by portable SQL predicate expressions. */
|
|
22
|
+
export type SQLPredicateScalar = ColumnarPredicateValue;
|
|
23
|
+
|
|
24
|
+
/** Named parameter reference retained in a portable SQL predicate until execution time. */
|
|
25
|
+
export type SQLPredicateParameter = ColumnarPredicateParameter;
|
|
26
|
+
|
|
27
|
+
/** Scalar value or unresolved named parameter accepted by a portable predicate expression. */
|
|
28
|
+
export type SQLPredicateValue = ColumnarPredicateInputValue;
|
|
29
|
+
|
|
30
|
+
/** Runtime values used to bind named predicate parameters before a backend executes them. */
|
|
31
|
+
export type SQLPredicateParameterValues = ColumnarPredicateParameterValues;
|
|
32
|
+
|
|
33
|
+
/** Reference to one column in a portable SQL predicate expression. */
|
|
34
|
+
export type SQLPredicateProperty = Readonly<{
|
|
35
|
+
/** Column or qualified column name. */
|
|
36
|
+
property: string;
|
|
37
|
+
/** Whether the complete property was a quoted SQL identifier. */
|
|
38
|
+
quoted?: boolean;
|
|
39
|
+
/** Explicit conversions, applied in order before predicate comparison. */
|
|
40
|
+
casts?: readonly ColumnarScalarType[];
|
|
41
|
+
}>;
|
|
42
|
+
|
|
43
|
+
/** Binary comparison between a column and a scalar value. */
|
|
44
|
+
export type SQLComparisonPredicate = Readonly<
|
|
45
|
+
ColumnarComparisonPredicate<SQLPredicateValue, SQLPredicateProperty>
|
|
46
|
+
>;
|
|
47
|
+
|
|
48
|
+
/** Membership test between a column and scalar values. */
|
|
49
|
+
export type SQLInPredicate = Readonly<ColumnarInPredicate<SQLPredicateValue, SQLPredicateProperty>>;
|
|
50
|
+
|
|
51
|
+
/** Null test for one column. */
|
|
52
|
+
export type SQLNullPredicate = Readonly<ColumnarNullPredicate<SQLPredicateProperty>>;
|
|
53
|
+
|
|
54
|
+
/** Conjunction or disjunction of two or more predicates. */
|
|
55
|
+
export type SQLLogicalPredicate = Readonly<
|
|
56
|
+
ColumnarLogicalPredicate<SQLPredicateValue, SQLPredicateProperty>
|
|
57
|
+
>;
|
|
58
|
+
|
|
59
|
+
/** Negation of one predicate. */
|
|
60
|
+
export type SQLNotPredicate = Readonly<
|
|
61
|
+
ColumnarNotPredicate<SQLPredicateValue, SQLPredicateProperty>
|
|
62
|
+
>;
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Portable predicate AST emitted by the math.gl SQL expression parser.
|
|
66
|
+
*
|
|
67
|
+
* The expression shape is directionally aligned with CQL2 JSON, but this deliberately small
|
|
68
|
+
* subset does not claim CQL2 conformance.
|
|
69
|
+
*/
|
|
70
|
+
export type SQLPredicate =
|
|
71
|
+
| SQLComparisonPredicate
|
|
72
|
+
| SQLInPredicate
|
|
73
|
+
| SQLNullPredicate
|
|
74
|
+
| SQLLogicalPredicate
|
|
75
|
+
| SQLNotPredicate;
|
|
76
|
+
|
|
77
|
+
/** Portable SQL predicate whose named parameters have all been replaced by concrete scalars. */
|
|
78
|
+
export type BoundSQLPredicate = ColumnarPredicate<SQLPredicateScalar, SQLPredicateProperty>;
|
|
79
|
+
|
|
80
|
+
/** Options for parsing one SQL predicate expression. */
|
|
81
|
+
export type SQLPredicateParserOptions = Readonly<{
|
|
82
|
+
/** Named values referenced using SQL parameters such as `:minimumFare`. */
|
|
83
|
+
parameters?: SQLPredicateParameterValues;
|
|
84
|
+
/** Retains named references in the emitted AST instead of resolving them while parsing. */
|
|
85
|
+
preserveParameters?: boolean;
|
|
86
|
+
}>;
|
|
87
|
+
|
|
88
|
+
/** Returns whether a value is a named parameter reference. */
|
|
89
|
+
export function isSQLPredicateParameter(value: unknown): value is SQLPredicateParameter {
|
|
90
|
+
return isColumnarPredicateParameter(value);
|
|
91
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
// math.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
export {parseSQLPredicate} from './parse-sql-predicate';
|
|
6
|
+
export {
|
|
7
|
+
isSQLPredicate,
|
|
8
|
+
SQL_PREDICATE_JSON_SCHEMA,
|
|
9
|
+
validateSQLPredicate
|
|
10
|
+
} from './sql-predicate-schema';
|
|
11
|
+
export {bindSQLPredicate} from './bind-sql-predicate';
|
|
12
|
+
export {isSQLPredicateParameter} from './sql-predicate-types';
|
|
13
|
+
|
|
14
|
+
export type {
|
|
15
|
+
BoundSQLPredicate,
|
|
16
|
+
SQLComparisonPredicate,
|
|
17
|
+
SQLInPredicate,
|
|
18
|
+
SQLLogicalPredicate,
|
|
19
|
+
SQLNotPredicate,
|
|
20
|
+
SQLNullPredicate,
|
|
21
|
+
SQLPredicate,
|
|
22
|
+
SQLPredicateParameter,
|
|
23
|
+
SQLPredicateParameterValues,
|
|
24
|
+
SQLPredicateParserOptions,
|
|
25
|
+
SQLPredicateProperty,
|
|
26
|
+
SQLPredicateScalar,
|
|
27
|
+
SQLPredicateValue
|
|
28
|
+
} from './sql-predicate-types';
|