@tabularis/explain-db2 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,63 @@
-# Temporary Holding Version
+# Db2 Visual EXPLAIN parser
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Turns the payload the Db2 plugin's `explain_query` returns
+(`engine: db2`, `format: db2-explain-tables-json`) into the plan tree
+Tabularis's Visual EXPLAIN draws.
+
+The payload carries the rows Db2's `EXPLAIN PLAN` wrote into its explain
+tables for one statement (`EXPLAIN_OPERATOR`, `EXPLAIN_STREAM`,
+`EXPLAIN_PREDICATE`, `EXPLAIN_ARGUMENT`, plus the tables of the indexes the
+plan reads) and, with Analyze, the row count and elapsed time of the run.
+`src/payload.ts` describes it; the plugin's `src/models.rs` produces it.
+
+## npm usage
+
+```bash
+pnpm add @tabularis/explain @tabularis/explain-db2
+```
+
+Import `@tabularis/explain-db2` to register the parser with
+`@tabularis/explain` (version 0.2.0 or newer), or import `parseDb2Explain`
+directly to parse a payload string.
+
+```ts
+import "@tabularis/explain-db2";
+import { parseRawExplain } from "@tabularis/explain";
+
+const plan = parseRawExplain({
+  engine: "db2",
+  format: "db2-explain-tables-json",
+  payload,
+  original_query: "SELECT * FROM orders",
+});
+```
+
+The release workflow publishes the package using npm Trusted Publishing.
+Configure the trusted publisher on npm for `TabularisDB`, repository
+`tabularis-db2-plugin`, and workflow `release.yml` before the first release.
+
+The parser:
+
+- makes tables and indexes the `relation` of the operator that reads them
+- places predicates where Db2 applies them: index ranges in
+  `index_condition`, filters in `filter`, the condition of a hash join in
+  `hash_condition`
+- reports join types from `OUTERJN`, and lists a join's outer input first
+- keeps every operator argument in `extra`
+- reads the compile time from `PREPTIME`
+
+## Build and test
+
+```bash
+pnpm install --frozen-lockfile
+pnpm typecheck
+pnpm test   # builds dist/index.iife.js, then runs vitest
+```
+
+`dist/index.iife.js` is the bundle `.tabularium` declares under
+`explain_parsers`; the release workflow ships it in every plugin archive.
+
+The fixtures in `tests/fixtures/` are payloads captured from Db2 12.1; the
+plans they produce are committed in `tests/fixtures/expected/`. After an
+intended change, regenerate them with `UPDATE_GOLDENS=1 pnpm test` and review
+the diff.

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import { RegisteredExplainParser, ExplainNode, ExplainPlan } from '@tabularis/explain';
+
+/**
+ * Db2 parser descriptor consumed by both package and plugin loaders. The
+ * engine and format match the plugin's `explain_query` answer and the
+ * `explain_parsers` entry of its `.tabularium`.
+ */
+declare const db2ExplainParser: RegisteredExplainParser;
+
+/**
+ * The payload the Db2 plugin's `explain_query` sends: the rows Db2's
+ * `EXPLAIN` wrote into its explain tables for one statement, one list per
+ * table, with values as Db2 gives them.
+ *
+ * Mirrors `Db2ExplainPayload` in the plugin's `src/models.rs`: change both
+ * together.
+ */
+interface Db2ExplainPayload {
+    /** Version of this shape. Always the first key. */
+    db2_explain: 1;
+    /** The schema the statement was explained in. */
+    schema: string;
+    operators: Db2Operator[];
+    streams: Db2Stream[];
+    predicates: Db2Predicate[];
+    arguments: Db2Argument[];
+    indexes: Db2Index[];
+    /** What running the statement showed, when Analyze was asked for. */
+    analyze: Db2Analyze | null;
+}
+/** One `EXPLAIN_OPERATOR` row. */
+interface Db2Operator {
+    id: number;
+    type: string;
+    total_cost: number | null;
+    io_cost: number | null;
+    cpu_cost: number | null;
+    first_row_cost: number | null;
+    re_total_cost: number | null;
+    buffers: number | null;
+}
+/**
+ * One `EXPLAIN_STREAM` row ending in an operator. `source_type` is `O` for
+ * an operator and `D` for a data object (a table or an index, source id -1).
+ */
+interface Db2Stream {
+    source_type: string;
+    source_id: number;
+    target_id: number;
+    object_schema: string | null;
+    object_name: string | null;
+    /** Estimated number of rows. */
+    count: number | null;
+}
+/** One `EXPLAIN_PREDICATE` row. */
+interface Db2Predicate {
+    operator_id: number;
+    how_applied: string;
+    text: string;
+}
+/** One `EXPLAIN_ARGUMENT` row. */
+interface Db2Argument {
+    operator_id: number;
+    type: string;
+    value: string;
+}
+/** An index the plan reads, with its table. */
+interface Db2Index {
+    schema: string;
+    name: string;
+    table_schema: string;
+    table_name: string;
+}
+interface Db2Analyze {
+    /** Rows the statement returned, or changed when it returns none. */
+    rows: number;
+    elapsed_ms: number;
+}
+/** Whether `payload` starts like a Db2 payload. */
+declare function looksLikeDb2Payload(payload: string): boolean;
+/** Reads a payload, refusing anything that is not one this parser knows. */
+declare function readPayload(payload: string): Db2ExplainPayload;
+
+/**
+ * Builds the plan tree Tabularis draws from the explain-table rows.
+ *
+ * `EXPLAIN_OPERATOR` lists the operators (`RETURN`, `TBSCAN`, `HSJOIN`...),
+ * `EXPLAIN_STREAM` the rows flowing between them and from tables and
+ * indexes into them, `EXPLAIN_PREDICATE` where each predicate is applied
+ * and `EXPLAIN_ARGUMENT` the settings of each operator.
+ */
+
+/** Reads `PREPTIME` ("46 milliseconds"), the time Db2 took to compile. */
+declare function planningTimeMs(payload: Db2ExplainPayload): number | null;
+/**
+ * The plan tree, rooted at the operator that passes its rows to no other
+ * one (`RETURN` for a query). `null` when there is no such operator.
+ */
+declare function buildPlanTree(payload: Db2ExplainPayload): ExplainNode | null;
+/** The plan as indented text, one operator per line, for the raw view. */
+declare function planText(root: ExplainNode): string;
+/**
+ * Parses the Db2 plugin's payload into a plan. With Analyze, the statement
+ * ran: the top operator carries its real row count and elapsed time, and
+ * the operators below keep their estimates.
+ */
+declare function parseDb2Explain(rawPayload: string): ExplainPlan;
+
+export { buildPlanTree, db2ExplainParser, looksLikeDb2Payload, parseDb2Explain, planText, planningTimeMs, readPayload };
+export type { Db2Analyze, Db2Argument, Db2ExplainPayload, Db2Index, Db2Operator, Db2Predicate, Db2Stream };

package/dist/index.iife.js

@@ -0,0 +1,261 @@
+var __tabularis_explain_parser__ = (function () {
+  'use strict';
+
+  // src/payload.ts
+  function looksLikeDb2Payload(payload) {
+    return /^\s*\{\s*"db2_explain"\s*:/.test(payload.slice(0, 64));
+  }
+  function readPayload(payload) {
+    let value;
+    try {
+      value = JSON.parse(payload);
+    } catch (error) {
+      throw new Error(`Db2 EXPLAIN payload is not JSON: ${error.message}`);
+    }
+    if (typeof value !== "object" || value === null) {
+      throw new Error("Db2 EXPLAIN payload is not an object");
+    }
+    const version = value.db2_explain;
+    if (version !== 1) {
+      throw new Error(
+        `Db2 EXPLAIN payload version ${String(version)} is not supported by this parser`
+      );
+    }
+    const parsed = value;
+    for (const key of ["operators", "streams", "predicates", "arguments", "indexes"]) {
+      if (!Array.isArray(parsed[key])) {
+        throw new Error(`Db2 EXPLAIN payload has no '${key}' list`);
+      }
+    }
+    return parsed;
+  }
+
+  // src/plan.ts
+  function objectLabel(schema, name, currentSchema) {
+    return schema === currentSchema ? name : `${schema}.${name}`;
+  }
+  function joinPredicates(texts) {
+    const unique = [...new Set(texts)];
+    return unique.length > 0 ? unique.join(" AND ") : null;
+  }
+  function joinType(operatorType, args) {
+    if (!operatorType.endsWith("JOIN")) {
+      return null;
+    }
+    const outerJoin = args.get("OUTERJN")?.[0]?.trim().toUpperCase() ?? "";
+    switch (outerJoin) {
+      case "":
+        return "Inner";
+      case "LEFT":
+        return "Left";
+      case "RIGHT":
+        return "Right";
+      case "FULL":
+        return "Full";
+      default:
+        return outerJoin;
+    }
+  }
+  function planningTimeMs(payload) {
+    const prepTime = payload.arguments.find((argument) => argument.type === "PREPTIME");
+    if (!prepTime) {
+      return null;
+    }
+    const [amount, unit = ""] = prepTime.value.trim().split(/\s+/);
+    const value = Number(amount);
+    if (!Number.isFinite(value)) {
+      return null;
+    }
+    if (unit.startsWith("milli")) return value;
+    if (unit.startsWith("micro")) return value / 1e3;
+    if (unit.startsWith("second")) return value * 1e3;
+    return null;
+  }
+  var PLACED_PREDICATES = /* @__PURE__ */ new Set(["START", "STOP", "SARG", "RESID", "JOIN"]);
+  function operatorNode(operator, payload) {
+    const id = operator.id;
+    const node = {
+      id: String(id),
+      node_type: operator.type.trim(),
+      relation: null,
+      startup_cost: operator.first_row_cost,
+      total_cost: operator.total_cost,
+      plan_rows: null,
+      actual_rows: null,
+      actual_time_ms: null,
+      actual_loops: null,
+      buffers_hit: null,
+      buffers_read: null,
+      filter: null,
+      index_condition: null,
+      join_type: null,
+      hash_condition: null,
+      extra: {},
+      children: []
+    };
+    const args = /* @__PURE__ */ new Map();
+    for (const argument of payload.arguments.filter((a) => a.operator_id === id)) {
+      const key = argument.type.trim();
+      args.set(key, [...args.get(key) ?? [], argument.value.trim()]);
+    }
+    const current = payload.schema;
+    for (const stream of payload.streams) {
+      if (stream.target_id !== id || stream.source_type !== "D") {
+        continue;
+      }
+      const schema = stream.object_schema ?? "";
+      const name = stream.object_name ?? "";
+      const index = payload.indexes.find(
+        (candidate) => candidate.schema === schema && candidate.name === name
+      );
+      if (index) {
+        node.relation = objectLabel(index.table_schema, index.table_name, current);
+        node.extra.index = objectLabel(schema, name, current);
+      } else {
+        node.relation = objectLabel(schema, name, current);
+        if (node.node_type === "TBSCAN") {
+          node.extra.access_type = "ALL";
+        }
+      }
+    }
+    const output = payload.streams.find(
+      (stream) => stream.source_type === "O" && stream.source_id === id
+    );
+    if (output && output.count !== null) {
+      node.plan_rows = output.count;
+    } else {
+      const inputs = payload.streams.filter((stream) => stream.target_id === id && stream.source_type === "O").map((stream) => stream.count).filter((count) => count !== null);
+      node.plan_rows = inputs.length > 0 ? Math.max(...inputs) : null;
+    }
+    const predicates = payload.predicates.filter((predicate) => predicate.operator_id === id);
+    const applied = (...kinds) => joinPredicates(
+      predicates.filter((predicate) => kinds.includes(predicate.how_applied.trim())).map((predicate) => predicate.text.trim())
+    );
+    node.index_condition = applied("START", "STOP");
+    node.filter = applied("SARG", "RESID");
+    const joinCondition = applied("JOIN");
+    if (node.node_type === "HSJOIN") {
+      node.hash_condition = joinCondition;
+    } else if (joinCondition !== null) {
+      node.extra.join_condition = joinCondition;
+    }
+    for (const predicate of predicates) {
+      const how = predicate.how_applied.trim();
+      if (!PLACED_PREDICATES.has(how)) {
+        node.extra[`${how.toLowerCase()} predicate`] = predicate.text.trim();
+      }
+    }
+    node.join_type = joinType(node.node_type, args);
+    const costs = [
+      ["io_cost", operator.io_cost],
+      ["cpu_cost", operator.cpu_cost],
+      ["re_total_cost", operator.re_total_cost],
+      ["buffers", operator.buffers]
+    ];
+    for (const [key, value] of costs) {
+      if (value !== null) {
+        node.extra[key] = value;
+      }
+    }
+    for (const [key, values] of [...args.entries()].sort(([a], [b]) => a.localeCompare(b))) {
+      node.extra[key] = values.join(", ");
+    }
+    return node;
+  }
+  function inputOrder(args, source) {
+    const side = args.find(
+      (argument) => argument.operator_id === source && argument.type.trim() === "JN INPUT"
+    )?.value.trim();
+    return [side === "OUTER" ? 0 : side === "INNER" ? 1 : 2, source];
+  }
+  function buildNode(operator, payload, byId, path) {
+    const node = operatorNode(operator, payload);
+    const inputs = [
+      ...new Set(
+        payload.streams.filter((stream) => stream.target_id === operator.id && stream.source_type === "O").map((stream) => stream.source_id)
+      )
+    ].sort((a, b) => {
+      const [sideA, idA] = inputOrder(payload.arguments, a);
+      const [sideB, idB] = inputOrder(payload.arguments, b);
+      return sideA - sideB || idA - idB;
+    });
+    for (const source of inputs) {
+      const input = byId.get(source);
+      if (input && !path.includes(source)) {
+        node.children.push(buildNode(input, payload, byId, [...path, operator.id]));
+      }
+    }
+    return node;
+  }
+  function buildPlanTree(payload) {
+    const byId = new Map(payload.operators.map((operator) => [operator.id, operator]));
+    const hasConsumer = (id) => payload.streams.some(
+      (stream) => stream.source_type === "O" && stream.source_id === id && byId.has(stream.target_id)
+    );
+    const root = payload.operators.filter((operator) => !hasConsumer(operator.id)).sort((a, b) => a.id - b.id)[0];
+    return root ? buildNode(root, payload, byId, []) : null;
+  }
+  function planText(root) {
+    const lines = [];
+    const write = (node, depth) => {
+      const indent = "  ".repeat(depth);
+      let line = `${indent}${node.id} ${node.node_type}`;
+      if (node.relation !== null) line += ` on ${node.relation}`;
+      if (typeof node.extra.index === "string") line += ` using ${node.extra.index}`;
+      if (node.total_cost !== null) {
+        line += ` (cost=${node.total_cost.toFixed(2)}`;
+        if (node.plan_rows !== null) line += ` rows=${Math.round(node.plan_rows)}`;
+        line += ")";
+      }
+      lines.push(line);
+      const details = [
+        ["Join", node.hash_condition],
+        ["Index", node.index_condition],
+        ["Filter", node.filter]
+      ];
+      for (const [label, value] of details) {
+        if (value !== null) lines.push(`${indent}  ${label}: ${value}`);
+      }
+      for (const child of node.children) write(child, depth + 1);
+    };
+    write(root, 0);
+    return `${lines.join("\n")}
+`;
+  }
+  function parseDb2Explain(rawPayload) {
+    const payload = readPayload(rawPayload);
+    const root = buildPlanTree(payload);
+    if (root === null) {
+      throw new Error("Db2 EXPLAIN payload has no operator to start the plan from");
+    }
+    if (payload.analyze) {
+      root.actual_rows = payload.analyze.rows;
+      root.actual_time_ms = payload.analyze.elapsed_ms;
+      root.actual_loops = 1;
+    }
+    return {
+      root,
+      planning_time_ms: planningTimeMs(payload),
+      execution_time_ms: payload.analyze?.elapsed_ms ?? null,
+      original_query: "",
+      driver: "db2",
+      has_analyze_data: payload.analyze !== null,
+      raw_output: planText(root)
+    };
+  }
+
+  // src/parser.ts
+  var db2ExplainParser = {
+    engine: "db2",
+    format: "db2-explain-tables-json",
+    label: "Db2 explain tables",
+    parse: parseDb2Explain,
+    sniff: looksLikeDb2Payload
+  };
+
+  // src/iife.ts
+  var iife_default = db2ExplainParser;
+
+  return iife_default;
+
+})();

package/dist/index.js

@@ -0,0 +1,260 @@
+import { registerExplainParser } from '@tabularis/explain';
+
+// src/index.ts
+
+// src/payload.ts
+function looksLikeDb2Payload(payload) {
+  return /^\s*\{\s*"db2_explain"\s*:/.test(payload.slice(0, 64));
+}
+function readPayload(payload) {
+  let value;
+  try {
+    value = JSON.parse(payload);
+  } catch (error) {
+    throw new Error(`Db2 EXPLAIN payload is not JSON: ${error.message}`);
+  }
+  if (typeof value !== "object" || value === null) {
+    throw new Error("Db2 EXPLAIN payload is not an object");
+  }
+  const version = value.db2_explain;
+  if (version !== 1) {
+    throw new Error(
+      `Db2 EXPLAIN payload version ${String(version)} is not supported by this parser`
+    );
+  }
+  const parsed = value;
+  for (const key of ["operators", "streams", "predicates", "arguments", "indexes"]) {
+    if (!Array.isArray(parsed[key])) {
+      throw new Error(`Db2 EXPLAIN payload has no '${key}' list`);
+    }
+  }
+  return parsed;
+}
+
+// src/plan.ts
+function objectLabel(schema, name, currentSchema) {
+  return schema === currentSchema ? name : `${schema}.${name}`;
+}
+function joinPredicates(texts) {
+  const unique = [...new Set(texts)];
+  return unique.length > 0 ? unique.join(" AND ") : null;
+}
+function joinType(operatorType, args) {
+  if (!operatorType.endsWith("JOIN")) {
+    return null;
+  }
+  const outerJoin = args.get("OUTERJN")?.[0]?.trim().toUpperCase() ?? "";
+  switch (outerJoin) {
+    case "":
+      return "Inner";
+    case "LEFT":
+      return "Left";
+    case "RIGHT":
+      return "Right";
+    case "FULL":
+      return "Full";
+    default:
+      return outerJoin;
+  }
+}
+function planningTimeMs(payload) {
+  const prepTime = payload.arguments.find((argument) => argument.type === "PREPTIME");
+  if (!prepTime) {
+    return null;
+  }
+  const [amount, unit = ""] = prepTime.value.trim().split(/\s+/);
+  const value = Number(amount);
+  if (!Number.isFinite(value)) {
+    return null;
+  }
+  if (unit.startsWith("milli")) return value;
+  if (unit.startsWith("micro")) return value / 1e3;
+  if (unit.startsWith("second")) return value * 1e3;
+  return null;
+}
+var PLACED_PREDICATES = /* @__PURE__ */ new Set(["START", "STOP", "SARG", "RESID", "JOIN"]);
+function operatorNode(operator, payload) {
+  const id = operator.id;
+  const node = {
+    id: String(id),
+    node_type: operator.type.trim(),
+    relation: null,
+    startup_cost: operator.first_row_cost,
+    total_cost: operator.total_cost,
+    plan_rows: null,
+    actual_rows: null,
+    actual_time_ms: null,
+    actual_loops: null,
+    buffers_hit: null,
+    buffers_read: null,
+    filter: null,
+    index_condition: null,
+    join_type: null,
+    hash_condition: null,
+    extra: {},
+    children: []
+  };
+  const args = /* @__PURE__ */ new Map();
+  for (const argument of payload.arguments.filter((a) => a.operator_id === id)) {
+    const key = argument.type.trim();
+    args.set(key, [...args.get(key) ?? [], argument.value.trim()]);
+  }
+  const current = payload.schema;
+  for (const stream of payload.streams) {
+    if (stream.target_id !== id || stream.source_type !== "D") {
+      continue;
+    }
+    const schema = stream.object_schema ?? "";
+    const name = stream.object_name ?? "";
+    const index = payload.indexes.find(
+      (candidate) => candidate.schema === schema && candidate.name === name
+    );
+    if (index) {
+      node.relation = objectLabel(index.table_schema, index.table_name, current);
+      node.extra.index = objectLabel(schema, name, current);
+    } else {
+      node.relation = objectLabel(schema, name, current);
+      if (node.node_type === "TBSCAN") {
+        node.extra.access_type = "ALL";
+      }
+    }
+  }
+  const output = payload.streams.find(
+    (stream) => stream.source_type === "O" && stream.source_id === id
+  );
+  if (output && output.count !== null) {
+    node.plan_rows = output.count;
+  } else {
+    const inputs = payload.streams.filter((stream) => stream.target_id === id && stream.source_type === "O").map((stream) => stream.count).filter((count) => count !== null);
+    node.plan_rows = inputs.length > 0 ? Math.max(...inputs) : null;
+  }
+  const predicates = payload.predicates.filter((predicate) => predicate.operator_id === id);
+  const applied = (...kinds) => joinPredicates(
+    predicates.filter((predicate) => kinds.includes(predicate.how_applied.trim())).map((predicate) => predicate.text.trim())
+  );
+  node.index_condition = applied("START", "STOP");
+  node.filter = applied("SARG", "RESID");
+  const joinCondition = applied("JOIN");
+  if (node.node_type === "HSJOIN") {
+    node.hash_condition = joinCondition;
+  } else if (joinCondition !== null) {
+    node.extra.join_condition = joinCondition;
+  }
+  for (const predicate of predicates) {
+    const how = predicate.how_applied.trim();
+    if (!PLACED_PREDICATES.has(how)) {
+      node.extra[`${how.toLowerCase()} predicate`] = predicate.text.trim();
+    }
+  }
+  node.join_type = joinType(node.node_type, args);
+  const costs = [
+    ["io_cost", operator.io_cost],
+    ["cpu_cost", operator.cpu_cost],
+    ["re_total_cost", operator.re_total_cost],
+    ["buffers", operator.buffers]
+  ];
+  for (const [key, value] of costs) {
+    if (value !== null) {
+      node.extra[key] = value;
+    }
+  }
+  for (const [key, values] of [...args.entries()].sort(([a], [b]) => a.localeCompare(b))) {
+    node.extra[key] = values.join(", ");
+  }
+  return node;
+}
+function inputOrder(args, source) {
+  const side = args.find(
+    (argument) => argument.operator_id === source && argument.type.trim() === "JN INPUT"
+  )?.value.trim();
+  return [side === "OUTER" ? 0 : side === "INNER" ? 1 : 2, source];
+}
+function buildNode(operator, payload, byId, path) {
+  const node = operatorNode(operator, payload);
+  const inputs = [
+    ...new Set(
+      payload.streams.filter((stream) => stream.target_id === operator.id && stream.source_type === "O").map((stream) => stream.source_id)
+    )
+  ].sort((a, b) => {
+    const [sideA, idA] = inputOrder(payload.arguments, a);
+    const [sideB, idB] = inputOrder(payload.arguments, b);
+    return sideA - sideB || idA - idB;
+  });
+  for (const source of inputs) {
+    const input = byId.get(source);
+    if (input && !path.includes(source)) {
+      node.children.push(buildNode(input, payload, byId, [...path, operator.id]));
+    }
+  }
+  return node;
+}
+function buildPlanTree(payload) {
+  const byId = new Map(payload.operators.map((operator) => [operator.id, operator]));
+  const hasConsumer = (id) => payload.streams.some(
+    (stream) => stream.source_type === "O" && stream.source_id === id && byId.has(stream.target_id)
+  );
+  const root = payload.operators.filter((operator) => !hasConsumer(operator.id)).sort((a, b) => a.id - b.id)[0];
+  return root ? buildNode(root, payload, byId, []) : null;
+}
+function planText(root) {
+  const lines = [];
+  const write = (node, depth) => {
+    const indent = "  ".repeat(depth);
+    let line = `${indent}${node.id} ${node.node_type}`;
+    if (node.relation !== null) line += ` on ${node.relation}`;
+    if (typeof node.extra.index === "string") line += ` using ${node.extra.index}`;
+    if (node.total_cost !== null) {
+      line += ` (cost=${node.total_cost.toFixed(2)}`;
+      if (node.plan_rows !== null) line += ` rows=${Math.round(node.plan_rows)}`;
+      line += ")";
+    }
+    lines.push(line);
+    const details = [
+      ["Join", node.hash_condition],
+      ["Index", node.index_condition],
+      ["Filter", node.filter]
+    ];
+    for (const [label, value] of details) {
+      if (value !== null) lines.push(`${indent}  ${label}: ${value}`);
+    }
+    for (const child of node.children) write(child, depth + 1);
+  };
+  write(root, 0);
+  return `${lines.join("\n")}
+`;
+}
+function parseDb2Explain(rawPayload) {
+  const payload = readPayload(rawPayload);
+  const root = buildPlanTree(payload);
+  if (root === null) {
+    throw new Error("Db2 EXPLAIN payload has no operator to start the plan from");
+  }
+  if (payload.analyze) {
+    root.actual_rows = payload.analyze.rows;
+    root.actual_time_ms = payload.analyze.elapsed_ms;
+    root.actual_loops = 1;
+  }
+  return {
+    root,
+    planning_time_ms: planningTimeMs(payload),
+    execution_time_ms: payload.analyze?.elapsed_ms ?? null,
+    original_query: "",
+    driver: "db2",
+    has_analyze_data: payload.analyze !== null,
+    raw_output: planText(root)
+  };
+}
+
+// src/parser.ts
+var db2ExplainParser = {
+  engine: "db2",
+  format: "db2-explain-tables-json",
+  label: "Db2 explain tables",
+  parse: parseDb2Explain,
+  sniff: looksLikeDb2Payload
+};
+
+// src/index.ts
+registerExplainParser(db2ExplainParser);
+
+export { buildPlanTree, db2ExplainParser, parseDb2Explain, planText, planningTimeMs };

package/package.json

@@ -1,6 +1,50 @@
 {
   "name": "@tabularis/explain-db2",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "IBM Db2 explain-table parser for Tabularis Visual EXPLAIN",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/TabularisDB/tabularis-db2-plugin/tree/master/explain",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TabularisDB/tabularis-db2-plugin.git",
+    "directory": "explain"
+  },
+  "type": "module",
+  "sideEffects": [
+    "./dist/index.js"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "pnpm run build && vitest run"
+  },
+  "peerDependencies": {
+    "@tabularis/explain": "^0.2.0"
+  },
+  "devDependencies": {
+    "@tabularis/explain": "file:tests/host",
+    "@types/node": "^26.4.0",
+    "tsup": "^9.0.0",
+    "typescript": "~5.9.3",
+    "vitest": "^5.0.5"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "packageManager": "pnpm@11.23.0"
+}