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. 創建拉取請求：提交拉取請求以合併到主分支。