superdb-mcp 1.3.0 → 1.3.1
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/dist/index.js +4 -4
- package/dist/lib/expert-sections.js +2 -2
- package/dist/lib/expert-sections.js.map +1 -1
- package/dist/lib/version.d.ts.map +1 -1
- package/dist/lib/version.js +16 -3
- package/dist/lib/version.js.map +1 -1
- package/docs/superdb-expert.md +21 -26
- package/docs/zq-to-super-upgrades.md +3 -4
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -17,7 +17,7 @@ const __dirname = dirname(__filename);
|
|
|
17
17
|
const docsDir = join(__dirname, '../docs');
|
|
18
18
|
const server = new Server({
|
|
19
19
|
name: 'superdb-mcp',
|
|
20
|
-
version: '1.3.
|
|
20
|
+
version: '1.3.1',
|
|
21
21
|
}, {
|
|
22
22
|
capabilities: {
|
|
23
23
|
tools: {},
|
|
@@ -225,7 +225,7 @@ const tools = [
|
|
|
225
225
|
// --- Documentation & Reference ---
|
|
226
226
|
{
|
|
227
227
|
name: 'super_help',
|
|
228
|
-
description: 'Get SuperDB documentation (content targets v0.
|
|
228
|
+
description: 'Get SuperDB documentation (content targets v0.2.0). Call this before writing complex queries or when migrating from zq or earlier versions of SuperDB. Topics: expert (overview + section index), expert:<section> (e.g. expert:sql, expert:aggregates), expert:all (full document), upgrade (zq migration), tutorials (list tutorials), tutorial:<name> (read a specific tutorial). Call super_info to check your installed version.',
|
|
229
229
|
inputSchema: {
|
|
230
230
|
type: 'object',
|
|
231
231
|
properties: {
|
|
@@ -239,7 +239,7 @@ const tools = [
|
|
|
239
239
|
},
|
|
240
240
|
{
|
|
241
241
|
name: 'super_grok_patterns',
|
|
242
|
-
description: 'Search/filter grok patterns by name or regex content (content targets SuperDB v0.
|
|
242
|
+
description: 'Search/filter grok patterns by name or regex content (content targets SuperDB v0.2.0). Returns matching patterns as JSON array of {pattern_name, regex} objects. No query returns all patterns.',
|
|
243
243
|
inputSchema: {
|
|
244
244
|
type: 'object',
|
|
245
245
|
properties: {
|
|
@@ -252,7 +252,7 @@ const tools = [
|
|
|
252
252
|
},
|
|
253
253
|
{
|
|
254
254
|
name: 'super_recipes',
|
|
255
|
-
description: 'Search/list available SuperDB recipe functions from the superkit collection (content targets SuperDB v0.
|
|
255
|
+
description: 'Search/list available SuperDB recipe functions from the superkit collection (content targets SuperDB v0.2.0). Returns structured JSON with function signatures, descriptions, and usage examples.',
|
|
256
256
|
inputSchema: {
|
|
257
257
|
type: 'object',
|
|
258
258
|
properties: {
|
|
@@ -9,7 +9,7 @@ const docsDir = join(__dirname, '../../docs');
|
|
|
9
9
|
* Keys are the exact ## heading text (without the ## prefix).
|
|
10
10
|
*/
|
|
11
11
|
export const SECTION_SLUGS = {
|
|
12
|
-
'
|
|
12
|
+
'Note on Zed/zq Compatibility': 'warning',
|
|
13
13
|
'Core Knowledge': 'core',
|
|
14
14
|
'Language Syntax Reference': 'syntax',
|
|
15
15
|
'PostgreSQL Compatibility & Traditional SQL': 'sql',
|
|
@@ -19,7 +19,7 @@ export const SECTION_SLUGS = {
|
|
|
19
19
|
'Format Conversions': 'formats',
|
|
20
20
|
'Key Differences from SQL': 'differences',
|
|
21
21
|
'Pragmas': 'pragmas',
|
|
22
|
-
'SuperDB Quoting Rules (
|
|
22
|
+
'SuperDB Quoting Rules (Bash Integration)': 'quoting',
|
|
23
23
|
'SuperDB Array Filtering (Critical Pattern)': 'arrays',
|
|
24
24
|
'Aggregate Functions': 'aggregates',
|
|
25
25
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"expert-sections.js","sourceRoot":"","sources":["../../src/lib/expert-sections.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AAc9C;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAA2B;IACnD,
|
|
1
|
+
{"version":3,"file":"expert-sections.js","sourceRoot":"","sources":["../../src/lib/expert-sections.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AAc9C;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAA2B;IACnD,8BAA8B,EAAE,SAAS;IACzC,gBAAgB,EAAE,MAAM;IACxB,2BAA2B,EAAE,QAAQ;IACrC,4CAA4C,EAAE,KAAK;IACnD,0BAA0B,EAAE,UAAU;IACtC,2BAA2B,EAAE,UAAU;IACvC,gBAAgB,EAAE,WAAW;IAC7B,oBAAoB,EAAE,SAAS;IAC/B,0BAA0B,EAAE,aAAa;IACzC,SAAS,EAAE,SAAS;IACpB,0CAA0C,EAAE,SAAS;IACrD,4CAA4C,EAAE,QAAQ;IACtD,qBAAqB,EAAE,YAAY;CACpC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAE3C;;GAEG;AACH,SAAS,QAAQ,CAAC,OAAe;IAC/B,OAAO,OAAO;SACX,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,QAAgB;IACxC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IACjD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC1C,IAAI,MAAM,KAAK,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,IAAI,YAAY,GAAkB,IAAI,CAAC;IACvC,IAAI,YAAY,GAAa,EAAE,CAAC;IAEhC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE,CAAC;YACV,yBAAyB;YACzB,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC/C,MAAM,KAAK,GAAG,YAAY,CAAC;gBAC3B,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1G,CAAC;iBAAM,CAAC;gBACN,6CAA6C;gBAC7C,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5C,CAAC;YACD,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACxB,YAAY,GAAG,EAAE,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,qBAAqB;IACrB,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,YAAY,CAAC;QAC3B,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1G,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAoB;IAChD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,WAAW;IACX,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;IAED,2BAA2B;IAC3B,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACxD,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,sBAAsB;IACtB,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,6EAA6E,CAAC,CAAC;QAC1F,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5B,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,cAAc,OAAO,CAAC,IAAI,QAAQ,OAAO,CAAC,KAAK,MAAM,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QACrF,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED,yBAAyB;AACzB,IAAI,SAAS,GAA2B,IAAI,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,SAAS,GAAG,IAAI,CAAC;AACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/lib/version.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/lib/version.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;AAEnE,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,aAAa,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,WAAW,CAAC;IACrB,SAAS,EAAE,WAAW,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAoDD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,CAK/D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAgD7D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAS9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAiChE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAG5E;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,CAAC,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,MAAM,GACrB,iBAAiB,CAqCnB;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAYvC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI;IACxC,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAmCA;AAQD,wBAAgB,cAAc,IAAI,MAAM,GAAG,IAAI,CAW9C;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,IAAI,CAE5C"}
|
package/dist/lib/version.js
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { spawnSync } from 'child_process';
|
|
2
|
+
import { readFileSync } from 'fs';
|
|
3
|
+
import { join, dirname } from 'path';
|
|
4
|
+
import { fileURLToPath } from 'url';
|
|
2
5
|
/**
|
|
3
6
|
* Get the path to the super binary
|
|
4
7
|
*/
|
|
@@ -198,9 +201,19 @@ export function compareVersionInfo(currentPath, compareToPath) {
|
|
|
198
201
|
* Read version from embedded docs frontmatter
|
|
199
202
|
*/
|
|
200
203
|
export function getDocsVersion() {
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
+
try {
|
|
205
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
206
|
+
const __dirname = dirname(__filename);
|
|
207
|
+
const upgradeDoc = join(__dirname, '../../docs/zq-to-super-upgrades.md');
|
|
208
|
+
const content = readFileSync(upgradeDoc, 'utf-8');
|
|
209
|
+
const match = content.match(/superdb_version:\s*"([^"]+)"/);
|
|
210
|
+
if (match)
|
|
211
|
+
return match[1];
|
|
212
|
+
}
|
|
213
|
+
catch {
|
|
214
|
+
// fall through to hardcoded fallback
|
|
215
|
+
}
|
|
216
|
+
return '0.2.0';
|
|
204
217
|
}
|
|
205
218
|
/**
|
|
206
219
|
* Check compatibility between runtime and docs
|
package/dist/lib/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/lib/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/lib/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAkCpC;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,OAAO,CAAC;AAC3C,CAAC;AAED;;;;GAIG;AACH,SAAS,oBAAoB,CAAC,GAAW;IAOvC,qDAAqD;IACrD,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC/D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAE,mBAAmB;QACtD,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAQ,iBAAiB;QAEpD,kCAAkC;QAClC,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAEjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAExE,mDAAmD;QACnD,4DAA4D;QAC5D,MAAM,KAAK,GAAG,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAEnE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;IACnE,CAAC;IAED,yCAAyC;IACzC,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC3D,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,EAAE,OAAO,EAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACzG,CAAC;IAED,gCAAgC;IAChC,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACnD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAC/F,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AAC3F,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC5C,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,iBAAiB,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC/C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,SAAkB;IAC9C,MAAM,IAAI,GAAG,SAAS,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,MAAM,GAAgC,SAAS;QACnD,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAE9C,IAAI,CAAC;QACH,yDAAyD;QACzD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE;YAC5C,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO;gBACL,OAAO,EAAE,SAAS;gBAClB,MAAM,EAAE,SAAS;gBACjB,GAAG,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;gBACxB,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,IAAI;gBACT,SAAS,EAAE,IAAI;gBACf,IAAI;gBACJ,MAAM;aACP,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5C,OAAO;YACL,GAAG,MAAM;YACT,GAAG,EAAE,MAAM;YACX,IAAI;YACJ,MAAM;SACP,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,SAAS;YACjB,GAAG,EAAE,EAAE;YACP,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,IAAI;YACT,SAAS,EAAE,IAAI;YACf,IAAI;YACJ,MAAM;SACP,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACvD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,MAAM,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,CAAS,EAAE,CAAS;IAClD,2CAA2C;IAC3C,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACjD,OAAO,CAAC,CAAC,CAAE,kCAAkC;IAC/C,CAAC;IAED,MAAM,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEpC,2DAA2D;IAC3D,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,OAAO;QAAE,OAAO,CAAC,CAAC;IAE1D,+BAA+B;IAC/B,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAE,CAAC;QACpC,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAE,CAAC;QACpC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QAC/C,IAAI,IAAI,GAAG,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC;QACxB,IAAI,IAAI,GAAG,CAAC;YAAE,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,6CAA6C;IAC7C,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAChE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC,CAAC;QACvB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB,EAAE,OAAgB;IACjE,MAAM,cAAc,GAAG,OAAO,IAAI,aAAa,EAAE,CAAC,OAAO,CAAC;IAC1D,OAAO,eAAe,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAoB,EACpB,aAAsB;IAEtB,MAAM,OAAO,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAE/C,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,QAAQ,GAAG,IAAI,CAAC,KAAK,CACnB,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAC5E,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE/E,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,iCAAiC;IACjC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CACX,gBAAgB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,uCAAuC,CAC1E,CAAC;IACJ,CAAC;IAED,iCAAiC;IACjC,IAAI,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/E,QAAQ,CAAC,IAAI,CACX,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO;QACP,SAAS;QACT,QAAQ;QACR,cAAc;QACd,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAG,gBAAgB;QACtD,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC5D,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,qCAAqC;IACvC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB;IAMpC,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;IAChC,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;IAE9B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,UAAU,GAAG,IAAI,CAAC;IAEtB,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;QAC/E,UAAU,GAAG,KAAK,CAAC;IACrB,CAAC;SAAM,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1D,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,UAAU,GAAG,KAAK,CAAC;YACnB,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC/B,QAAQ,CAAC,IAAI,CACX,YAAY,OAAO,CAAC,OAAO,4BAA4B;oBACvD,gHAAgH,IAAI,KAAK;oBACzH,yEAAyE,IAAI,UAAU,CACxF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,YAAY,OAAO,CAAC,OAAO,yBAAyB,IAAI,KAAK;oBAC7D,gDAAgD,CACjD,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CACX,YAAY,OAAO,CAAC,OAAO,yBAAyB,IAAI,KAAK;gBAC7D,0CAA0C,CAC3C,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,IAAI,iBAA4C,CAAC;AAEjD,MAAM,UAAU,cAAc;IAC5B,IAAI,iBAAiB,KAAK,SAAS;QAAE,OAAO,iBAAiB,CAAC;IAE9D,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,sBAAsB,EAAE,CAAC;IACzE,IAAI,UAAU,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxC,iBAAiB,GAAG,IAAI,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YACpC,mBAAmB,OAAO,CAAC,OAAO,wCAAwC,IAAI,GAAG,CAAC;IACtF,CAAC;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB;IACnC,iBAAiB,GAAG,SAAS,CAAC;AAChC,CAAC"}
|
package/docs/superdb-expert.md
CHANGED
|
@@ -6,26 +6,21 @@ last_updated: "2026-01-31"
|
|
|
6
6
|
web: "https://chrismo.github.io/superkit/_build/expert-guide/"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
# SuperDB
|
|
9
|
+
# SuperDB Expert Guide
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
SuperDB is a command-line tool and query engine that puts JSON and relational
|
|
12
|
+
tables on equal footing with a super-structured data model. It uses a
|
|
13
|
+
Unix-inspired pipeline syntax similar to jq but with its own distinct language
|
|
14
|
+
and semantics. This guide covers SuperDB's query syntax, patterns, and best
|
|
15
|
+
practices.
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
## Note on Zed/zq Compatibility
|
|
14
18
|
|
|
15
|
-
SuperDB
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
**DO NOT REFERENCE zed.brimdata.io OR ZQ LANGUAGE DOCUMENTATION!**
|
|
21
|
-
|
|
22
|
-
- Zed and zq are OUTDATED languages that SuperDB is REPLACING
|
|
23
|
-
- SuperDB supports SOME legacy zq syntax but has made BREAKING CHANGES
|
|
24
|
-
- The old Zed language documentation at zed.brimdata.io is INCOMPATIBLE
|
|
25
|
-
- Only use SuperDB documentation at superdb.org and GitHub examples
|
|
26
|
-
- When in doubt, test syntax with actual SuperDB binary, not old examples
|
|
27
|
-
|
|
28
|
-
**ALWAYS use current SuperDB syntax, never assume Zed/zq patterns work!**
|
|
19
|
+
**SuperDB replaces the older Zed/zq toolchain and has breaking changes.**
|
|
20
|
+
The Zed language documentation at zed.brimdata.io is outdated and incompatible
|
|
21
|
+
with current SuperDB syntax. Use SuperDB documentation at superdb.org and
|
|
22
|
+
GitHub examples instead. When in doubt, test syntax with the actual `super`
|
|
23
|
+
binary rather than relying on old Zed/zq examples.
|
|
29
24
|
|
|
30
25
|
## Core Knowledge
|
|
31
26
|
|
|
@@ -42,10 +37,10 @@ JSON and relational tables on equal footing with a super-structured data model.
|
|
|
42
37
|
- `-i` for input format
|
|
43
38
|
- `-f line` for clean number formatting without type decorators
|
|
44
39
|
|
|
45
|
-
####
|
|
40
|
+
#### Removed switches
|
|
46
41
|
|
|
47
|
-
- `-z` for deprecated ZSON name.
|
|
48
|
-
- `-Z` for deprecated ZSON name.
|
|
42
|
+
- `-z` for deprecated ZSON name. **Removed** — no longer accepted.
|
|
43
|
+
- `-Z` for deprecated ZSON name. **Removed** — no longer accepted.
|
|
49
44
|
|
|
50
45
|
### Critical Rules
|
|
51
46
|
|
|
@@ -87,7 +82,7 @@ from source
|
|
|
87
82
|
- Each branch runs in parallel using parentheses syntax
|
|
88
83
|
- Branches can be combined, merged, or joined
|
|
89
84
|
- Without explicit join/merge, an implied "combine" operator forwards values
|
|
90
|
-
- **
|
|
85
|
+
- **Note:** The `=>` fat arrow syntax from the old Zed language is not supported.
|
|
91
86
|
|
|
92
87
|
## PostgreSQL Compatibility & Traditional SQL
|
|
93
88
|
|
|
@@ -728,13 +723,13 @@ If `<expr>` is omitted, it defaults to `true`. Available pragmas:
|
|
|
728
723
|
- **`index_base`** — `0` (default) for zero-based indexing, `1` for one-based indexing
|
|
729
724
|
- **`pg`** — `false` (default, Google SQL semantics) or `true` (PostgreSQL semantics for GROUP BY identifier resolution)
|
|
730
725
|
|
|
731
|
-
## SuperDB Quoting Rules (
|
|
726
|
+
## SuperDB Quoting Rules (Bash Integration)
|
|
732
727
|
|
|
733
|
-
|
|
728
|
+
Follow these quoting rules when calling `super` from bash:
|
|
734
729
|
|
|
735
|
-
-
|
|
736
|
-
-
|
|
737
|
-
-
|
|
730
|
+
- Use double quotes for the `-c` parameter: `super -s -c "..."`
|
|
731
|
+
- Use single quotes inside SuperDB queries: `{type:10, content:'$variable'}`
|
|
732
|
+
- Avoid escaping double quotes inside SuperDB — use single quotes instead
|
|
738
733
|
- This allows bash interpolation while avoiding quote escaping issues
|
|
739
734
|
|
|
740
735
|
**Examples:**
|
|
@@ -10,9 +10,8 @@ web: "https://chrismo.github.io/superkit/_build/upgrade-guide/"
|
|
|
10
10
|
|
|
11
11
|
SuperDB Version 0.2.0
|
|
12
12
|
|
|
13
|
-
This
|
|
14
|
-
|
|
15
|
-
SuperDB release.
|
|
13
|
+
This guide covers all breaking changes between zq and the current SuperDB
|
|
14
|
+
release.
|
|
16
15
|
|
|
17
16
|
## Quick Reference
|
|
18
17
|
|
|
@@ -438,7 +437,7 @@ super -s -c "values 1,2,3 | aggregate cnt:=count() | typeof(cnt)"
|
|
|
438
437
|
<int64>
|
|
439
438
|
```
|
|
440
439
|
|
|
441
|
-
## Formatting Conventions
|
|
440
|
+
## Formatting Conventions
|
|
442
441
|
|
|
443
442
|
When performing upgrades, follow these formatting conventions for consistency:
|
|
444
443
|
|