PocketBase

🚀 高级便携式-pocket 服务器文档

高级便携式-pocket 服务器为开发者提供了便捷且强大的数据库操作与管理功能。它支持对 PocketBase 数据库进行各类操作，涵盖增删改查、数据迁移、备份恢复等，同时具备完善的用户认证和错误处理机制，还通过 TypeScript 定义确保操作的类型安全。

✨ 主要特性

• 数据库操作：支持对 PocketBase 数据库的增删改查（CRUD）操作。
• 数据迁移：允许将数据库从旧版本迁移到新版本。
• 备份与恢复：提供数据库备份和还原功能。
• 用户认证：支持多种身份验证方法，包括密码、OAuth2 等。
• 错误处理：内置全面的错误处理机制。
• 类型安全：提供 TypeScript 定义确保操作的安全性。

📦 安装指南

通过常规方式安装

1. 创建环境变量文件：复制 .env.example 为 .env 并根据需要修改。
2. 安装依赖项：运行命令 npm install。
3. 构建项目：执行命令 npm run build。
4. 启动 PocketBase 实例。
5. 服务器自动连接：配置完成后，服务器会自动连接到 PocketBase。

通过 Smithery 安装

要通过 Smithery 自动为 Claude 桌面安装 PocketBase 服务器，可运行以下命令：

npx -y @smithery/cli install pocketbase-server --client claude

💻 使用示例

基础用法

创建新集合

pocket create_collection users

读取数据

pocket read_collection users --query "email=user@example.com"

更新数据

pocket update_collection users --id 123 --data '{"name": "John Doe"}'

删除数据

pocket delete_collection users --id 123

📚 详细文档

工具列表

以下是该服务器提供的所有工具及其功能说明：

1. create_collection - 创建新的数据库集合
2. read_collection - 读取指定集合中的数据
3. update_collection - 更新指定集合中的数据
4. delete_collection - 删除指定集合中的数据
5. migrate_collection - 将数据从旧集合迁移到新集合
6. backup_database - 备份整个数据库到指定格式
7. restore_database - 从备份文件还原数据库
8. list_auth_methods - 列出所有可用的身份验证方法
9. authenticate_user - 使用指定方法对用户进行身份验证
10. request_password_reset - 请求重置用户密码
11. confirm_password_reset - 确认用户密码重置
12. auth_refresh - 刷新用户的认证令牌

错误处理

所有工具都包含全面的错误处理机制，支持以下类型的错误：

• 请求格式错误
• 身份验证失败
• 数据库操作异常
• 方案验证失败
• 网络连接问题

每个错误都会提供详细的错误消息和代码。

类型安全

该服务器为所有操作提供了 TypeScript 定义，确保在使用工具时严格遵守类型规则。每个工具的输入模式都会经过严格的类型检查和验证。

最佳实践

1. 总是使用 try/catch 块进行错误处理。
2. 在执行操作前对数据进行充分验证。
3. 为查询创建适当的索引以提高性能。
4. 定期备份数据库。
5. 使用迁移工具进行架构更改。
6. 遵循用户管理的安全最佳实践。
7. 监控和优化数据库性能。

开发指南

1. 克隆仓库：使用 Git 克隆项目仓库。
2. 安装依赖项：运行 npm install。
3. 复制环境文件：将 .env.example 复制为 .env。
4. 构建项目：执行 npm run build。
5. 启动 PocketBase 实例。
6. 服务器自动连接：配置完成后，服务器会自动连接到 PocketBase。

贡献指南

1. 创建分支：从主分支创建新的功能分支。
2. 提交更改：将您的更改提交到本地仓库。
3. 推送代码：将代码推送到远程仓库。
4. 创建拉取请求：提交拉取请求以合并到主分支。