@vaultgradient/pipequery-lang 1.2.2 → 1.2.3
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/README.md +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<a href="https://github.com/andreadito/pipequery/releases/latest"><img src="https://img.shields.io/github/v/release/andreadito/pipequery?label=release&color=orange" alt="release" /></a>
|
|
9
|
-
<a href="https://
|
|
10
|
-
<a href="https://
|
|
9
|
+
<a href="https://www.npmjs.com/package/@vaultgradient/pipequery-lang"><img src="https://img.shields.io/npm/v/@vaultgradient/pipequery-lang?label=npm%20%28engine%29&color=cb3837&logo=npm" alt="engine package" /></a>
|
|
10
|
+
<a href="https://www.npmjs.com/package/@vaultgradient/pipequery-cli"><img src="https://img.shields.io/npm/v/@vaultgradient/pipequery-cli?label=npm%20%28cli%29&color=cb3837&logo=npm" alt="cli package" /></a>
|
|
11
11
|
<a href="https://github.com/andreadito/pipequery/pkgs/container/pipequery"><img src="https://img.shields.io/badge/ghcr.io-pipequery-blue?logo=docker" alt="docker" /></a>
|
|
12
12
|
<a href="https://github.com/andreadito/pipequery/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" /></a>
|
|
13
13
|
<a href="https://github.com/andreadito/pipequery"><img src="https://img.shields.io/badge/TypeScript-100%25-blue.svg" alt="TypeScript" /></a>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
## Install
|
|
30
30
|
|
|
31
31
|
```bash
|
|
32
|
-
npm install @
|
|
32
|
+
npm install @vaultgradient/pipequery-lang
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
## CLI — `pq`
|
|
@@ -37,7 +37,7 @@ npm install @andreadito/pipequery-lang
|
|
|
37
37
|
PipeQuery also ships a CLI tool for building data pipelines, REST APIs, and rich terminal dashboards.
|
|
38
38
|
|
|
39
39
|
```bash
|
|
40
|
-
npm install -g @
|
|
40
|
+
npm install -g @vaultgradient/pipequery-cli
|
|
41
41
|
|
|
42
42
|
pq init # scaffold a project
|
|
43
43
|
pq serve -d # start the server as a daemon
|
|
@@ -74,7 +74,7 @@ The dashboard features a resizable 2-column grid with live SSE updates and 7 vis
|
|
|
74
74
|
## Quick Start
|
|
75
75
|
|
|
76
76
|
```ts
|
|
77
|
-
import { query } from '@
|
|
77
|
+
import { query } from '@vaultgradient/pipequery-lang';
|
|
78
78
|
|
|
79
79
|
const data = [
|
|
80
80
|
{ name: 'Laptop', price: 999, category: 'Electronics' },
|
|
@@ -167,7 +167,7 @@ nested.field.path // dot access
|
|
|
167
167
|
Execute a query on data. Accepts a raw array or a named `DataContext` for multi-table queries.
|
|
168
168
|
|
|
169
169
|
```ts
|
|
170
|
-
import { query } from '@
|
|
170
|
+
import { query } from '@vaultgradient/pipequery-lang';
|
|
171
171
|
|
|
172
172
|
// Array shorthand
|
|
173
173
|
query(items, 'where(price > 50) | sort(name asc)');
|
|
@@ -184,7 +184,7 @@ query(
|
|
|
184
184
|
Pre-compile a query for repeated use. Returns a reusable function.
|
|
185
185
|
|
|
186
186
|
```ts
|
|
187
|
-
import { compile } from '@
|
|
187
|
+
import { compile } from '@vaultgradient/pipequery-lang';
|
|
188
188
|
|
|
189
189
|
const fn = compile('where(price > 100) | sort(price desc)');
|
|
190
190
|
const result = fn({ _data: items });
|
|
@@ -195,7 +195,7 @@ const result = fn({ _data: items });
|
|
|
195
195
|
Parse a query into its AST without executing.
|
|
196
196
|
|
|
197
197
|
```ts
|
|
198
|
-
import { parseQuery } from '@
|
|
198
|
+
import { parseQuery } from '@vaultgradient/pipequery-lang';
|
|
199
199
|
|
|
200
200
|
const ast = parseQuery('items | where(price > 100)');
|
|
201
201
|
// Inspect tokens, operations, expressions
|
|
@@ -206,7 +206,7 @@ const ast = parseQuery('items | where(price > 100)');
|
|
|
206
206
|
Streaming query evaluator that accepts data patches and re-executes efficiently.
|
|
207
207
|
|
|
208
208
|
```ts
|
|
209
|
-
import { liveQuery } from '@
|
|
209
|
+
import { liveQuery } from '@vaultgradient/pipequery-lang';
|
|
210
210
|
|
|
211
211
|
const lq = liveQuery(initialData, 'where(active == true) | sort(updatedAt desc)', {
|
|
212
212
|
key: 'id',
|
|
@@ -229,7 +229,7 @@ lq.dispose();
|
|
|
229
229
|
Clear the internal compiled-query LRU cache (128 entries by default).
|
|
230
230
|
|
|
231
231
|
```ts
|
|
232
|
-
import { clearCache } from '@
|
|
232
|
+
import { clearCache } from '@vaultgradient/pipequery-lang';
|
|
233
233
|
|
|
234
234
|
clearCache();
|
|
235
235
|
```
|
|
@@ -239,7 +239,7 @@ clearCache();
|
|
|
239
239
|
All errors include position info (`position`, `line`, `column`) for editor integration.
|
|
240
240
|
|
|
241
241
|
```ts
|
|
242
|
-
import { LexerError, ParseError, RuntimeError, DataWeaveError } from '@
|
|
242
|
+
import { LexerError, ParseError, RuntimeError, DataWeaveError } from '@vaultgradient/pipequery-lang';
|
|
243
243
|
|
|
244
244
|
try {
|
|
245
245
|
query(data, 'where(price >)');
|
|
@@ -256,10 +256,10 @@ try {
|
|
|
256
256
|
|
|
257
257
|
```ts
|
|
258
258
|
// CodeMirror 6
|
|
259
|
-
import { pipeQuery } from '@
|
|
259
|
+
import { pipeQuery } from '@vaultgradient/pipequery-lang/highlighting';
|
|
260
260
|
|
|
261
261
|
// Monaco Editor
|
|
262
|
-
import { registerPipeQuery } from '@
|
|
262
|
+
import { registerPipeQuery } from '@vaultgradient/pipequery-lang/highlighting';
|
|
263
263
|
```
|
|
264
264
|
|
|
265
265
|
A TextMate grammar is included at `dist/highlighting/textmate/pipequery.tmLanguage.json` for VS Code, IntelliJ, and Sublime Text.
|
|
@@ -269,7 +269,7 @@ A TextMate grammar is included at `dist/highlighting/textmate/pipequery.tmLangua
|
|
|
269
269
|
### React Components
|
|
270
270
|
|
|
271
271
|
```tsx
|
|
272
|
-
import { PipeQueryBuilder } from '@
|
|
272
|
+
import { PipeQueryBuilder } from '@vaultgradient/pipequery-lang/react';
|
|
273
273
|
|
|
274
274
|
<PipeQueryBuilder
|
|
275
275
|
datasets={datasets}
|
package/package.json
CHANGED