@tabularis/explain 0.3.0 → 0.3.1

package/dist/index.js

@@ -726,7 +726,10 @@ function parsePostgresText(raw) {
   let planningTime = null;
   let executionTime = null;
   let hasAnalyzeData = false;
+  let hasBuffers = false;
   const ids = new NodeIdAllocator();
+  let rootIndent = null;
+  let inTrailer = false;
   const stack = [];
   let root = null;
   const promoteOrAttach = (node) => {
@@ -768,12 +771,16 @@ function parsePostgresText(raw) {
       if (node.actual_rows !== null || node.actual_time_ms !== null) {
         hasAnalyzeData = true;
       }
+      rootIndent ??= indent;
+      inTrailer = false;
       popUntilShallower(indent);
       stack.push({ indent, node });
     } else {
+      if (rootIndent !== null && indent <= rootIndent) inTrailer = true;
+      if (inTrailer) continue;
       const top = stack[stack.length - 1];
-      if (top !== void 0) {
-        applyTextAttribute(top.node, trimmed);
+      if (top !== void 0 && applyTextAttribute(top.node, trimmed)) {
+        hasBuffers = true;
       }
     }
   }
@@ -781,6 +788,7 @@ function parsePostgresText(raw) {
   if (root === null) {
     throw new Error("No plan nodes found in EXPLAIN text output");
   }
+  if (hasBuffers) fillMissingBuffers(root);
   return {
     root,
     planning_time_ms: planningTime,
@@ -884,7 +892,7 @@ function parseCostFields(inner) {
 function parseActualFields(inner) {
   const trimmed = inner.trim();
   if (trimmed.toLowerCase() === "never executed") {
-    return [null, null, null];
+    return [0, 0, 0];
   }
   const rest = trimmed.startsWith("actual ") ? trimmed.slice(7) : trimmed;
   let totalTime = null;
@@ -911,6 +919,10 @@ function parseFiniteNumber(text) {
   return Number.isFinite(value) ? value : null;
 }
 function applyTextAttribute(node, content) {
+  if (content.startsWith("Buffers:")) {
+    applyBuffers(node, content.slice("Buffers:".length));
+    return true;
+  }
   if (content.startsWith("Filter:")) {
     node.filter = content.slice("Filter:".length).trim();
   } else if (content.startsWith("Index Cond:")) {
@@ -925,6 +937,32 @@ function applyTextAttribute(node, content) {
       node.extra[content.slice(0, sep).trim()] = content.slice(sep + 1).trim();
     }
   }
+  return false;
+}
+function applyBuffers(node, content) {
+  node.buffers_hit = 0;
+  node.buffers_read = 0;
+  for (const group of content.split(",")) {
+    const [scope, ...counters] = group.trim().split(/\s+/);
+    if (scope === void 0 || scope === "") continue;
+    const scopeLabel = scope.charAt(0).toUpperCase() + scope.slice(1).toLowerCase();
+    for (const counter of counters) {
+      const eq = counter.indexOf("=");
+      if (eq === -1) continue;
+      const name = counter.slice(0, eq).toLowerCase();
+      const value = parseFiniteNumber(counter.slice(eq + 1));
+      if (value === null) continue;
+      if (scopeLabel === "Shared" && name === "hit") node.buffers_hit = value;
+      else if (scopeLabel === "Shared" && name === "read") node.buffers_read = value;
+      else
+        node.extra[`${scopeLabel} ${name.charAt(0).toUpperCase()}${name.slice(1)} Blocks`] = value;
+    }
+  }
+}
+function fillMissingBuffers(node) {
+  node.buffers_hit ??= 0;
+  node.buffers_read ??= 0;
+  for (const child of node.children) fillMissingBuffers(child);
 }
 
 // src/parsers/sqlite.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tabularis/explain",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Parse, analyse and visualise a database EXPLAIN plan. Takes raw EXPLAIN output; never runs a query.",
   "license": "Apache-2.0",
   "homepage": "https://github.com/TabularisDB/tabularis/tree/main/packages/explain",