快速定位问题:deno-postgres 4 个调试选项使用教程
【免费下载链接】postgresPostgreSQL driver for Deno项目地址: https://gitcode.com/gh_mirrors/postgr/postgres
调试是开发中最耗时的环节之一,而deno-postgres(Deno 生态中轻量高效的 PostgreSQL 驱动)内置了一套实用的调试机制,可以帮助你快速定位 SQL 问题。本教程将带你逐一掌握 deno-postgres 的 4 个调试选项:queries、notices、results和queryInError,并给出完整的配置方法和实战技巧,让你在开发中少走弯路。
deno-postgres 调试选项是什么?📦
deno-postgres 是专为 Deno 打造的 PostgreSQL 驱动,注重开发者体验。它的调试功能集中在controls.debug配置项中,通过开关控制是否输出查询日志、数据库消息、结果集等信息,从而快速定位 SQL 问题。
在源码层面,调试选项的类型定义位于项目的 debug.ts,核心结构如下:
queries:记录所有执行的 SQL 查询notices:记录数据库返回的 INFO、NOTICE、WARNING 消息results:记录所有查询返回的结果集queryInError:在报错对象中附带导致错误的 SQL 语句
4 个选项职责分明,既可单独开启,也可一键全开。
如何开启 deno-postgres 调试选项 🛠️
开启方式非常简单,在创建Client或Pool时传入controls.debug即可。配置入口定义在 connection_params.ts 的ClientControls类型中。
方式一:一键开启全部调试选项
只需把debug设为true,所有调试选项全部打开,适合开发初期快速摸清情况:
import { Client } from "https://deno.land/x/postgres/mod.ts"; const client = new Client({ user: "user", database: "test", controls: { debug: true }, }); await client.connect();方式二:按需开启单个选项
如果只想关注某一方面(比如只看 SQL 日志),可以传对象精准控制:
const client = new Client({ controls: { debug: { queries: true }, }, });小提示:开启多个选项后日志会同时输出,便于对照分析;确认问题后记得关闭,避免性能损耗。
调试选项一:queries —— 记录 SQL 查询日志 📝
开启queries后,每次执行 SQL 都会在控制台打印[QUERY]标签及完整语句。当你怀疑「某条语句没执行」或「参数拼错了」时,这个选项能第一时间给出答案。
controls: { debug: { queries: true } }对应实现位于 connection.ts 的logQuery函数,输出效果如下:
[ QUERY ] : SELECT public.get_uuid()调试选项二:notices —— 捕获数据库提示与警告 ⚠️
PostgreSQL 在运行中会产生 INFO、NOTICE、WARNING 三类消息(比如触发器提示、弃用警告等)。开启notices后,deno-postgres 会以不同颜色区分输出,让你不错过数据库的任何「悄悄话」。
- INFO:品红色标记
- NOTICE:黄色标记
- WARNING:橙色标记,并输出到 stderr
controls: { debug: { notices: true } }这在排查「查询成功但结果不符合预期」的场景下格外好用,因为很多提示信息平时并不会出现在结果集里。
调试选项三:results —— 查看查询结果集 📊
开启results后,每次查询返回的数据都会以[RESULTS]标签打印出来,省去手动console.log的麻烦:
[ RESULTS ] : [ { get_uuid: "d9c480ab-978c-46c9-91f3-38e46a2d9be2" } ]controls: { debug: { results: true } }把queries和results组合开启,就能形成「输入 SQL → 输出结果」的完整链路日志,非常适合排查数据转换或类型解析问题。
调试选项四:queryInError —— 报错中附带 SQL 语句 🔍
这是定位问题的「王牌选项」。默认情况下,PostgresError只包含数据库返回的错误信息,看不出是哪条 SQL 导致的。开启queryInError后,错误对象会多出query字段,直接记录引发错误的语句:
controls: { debug: { queryInError: true } }try { await client.queryObject("SELECT * FROM"); } catch (error) { console.log(error.message); // syntax error at or near "FROM" console.log(error.query); // SELECT * FROM }测试用例可在 query_client_test.ts 中找到对应验证,实现逻辑同样位于 connection.ts。
组合实战:一次完整的 deno-postgres 调试示例 🚀
下面把 4 个选项全部打开,直观感受一下调试输出的全貌:
从图中可以清楚看到一条完整链路:先输出执行的 SQL,再依次输出数据库的 INFO、NOTICE、WARNING 消息,最后输出查询结果。一眼就能定位 SQL 问题出现在哪个环节,这就是 deno-postgres 调试选项的价值所在。
使用 deno-postgres 调试选项的 3 个技巧 💡
- 开发环境全开,生产环境关闭:调试日志会带来额外的 I/O 开销,务必用环境变量控制开关,例如
controls: { debug: Deno.env.get("DENO_ENV") !== "production" }。 - 按需组合而非盲目全开:只查 SQL 用
queries,只查警告用notices,精准开启让日志更干净。 - 结合 Pool 使用同样生效:
Pool创建连接时传入相同的controls.debug配置即可,所有池内连接都会遵循该调试策略。
结语 ✨
deno-postgres 的 4 个调试选项覆盖了「查询语句、数据库消息、结果集、错误溯源」四个维度,是开发调试时的得力助手。掌握这套调试选项使用教程后,无论是语法错误、数据异常还是连接问题,你都能快速定位,把更多精力花在真正的业务逻辑上。快去你的 Deno 项目里试试吧!
【免费下载链接】postgresPostgreSQL driver for Deno项目地址: https://gitcode.com/gh_mirrors/postgr/postgres
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考