📄 工具详情 ⚙️ 安装教程 📚 使用教程

能力标签

🤖 Agent 🔄 工作流 🌐 翻译 🐳 Docker 💻 CLI 🖼 视觉 🧠 Claude ✨ GPT

🛠

AI工具

PgStudio

基于 TypeScript · 开源免费，本地部署，数据完全自主可控

⭐ 11 Stars 🍴 1 Forks 💻 TypeScript 📄 MIT 🏷 AI 8.0分

8.0AI 综合评分

PostgreSQLVS Code数据库管理

🌐 访问官网

✦ AI Skill Hub 推荐

经 AI Skill Hub 精选评估，PgStudio 获评「强烈推荐」。这款AI工具在功能完整性、社区活跃度和易用性方面表现出色，AI 评分 8.0 分，适合有一定技术背景的用户使用。

📚 深度解析

PgStudio 是一款基于 TypeScript 的开源工具，在 GitHub 上收获 0k+ Star，是PostgreSQL、VS Code、数据库管理领域中的优质开源项目。开源工具的最大优势在于代码完全透明，你可以审计每一行代码的安全性，也可以根据自身需求进行二次开发和定制。

**为什么要使用开源工具而非商业 SaaS？**
对于个人开发者和有隐私需求的用户，本地部署的开源工具意味着数据不离本机，不受第三方服务商的数据政策约束。同时，开源工具通常没有使用次数限制和月度费用，一次安装即可长期使用，对于高频使用场景的总拥有成本（TCO）远低于订阅制商业工具。

**安装与环境准备**
PgStudio 依赖 TypeScript 运行环境。建议通过 pyenv（Python）或 nvm（Node.js）管理 TypeScript 版本，避免全局环境污染。对于新手用户，推荐先创建虚拟环境（python -m venv venv && source venv/bin/activate），再安装依赖，这样即使出现问题也可以随时删除虚拟环境重新开始，不影响系统稳定性。

**社区与维护**
GitHub Issue 和 Discussion 是获取帮助的最快渠道。在提问前建议先检查 Closed Issues（已关闭的问题），大多数常见问题都已有解答。遇到 Bug 时，提供 pip list 的输出、完整错误堆栈和最小可复现示例，能显著提高开发者响应速度。AI Skill Hub 将持续追踪 PgStudio 的版本更新，及时通知重要功能变化。

📋 工具概览

智能PostgreSQL工具，支持构建、探索和查询

PgStudio 是一款基于 TypeScript 开发的开源工具，专注于 PostgreSQL、VS Code、数据库管理等核心功能。作为 GitHub 开源项目，它拥有活跃的社区支持和持续的版本迭代，代码完全透明可审计，支持本地部署以保护数据隐私。无论是个人使用还是集成到企业工作流，都能提供稳定可靠的解决方案。

GitHub Stars

⭐ 11

开发语言

TypeScript

支持平台

Windows / macOS / Linux

维护状态

轻量级项目，按需更新

开源协议

MIT

AI 综合评分

8.0 分

工具类型

AI工具

Forks

📖 中文文档

以下内容由 AI Skill Hub 根据项目信息自动整理，如需查看完整原始文档请访问底部「原始来源」。

智能PostgreSQL工具，支持构建、探索和查询

📌 核心特色

开源免费，支持本地部署，数据完全自主可控
活跃的 GitHub 开源社区，持续迭代更新
提供详细文档和使用示例，新手友好
支持自定义配置，灵活适配不同使用环境
可作为基础组件集成进现有技术栈或进行二次开发

🎯 主要使用场景

本地部署运行，保护数据隐私，满足合规要求
自定义集成到现有系统，扩展技术栈能力
作为开源基础组件进行商业化二次开发

以下安装命令基于项目开发语言和类型自动生成，实际以官方 README 为准。

安装命令

# 方式一：npm 全局安装
npm install -g pgstudio

# 方式二：npx 直接运行（无需安装）
npx pgstudio --help

# 方式三：项目依赖安装
npm install pgstudio

# 方式四：从源码运行
git clone https://github.com/dev-asterix/PgStudio
cd PgStudio
npm install
npm start

📋 安装步骤说明

访问 GitHub 仓库页面
按照 README 文档完成依赖安装
根据系统环境完成初始化配置
参考官方示例或文档开始使用
遇到问题可在 GitHub Issues 中查找解答

以下用法示例由 AI Skill Hub 整理，涵盖最常见的使用场景。

常用命令 / 代码示例

# 命令行使用
pgstudio --help

# 基本用法
pgstudio [options] <input>

# Node.js 代码中使用
const pgstudio = require('pgstudio');

const result = await pgstudio.run(options);
console.log(result);

以下配置示例基于典型使用场景生成，具体参数请参照官方文档调整。

配置示例

# pgstudio 配置说明
# 查看配置选项
pgstudio --config-example > config.yml

# 常见配置项
# output_dir: ./output
# log_level: info
# workers: 4

# 环境变量（覆盖配置文件）
export PGSTUDIO_CONFIG="/path/to/config.yml"

📑 README 深度解析真实文档完整度 95/100 查看 GitHub 原文 →

以下内容由系统直接从 GitHub README 解析整理，保留代码块、表格与列表结构。

简介

8. More Features

More Features

---

✨ Key Features

🔌 Secure Connections — VS Code SecretStorage encryption
🛡️ Connection Safety — Environment tagging (🔴 PROD, 🟡 STAGING, 🟢 DEV), read-only mode, query safety analyzer
⏱️ Performance Tracking — Historical query execution monitoring with degradation alerts
📊 Live Dashboard — Real-time metrics & query monitoring
🚦 Dashboard Health Signals — Status badges, lock/wait indicators, and performance-focused telemetry cards
📓 SQL Notebooks — Interactive notebooks with AI assistance
🗂️ Notebook Manager — Open/create notebooks with searchable picker and improved metadata context
💾 Saved Queries — Tag-based organization, connection context restoration, AI metadata generation, edit & reuse
🌳 Database Explorer — Browse tables, views, functions, types, FDWs
🛠️ Object Operations — CRUD, scripts, VACUUM, ANALYZE, REINDEX, plus triggers/sequences/domains/rules/partitions/publications/event triggers/tablespaces/aggregates
🏗️ Visual Table Designer — Create/Edit tables with a robust GUI
🧭 Definition Viewer (SQL Preview) — Open object DDL with toggleable SQL preview, copy/edit workflows, and routine scaffolding
🔑 Index & Constraint Manager — Visual management of DB constraints
🧠 Schema Intelligence — Schema search, index advisor, and migration generator workflows
📋 Smart Paste — Context-aware clipboard actions (SQL/CSV/JSON)
📊 Table Intelligence — Profile, activity monitor, index usage, definition viewer
🔍 EXPLAIN CodeLens — One-click query analysis directly in notebooks
🎛️ Advanced Result UX — Column stats, transpose view, enhanced filtering, sliding-window streaming for large SELECTs, configurable bytea display, and structured in-grid editing with explicit commit confirmation
🛡️ Auto-LIMIT — Intelligent query protection (configurable, default 1000 rows)
🌍 Foreign Data Wrappers — Manage foreign servers, user mappings & tables
🤖 AI-Powered — Generate, Optimize, Explain & Analyze with guided follow-ups; regenerate or branch the conversation from a prior user message (GitHub Models, OpenAI, Anthropic, Gemini, VS Code LM)
🧩 Flexible SQL Assistant Layout — Open SQL Assistant in editor tabs and keep multiple assistant tabs open simultaneously
🖼️ Vision AI — Paste or upload images directly in the SQL Assistant; sent to vision-capable AI providers
📎 File Preview — Click attached file chips to open them as preview tabs in the editor
📤 Export Data — Export results to CSV, JSON, or Excel

---

⚡ Powerful Features

Interactive SQL notebooks
🤖 AI-powered Copilot & agentic support
Table intelligence & performance insights
Complete CRUD operations
EXPLAIN CodeLens for query analysis

</td> </tr> <tr> <td>

📋 Feature Matrix

Area	PgStudio v1.2.1	Notes
Core PostgreSQL object operations	✅	Tables, views, mat views, functions, roles, extensions, FDWs, and more
AI-assisted SQL workflows	✅	Generate, optimize, explain, and analyze with notebook-first execution
Production safety controls	✅	Read-only mode, risk scoring, confirmation prompts, Auto-LIMIT
Real-time monitoring dashboard	✅	Activity and health views in VS Code
Interactive SQL notebooks	✅	Native `.pgsql` notebook execution with completions
In-grid result editing parity with desktop IDEs	⚠️ Partial	Stronger commit flow and tooling in v1.2.x; full parity still evolving
ERD/schema visualization parity	⚠️ Partial	Schema designer exists; ERD depth still evolving
Advanced replication administration	⚠️ Partial	Additional publication/subscription depth planned

---

Features

🏷️ Tag-Based Organization — Group queries by topic (e.g., "analytics", "maintenance", "daily-reports")
🔗 Connection Context — Queries remember their original connection, database, and schema
📓 Quick Reopening — Click "Open in Notebook" to restore the query with full context in a new notebook
✏️ Edit Anytime — Modify title, description, tags, and SQL without creating duplicates
🤖 AI Metadata — Auto-generate titles, descriptions, and tags using AI
📊 Rich Metadata Display — Hover to see creation date, last used, database, and schema

Prerequisites

Node.js ≥ 18.0.0
VS Code ≥ 1.90.0
PostgreSQL (for testing)

Install dependencies

npm install

Install dependencies

npm ci

1. Setup

PgStudio Setup

Telemetry Setup

PgStudio ships with a privacy-first telemetry client designed for anonymous product analytics.

No SQL text, schema/object names, hostnames, database names, usernames, or credentials are collected.
VS Code global telemetry setting is a hard gate; when disabled globally, PgStudio telemetry is disabled.
Event payloads are allowlisted and bucketed (durations/result sizes) to avoid raw sensitive values.

Setup

```bash

Compile TypeScript

npm run compile ```

Docker-Based Integration Tests

```bash

📦 Building & Publishing

```bash

Build VSIX package

npx vsce package

📺 Video Guides

🚀 Quick Start

```bash

Usage

Save Query: Click "Save Query" CodeLens button on any SQL cell in a notebook
Add Metadata: Enter title, description, and tags (AI can help auto-generate)
Organize: Use tags to group related queries
Reuse: Click a saved query → "Open in Notebook" to restore with original context
Edit: Right-click any saved query → "Edit Query" to modify it

---

Quick Start

```bash

2. More Settings

AI Assistant Setup

Configure telemetry mode

Set these in VS Code settings:

postgresExplorer.telemetry.mode: off | basic | detailed (default basic)
postgresExplorer.telemetry.allowUsage: allow anonymous usage counters (default true)
postgresExplorer.telemetry.allowPerformance: allow anonymized performance buckets (default false)

Configure PostHog sink (optional)

For remote telemetry ingestion:

postgresExplorer.telemetry.posthogHost: default https://us.i.posthog.com
postgresExplorer.telemetry.posthogApiKey: your PostHog project key

If posthogApiKey is empty, telemetry stays local (debug sink only).

🎨 Modern Interface

Beautiful, intuitive UI designed for developers
Real-time dashboard with live metrics
Context-aware operations
Seamless VS Code integration

</td> <td width="50%">

Running the Extension

Open the project in VS Code
Press F5 to launch Extension Development Host
Or use Run and Debug (Ctrl+Shift+D) → "Run Extension"

Run integration tests

npm run test:integration

Professional Database Management for VS Code

PgStudio (formerly YAPE) is a comprehensive PostgreSQL database management extension featuring interactive SQL notebooks, real-time monitoring dashboard, AI-powered assistance, and advanced database operations—all within VS Code.

📖 Documentation • 🛒 Marketplace • 🤝 Contributing • 📝 v1.0.0 Release Notes • 📋 Changelog

</div>

---

Install from VS Code

ext install ric-v.postgres-explorer

Publish to VS Code Marketplace

npx vsce publish

🙈 Feature Comparison

Feature	PgStudio	pgAdmin	DBeaver	TablePlus
VS Code Integration	✅ Native	❌	❌	❌
SQL Notebooks	✅ Interactive	❌	❌	❌
AI Assistant	✅ Built-in	❌	❌	❌
Real-time Dashboard	✅	✅	⚠️ Limited	⚠️ Limited
Inline Cell Editing	✅	✅	✅	✅
Export Formats	CSV, JSON, Excel	CSV, JSON	CSV, JSON, Excel	CSV, JSON, SQL
SSH Tunneling	✅	✅	✅	✅
Foreign Data Wrappers	✅ Full	✅	⚠️ Limited	❌
License	MIT (Free)	PostgreSQL (Free)	Apache 2.0 (Free)	Proprietary (Paid)