Pocketbase

🚀 高度なポータブル - Pocketサーバードキュメント

この高度なポータブル - Pocketサーバーは、PocketBaseデータベースの操作や管理を容易にするための機能を提供しています。データベースのCRUD操作、データ移行、バックアップと復元、ユーザー認証など、幅広い機能を備えています。

✨ 主な機能

この高度なポータブル - Pocketサーバーは、以下の機能を提供します：

• データベース操作：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. プルリクエストの作成：メインブランチにマージするためのプルリクエストを提出します。