neonctl 2.27.1 → 2.29.0

package/dist/psql/command/cmd_show.js

@@ -35,7 +35,7 @@
  * the line and trim, so `\sf  myschema.foo  ` round-trips cleanly without
  * splitting on the dot or whitespace inside parens.
  */
-import { writeErr, writeOut } from './shared.js';
+import { writeErr, writeOut } from "./shared.js";
 // ---------------------------------------------------------------------------
 // Helpers
 // ---------------------------------------------------------------------------
@@ -48,7 +48,7 @@ import { writeErr, writeOut } from './shared.js';
 const errResult = (ctx, message) => {
     ctx.settings.lastErrorResult = { message };
     writeErr(`\\${ctx.cmdName}: ${message}\n`);
-    return { status: 'error', errorWritten: true };
+    return { status: "error", errorWritten: true };
 };
 /**
  * Format a server error for stderr the way upstream's
@@ -57,10 +57,11 @@ const errResult = (ctx, message) => {
  * message fields (e.g. a wire-layer rejection).
  */
 const formatServerError = (err) => {
-    if (err && typeof err === 'object') {
+    if (err && typeof err === "object") {
         const e = err;
-        const sev = e.severity ?? 'ERROR';
-        const msg = e.message ?? (err instanceof Error ? err.message : safeToString(err));
+        const sev = e.severity ?? "ERROR";
+        const msg = e.message ??
+            (err instanceof Error ? err.message : safeToString(err));
         return `${sev}:  ${msg}`;
     }
     if (err instanceof Error)
@@ -75,14 +76,14 @@ const formatServerError = (err) => {
  */
 const safeToString = (v) => {
     if (v === null)
-        return 'null';
+        return "null";
     if (v === undefined)
-        return 'undefined';
-    if (typeof v === 'string')
+        return "undefined";
+    if (typeof v === "string")
         return v;
-    if (typeof v === 'number' ||
-        typeof v === 'boolean' ||
-        typeof v === 'bigint') {
+    if (typeof v === "number" ||
+        typeof v === "boolean" ||
+        typeof v === "bigint") {
         return String(v);
     }
     try {
@@ -101,17 +102,19 @@ const safeToString = (v) => {
 const queryErrResult = (ctx, err) => {
     const line = formatServerError(err);
     ctx.settings.lastErrorResult = {
-        message: err && typeof err === 'object' && err.message
+        message: err &&
+            typeof err === "object" &&
+            err.message
             ? err.message
             : err instanceof Error
                 ? err.message
                 : safeToString(err),
     };
     writeErr(`${line}\n`);
-    return { status: 'error', errorWritten: true };
+    return { status: "error", errorWritten: true };
 };
 const conn = (ctx) => ctx.settings.db;
-const noConn = (ctx) => errResult(ctx, 'no connection to the server');
+const noConn = (ctx) => errResult(ctx, "no connection to the server");
 /**
  * Read the object descriptor as a whole-line argument with surrounding
  * whitespace AND trailing semicolons stripped. Returns `null` when no
@@ -129,7 +132,7 @@ const readObjDesc = (ctx) => {
     const raw = ctx.restOfLine();
     // Strip trailing whitespace and `;` (in any order, any count) so
     // `\sf foo(arg) ;; ` round-trips like vanilla psql.
-    const trimmed = raw.replace(/[\s;]+$/, '').trimStart();
+    const trimmed = raw.replace(/[\s;]+$/, "").trimStart();
     return trimmed.length === 0 ? null : trimmed;
 };
 /**
@@ -139,7 +142,7 @@ const readObjDesc = (ctx) => {
  */
 const decodeShowSuffix = (cmdName, base) => {
     const tail = cmdName.slice(base.length);
-    return { plus: tail.includes('+') };
+    return { plus: tail.includes("+") };
 };
 /**
  * Look up a function OID from `desc`. Mirrors upstream's
@@ -154,12 +157,15 @@ const decodeShowSuffix = (cmdName, base) => {
  * `escapeLiteral` to mirror libpq's `appendStringLiteralConn`.
  */
 const lookupFunctionOid = async (c, desc) => {
-    const cast = desc.includes('(') ? 'regprocedure' : 'regproc';
+    const cast = desc.includes("(") ? "regprocedure" : "regproc";
     const sql = `SELECT ${c.escapeLiteral(desc)}::pg_catalog.${cast}::pg_catalog.oid`;
     try {
         const rs = await c.query(sql, []);
         if (rs.rows.length !== 1 || rs.rows[0][0] === null) {
-            return { ok: false, err: new Error('object lookup returned no rows') };
+            return {
+                ok: false,
+                err: new Error("object lookup returned no rows"),
+            };
         }
         const raw = cellToString(rs.rows[0][0]);
         const oid = Number(raw);
@@ -186,7 +192,10 @@ const lookupRelationOid = async (c, desc) => {
     try {
         const rs = await c.query(sql, []);
         if (rs.rows.length !== 1 || rs.rows[0][0] === null) {
-            return { ok: false, err: new Error('object lookup returned no rows') };
+            return {
+                ok: false,
+                err: new Error("object lookup returned no rows"),
+            };
         }
         const raw = cellToString(rs.rows[0][0]);
         const oid = Number(raw);
@@ -209,24 +218,24 @@ const lookupRelationOid = async (c, desc) => {
  */
 const cellToString = (v) => {
     if (v === null || v === undefined)
-        return '';
-    if (typeof v === 'string')
+        return "";
+    if (typeof v === "string")
         return v;
     if (Buffer.isBuffer(v))
-        return v.toString('utf-8');
-    if (typeof v === 'number' ||
-        typeof v === 'boolean' ||
-        typeof v === 'bigint') {
+        return v.toString("utf-8");
+    if (typeof v === "number" ||
+        typeof v === "boolean" ||
+        typeof v === "bigint") {
         return String(v);
     }
     // Non-primitive fallback: encode JSON so we never emit a stray
     // `[object Object]`. The wire layer hands us strings or nulls in
     // practice, so this branch is defensive only.
     try {
-        return JSON.stringify(v) ?? '';
+        return JSON.stringify(v) ?? "";
     }
     catch {
-        return '';
+        return "";
     }
 };
 /**
@@ -240,11 +249,14 @@ const getFunctionCreateCmd = async (c, oid) => {
     try {
         const rs = await c.query(sql, []);
         if (rs.rows.length !== 1) {
-            return { ok: false, err: new Error('function definition not found') };
+            return {
+                ok: false,
+                err: new Error("function definition not found"),
+            };
         }
         let def = cellToString(rs.rows[0][0]);
-        if (def.length > 0 && !def.endsWith('\n'))
-            def += '\n';
+        if (def.length > 0 && !def.endsWith("\n"))
+            def += "\n";
         return { ok: true, def };
     }
     catch (err) {
@@ -274,83 +286,83 @@ const fmtId = (ident) => {
  * double-quote pair, which is still valid SQL.
  */
 const RESERVED_WORDS = new Set([
-    'all',
-    'analyse',
-    'analyze',
-    'and',
-    'any',
-    'array',
-    'as',
-    'asc',
-    'asymmetric',
-    'both',
-    'case',
-    'cast',
-    'check',
-    'collate',
-    'column',
-    'constraint',
-    'create',
-    'current_catalog',
-    'current_date',
-    'current_role',
-    'current_time',
-    'current_timestamp',
-    'current_user',
-    'default',
-    'deferrable',
-    'desc',
-    'distinct',
-    'do',
-    'else',
-    'end',
-    'except',
-    'false',
-    'fetch',
-    'for',
-    'foreign',
-    'from',
-    'grant',
-    'group',
-    'having',
-    'in',
-    'initially',
-    'intersect',
-    'into',
-    'lateral',
-    'leading',
-    'limit',
-    'localtime',
-    'localtimestamp',
-    'not',
-    'null',
-    'offset',
-    'on',
-    'only',
-    'or',
-    'order',
-    'placing',
-    'primary',
-    'references',
-    'returning',
-    'select',
-    'session_user',
-    'some',
-    'symmetric',
-    'table',
-    'then',
-    'to',
-    'trailing',
-    'true',
-    'union',
-    'unique',
-    'user',
-    'using',
-    'variadic',
-    'when',
-    'where',
-    'window',
-    'with',
+    "all",
+    "analyse",
+    "analyze",
+    "and",
+    "any",
+    "array",
+    "as",
+    "asc",
+    "asymmetric",
+    "both",
+    "case",
+    "cast",
+    "check",
+    "collate",
+    "column",
+    "constraint",
+    "create",
+    "current_catalog",
+    "current_date",
+    "current_role",
+    "current_time",
+    "current_timestamp",
+    "current_user",
+    "default",
+    "deferrable",
+    "desc",
+    "distinct",
+    "do",
+    "else",
+    "end",
+    "except",
+    "false",
+    "fetch",
+    "for",
+    "foreign",
+    "from",
+    "grant",
+    "group",
+    "having",
+    "in",
+    "initially",
+    "intersect",
+    "into",
+    "lateral",
+    "leading",
+    "limit",
+    "localtime",
+    "localtimestamp",
+    "not",
+    "null",
+    "offset",
+    "on",
+    "only",
+    "or",
+    "order",
+    "placing",
+    "primary",
+    "references",
+    "returning",
+    "select",
+    "session_user",
+    "some",
+    "symmetric",
+    "table",
+    "then",
+    "to",
+    "trailing",
+    "true",
+    "union",
+    "unique",
+    "user",
+    "using",
+    "variadic",
+    "when",
+    "where",
+    "window",
+    "with",
 ]);
 /**
  * Re-build a `CREATE OR REPLACE VIEW <schema>.<name>[ WITH (opts)] AS
@@ -360,8 +372,8 @@ const RESERVED_WORDS = new Set([
  * actually a view.
  */
 const getViewCreateCmd = async (c, oid) => {
-    const ver = c.serverVersion >= 90400 ? 'modern' : 'legacy';
-    const sql = ver === 'modern'
+    const ver = c.serverVersion >= 90400 ? "modern" : "legacy";
+    const sql = ver === "modern"
         ? `SELECT nspname, relname, relkind, ` +
             `pg_catalog.pg_get_viewdef(c.oid, true), ` +
             `pg_catalog.array_remove(pg_catalog.array_remove(c.reloptions,'check_option=local'),'check_option=cascaded') AS reloptions, ` +
@@ -385,7 +397,7 @@ const getViewCreateCmd = async (c, oid) => {
         return { ok: false, err };
     }
     if (rs.rows.length !== 1) {
-        return { ok: false, err: new Error('view definition not found') };
+        return { ok: false, err: new Error("view definition not found") };
     }
     const row = rs.rows[0];
     const nspname = cellToString(row[0]);
@@ -394,33 +406,33 @@ const getViewCreateCmd = async (c, oid) => {
     const viewdef = cellToString(row[3]);
     const reloptions = row[4]; // may be string ("{a=b,c=d}") or null
     const checkoption = cellToString(row[5]);
-    if (relkind !== 'v') {
+    if (relkind !== "v") {
         return {
             ok: false,
             err: new Error(`"${nspname}.${relname}" is not a view`),
         };
     }
-    let out = 'CREATE OR REPLACE VIEW ';
+    let out = "CREATE OR REPLACE VIEW ";
     out += `${fmtId(nspname)}.${fmtId(relname)}`;
     // reloptions: postgres returns it as a text-mode array literal like
     // `{foo=bar,baz=qux}`; we only need to detect non-empty (different
     // from the literal `{}`) and split entries on `,` outside quotes.
     const reloptStr = reloptions === null ? null : cellToString(reloptions);
     if (reloptStr !== null && reloptStr.length > 2) {
-        out += '\n WITH (';
+        out += "\n WITH (";
         out += renderReloptions(reloptStr);
-        out += ')';
+        out += ")";
     }
     out += ` AS\n${viewdef}`;
     // Strip trailing semicolon from pg_get_viewdef.
-    if (out.endsWith(';')) {
+    if (out.endsWith(";")) {
         out = out.slice(0, -1);
     }
-    if (checkoption !== '') {
+    if (checkoption !== "") {
         out += `\n WITH ${checkoption} CHECK OPTION`;
     }
-    if (!out.endsWith('\n'))
-        out += '\n';
+    if (!out.endsWith("\n"))
+        out += "\n";
     return { ok: true, def: out };
 };
 /**
@@ -438,12 +450,12 @@ const getViewCreateCmd = async (c, oid) => {
  */
 const renderReloptions = (literal) => {
     // Strip surrounding `{}`.
-    if (!literal.startsWith('{') || !literal.endsWith('}')) {
+    if (!literal.startsWith("{") || !literal.endsWith("}")) {
         return literal;
     }
     const inside = literal.slice(1, -1);
     if (inside.length === 0)
-        return '';
+        return "";
     // Postgres array literals quote individual elements with `"…"` when
     // they contain commas or special chars. For reloptions on a view the
     // values are typically bare `key=value` strings, but we still need to
@@ -453,9 +465,12 @@ const renderReloptions = (literal) => {
     for (let entry of entries) {
         // unquote double-quoted entries
         if (entry.startsWith('"') && entry.endsWith('"')) {
-            entry = entry.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
+            entry = entry
+                .slice(1, -1)
+                .replace(/\\"/g, '"')
+                .replace(/\\\\/g, "\\");
         }
-        const eq = entry.indexOf('=');
+        const eq = entry.indexOf("=");
         if (eq < 0) {
             out.push(entry);
             continue;
@@ -470,17 +485,17 @@ const renderReloptions = (literal) => {
             out.push(`${key}='${value.replace(/'/g, "''")}'`);
         }
     }
-    return out.join(', ');
+    return out.join(", ");
 };
 /** Split a Postgres text-mode array's inner content on top-level commas. */
 const splitArrayElems = (s) => {
     const out = [];
     let i = 0;
-    let cur = '';
+    let cur = "";
     let inQuote = false;
     while (i < s.length) {
         const ch = s[i];
-        if (ch === '\\' && i + 1 < s.length) {
+        if (ch === "\\" && i + 1 < s.length) {
             cur += s[i] + s[i + 1];
             i += 2;
             continue;
@@ -491,16 +506,16 @@ const splitArrayElems = (s) => {
             i++;
             continue;
         }
-        if (ch === ',' && !inQuote) {
+        if (ch === "," && !inQuote) {
             out.push(cur);
-            cur = '';
+            cur = "";
             i++;
             continue;
         }
         cur += ch;
         i++;
     }
-    if (cur.length > 0 || s.endsWith(','))
+    if (cur.length > 0 || s.endsWith(","))
         out.push(cur);
     return out;
 };
@@ -522,12 +537,12 @@ const writeWithLineNumbers = (buf, isFunc, out) => {
     let i = 0;
     while (i < buf.length) {
         // Find end-of-line.
-        const eol = buf.indexOf('\n', i);
+        const eol = buf.indexOf("\n", i);
         const line = eol === -1 ? buf.slice(i) : buf.slice(i, eol);
         if (inHeader &&
-            (line.startsWith('AS ') ||
-                line.startsWith('BEGIN ') ||
-                line.startsWith('RETURN '))) {
+            (line.startsWith("AS ") ||
+                line.startsWith("BEGIN ") ||
+                line.startsWith("RETURN "))) {
             inHeader = false;
         }
         if (!inHeader)
@@ -538,7 +553,7 @@ const writeWithLineNumbers = (buf, isFunc, out) => {
         else {
             // %-7d → left-justified, padded to 7. Then literal space, then line.
             const numStr = String(lineno);
-            const pad = numStr.length >= 7 ? '' : ' '.repeat(7 - numStr.length);
+            const pad = numStr.length >= 7 ? "" : " ".repeat(7 - numStr.length);
             out(`${numStr}${pad} ${line}\n`);
         }
         if (eol === -1)
@@ -570,7 +585,7 @@ const runShowFunction = async (ctx, cmdName, base) => {
     const { plus } = decodeShowSuffix(cmdName, base);
     const desc = readObjDesc(ctx);
     if (desc === null) {
-        return errResult(ctx, 'function name is required');
+        return errResult(ctx, "function name is required");
     }
     const oidLookup = await lookupFunctionOid(c, desc);
     if (!oidLookup.ok)
@@ -579,7 +594,7 @@ const runShowFunction = async (ctx, cmdName, base) => {
     if (!defLookup.ok)
         return queryErrResult(ctx, defLookup.err);
     emitDefinition(defLookup.def, plus, /*isFunc=*/ true);
-    return { status: 'ok' };
+    return { status: "ok" };
 };
 const runShowView = async (ctx, cmdName, base) => {
     const c = conn(ctx);
@@ -588,7 +603,7 @@ const runShowView = async (ctx, cmdName, base) => {
     const { plus } = decodeShowSuffix(cmdName, base);
     const desc = readObjDesc(ctx);
     if (desc === null) {
-        return errResult(ctx, 'view name is required');
+        return errResult(ctx, "view name is required");
     }
     const oidLookup = await lookupRelationOid(c, desc);
     if (!oidLookup.ok)
@@ -597,38 +612,38 @@ const runShowView = async (ctx, cmdName, base) => {
     if (!defLookup.ok)
         return queryErrResult(ctx, defLookup.err);
     emitDefinition(defLookup.def, plus, /*isFunc=*/ false);
-    return { status: 'ok' };
+    return { status: "ok" };
 };
 // ---------------------------------------------------------------------------
 // BackslashCmdSpec exports
 // ---------------------------------------------------------------------------
 /** `\sf [+] FUNCNAME` — show function source. */
 export const cmdShowFunction = {
-    name: 'sf',
-    argMode: 'whole-line',
-    helpKey: 'sf',
-    run: (ctx) => runShowFunction(ctx, ctx.cmdName, 'sf'),
+    name: "sf",
+    argMode: "whole-line",
+    helpKey: "sf",
+    run: (ctx) => runShowFunction(ctx, ctx.cmdName, "sf"),
 };
 /** `\sf+ FUNCNAME` — show function source with line numbers. */
 export const cmdShowFunctionPlus = {
-    name: 'sf+',
-    argMode: 'whole-line',
-    helpKey: 'sf',
-    run: (ctx) => runShowFunction(ctx, ctx.cmdName, 'sf'),
+    name: "sf+",
+    argMode: "whole-line",
+    helpKey: "sf",
+    run: (ctx) => runShowFunction(ctx, ctx.cmdName, "sf"),
 };
 /** `\sv [+] VIEWNAME` — show view source. */
 export const cmdShowView = {
-    name: 'sv',
-    argMode: 'whole-line',
-    helpKey: 'sv',
-    run: (ctx) => runShowView(ctx, ctx.cmdName, 'sv'),
+    name: "sv",
+    argMode: "whole-line",
+    helpKey: "sv",
+    run: (ctx) => runShowView(ctx, ctx.cmdName, "sv"),
 };
 /** `\sv+ VIEWNAME` — show view source with line numbers. */
 export const cmdShowViewPlus = {
-    name: 'sv+',
-    argMode: 'whole-line',
-    helpKey: 'sv',
-    run: (ctx) => runShowView(ctx, ctx.cmdName, 'sv'),
+    name: "sv+",
+    argMode: "whole-line",
+    helpKey: "sv",
+    run: (ctx) => runShowView(ctx, ctx.cmdName, "sv"),
 };
 /**
  * `\ef [+] [FUNCNAME [LINE]]` — upstream opens `$EDITOR` on the function's
@@ -638,17 +653,17 @@ export const cmdShowViewPlus = {
  * with a hint pointing at `\sf`.
  */
 export const cmdEditFunction = {
-    name: 'ef',
-    argMode: 'whole-line',
-    helpKey: 'ef',
+    name: "ef",
+    argMode: "whole-line",
+    helpKey: "ef",
     async run(ctx) {
         const c = conn(ctx);
         if (!c)
             return noConn(ctx);
-        const { plus } = decodeShowSuffix(ctx.cmdName, 'ef');
+        const { plus } = decodeShowSuffix(ctx.cmdName, "ef");
         const desc = readObjDesc(ctx);
         if (desc === null) {
-            return errResult(ctx, 'editing not supported in embedded psql; supply a name to display the source');
+            return errResult(ctx, "editing not supported in embedded psql; supply a name to display the source");
         }
         // Strip a possible trailing LINE number (upstream behaviour for \ef
         // FUNCNAME LINE — the editor opens at that line; we just discard it).
@@ -660,24 +675,24 @@ export const cmdEditFunction = {
         if (!defLookup.ok)
             return queryErrResult(ctx, defLookup.err);
         emitDefinition(defLookup.def, plus, /*isFunc=*/ true);
-        return { status: 'ok' };
+        return { status: "ok" };
     },
 };
 /**
  * `\ev [+] [VIEWNAME [LINE]]` — same contract as `\ef` but for views.
  */
 export const cmdEditView = {
-    name: 'ev',
-    argMode: 'whole-line',
-    helpKey: 'ev',
+    name: "ev",
+    argMode: "whole-line",
+    helpKey: "ev",
     async run(ctx) {
         const c = conn(ctx);
         if (!c)
             return noConn(ctx);
-        const { plus } = decodeShowSuffix(ctx.cmdName, 'ev');
+        const { plus } = decodeShowSuffix(ctx.cmdName, "ev");
         const desc = readObjDesc(ctx);
         if (desc === null) {
-            return errResult(ctx, 'editing not supported in embedded psql; supply a name to display the source');
+            return errResult(ctx, "editing not supported in embedded psql; supply a name to display the source");
         }
         const objDesc = stripTrailingLine(desc);
         const oidLookup = await lookupRelationOid(c, objDesc);
@@ -687,7 +702,7 @@ export const cmdEditView = {
         if (!defLookup.ok)
             return queryErrResult(ctx, defLookup.err);
         emitDefinition(defLookup.def, plus, /*isFunc=*/ false);
-        return { status: 'ok' };
+        return { status: "ok" };
     },
 };
 /**
@@ -697,11 +712,11 @@ export const cmdEditView = {
  */
 export const cmdEditFunctionPlus = {
     ...cmdEditFunction,
-    name: 'ef+',
+    name: "ef+",
 };
 export const cmdEditViewPlus = {
     ...cmdEditView,
-    name: 'ev+',
+    name: "ev+",
 };
 /**
  * Strip a trailing LINE number from an object descriptor, matching
@@ -728,7 +743,7 @@ const stripTrailingLine = (desc) => {
     if (i <= 0)
         return desc;
     const sep = desc[i];
-    if (!(/\s/.test(sep) || sep === ')'))
+    if (!(/\s/.test(sep) || sep === ")"))
         return desc;
     return desc.slice(0, i + 1).trimEnd();
 };