mcpField
N
neon-serverless

neon-serverless

github.com/neondatabase数据与数据库86281 次安装39 周前更新
代码仓库

关于 neon-serverless

neon-serverless 是一项技能,用于在无服务器和边缘环境中配置 Neon Serverless Driver。它提供连接模式、连接池和项目导入规则指导,并附带示例与连接验证脚本。

主要功能

  1. 01用于边缘和无服务器环境的 HTTP 连接
  2. 02WebSocket 连接池配置
  3. 03连接池使用指导
  4. 04TypeScript 和 JavaScript 导入规则
  5. 05连接验证脚本

适用场景

  1. 01为边缘函数设置 Neon 连接
  2. 02配置无服务器 API 的数据库访问
  3. 03选择 HTTP 或 WebSocket 连接模式
  4. 04部署前检查数据库连接

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/neondatabase/ai-rules --skill neon-serverless

安装后在 Claude Code 中输入/neon-serverless确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

scripts/
validate-connection.ts
templates/
http-connection.ts
websocket-pool.ts

详细介绍

Neon Serverless 技能

配置 Neon Serverless Driver,使其在无服务器和边缘计算环境中实现最佳性能。

适用场景

  • 为边缘函数(Vercel Edge、Cloudflare Workers)设置连接
  • 配置无服务器 API(AWS Lambda、Google Cloud Functions)
  • 优化低延迟数据库访问
  • 为高吞吐量应用实现连接池

不建议用于: 复杂的多语句事务(请使用 WebSocket Pool)、持久运行的服务端(请使用原生 PostgreSQL 驱动),或离线优先应用。

代码生成规则

生成 TypeScript/JavaScript 代码时:

  • 生成 import 语句之前,先检查 tsconfig.json 中是否配置了路径别名(compilerOptions.paths)
  • 如果存在路径别名(例如,"@/": ["./src/"]),请使用它们(例如,import { x } from '@/lib/utils')
  • 如果没有路径别名或无法确定,始终使用相对导入(例如,import { x } from '../../../lib/utils')
  • 确认导入符合项目配置
  • 默认使用相对导入——无论配置如何,它们都能正常工作

参考文档

主要资源: 请参阅项目根目录中的 [neon-serverless.mdc](https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-serverless.mdc),了解完整指南,包括:

  • 安装和兼容性要求
  • HTTP 与 WebSocket 适配器的选择
  • 连接池策略
  • 查询优化模式
  • 错误处理和故障排除

快速设置

安装
npm install @neondatabase/serverless
连接模式

HTTP 客户端(推荐用于边缘/无服务器环境):

import { neon } from '@neondatabase/serverless';
const sql = neon(process.env.DATABASE_URL!);
const rows = await sql`SELECT * FROM users WHERE id = ${userId}`;

WebSocket Pool(用于 Node.js 长连接):

import { Pool } from '@neondatabase/serverless';
const pool = new Pool({ connectionString: process.env.DATABASE_URL! });
const result = await pool.query('SELECT * FROM users WHERE id = $1', [userId]);

请参阅 templates/ 中的完整示例:

  • templates/http-connection.ts - HTTP 客户端设置
  • templates/websocket-pool.ts - WebSocket Pool 配置

验证

部署前,使用 scripts/validate-connection.ts 测试数据库连接。

相关技能

  • neon-auth - 添加身份验证
  • neon-js - 包含身份验证和数据 API 的完整 SDK
  • neon-drizzle - 用于搭配无服务器连接的 ORM
  • neon-toolkit - 用于临时数据库测试

想在项目中采用最佳实践? 使用参数 SKILL_NAME="neon-serverless" 运行 neon-plugin:add-neon-docs,添加参考链接。

评论

支持 Markdown