menu
language日本語
save_alt ダウンロード

Column Finder

読み取り専用のスキーマ検索で、PostgreSQL、MySQL、MariaDB のテーブルやビューにまたがってカラムを検索します。

作成者: Vitor Hugo コミュニティプラグイン

Readme

このテキストは第三者が書いたもので、自動翻訳されています。 英語の原文を読む

CI

アクティブなデータベース内のすべてのテーブルとビューからカラムを検索する、読み取り専用の Beekeeper Studio プラグインです。

PostgreSQL、MySQL、MariaDB に対応しています。大文字と小文字を区別しない部分一致検索で、スキーマ、テーブル/ビュー、カラム、データ型を表示します。Structure ショートカットは、Beekeeper で読み込み済みのエンティティ一覧に存在する場合に、一致したテーブルを開きます。結果は最大 500 件です。テレメトリ、追加サーバー、データベース認証情報は一切不要です。

重要: このプラグインは、+ の横にある矢印から専用のタブで開きます。公式 SDK では、プラグインがネイティブのサイドバーフィルターを変更することはできません。

CI アーティファクトからインストール(Node 不要)

  1. Actions → CI を開き、成功した実行から beekeeper-column-finder アーティファクトをダウンロードします。
  2. アーティファクト内の manifest.json と dist/ ディレクトリを、Beekeeper のプラグインディレクトリ内の beekeeper-column-finder という名前のフォルダに展開します:
    • Windows: %APPDATA%\beekeeper-studio\plugins\beekeeper-column-finder
    • Linux: ~/.config/beekeeper-studio/plugins/beekeeper-column-finder
    • macOS: ~/Library/Application Support/beekeeper-studio/plugins/beekeeper-column-finder
    • Windows ポータブル版: {app-directory}\beekeeper-studio-data\plugins\beekeeper-column-finder
  3. コミュニティプラグインを有効にし(下記参照)、Beekeeper を完全に再起動してから、+ の横のドロップダウンから Column Finder を開きます。

想定される構成: beekeeper-column-finder/manifest.json と beekeeper-column-finder/dist/index.html、および dist/assets/。

CI は Windows と Ubuntu 上で Node.js 22 を使ってビルドし、ユニットテストを実行した後、インストール可能なプラグインバンドルをアップロードします(30日間利用可能。GitHub アーティファクトのダウンロードにはサインインが必要な場合があります)。

ソースからインストール(Windows PowerShell)

PowerShell で次のコマンドを実行します:

git clone https://github.com/hugoalves-dev/beekeeper-studio-column-finder.git
cd beekeeper-studio-column-finder
npm install
npm test
npm run build

$pluginDirectory = Join-Path $env:APPDATA 'beekeeper-studio\plugins'
New-Item -ItemType Directory -Force -Path $pluginDirectory | Out-Null
$link = Join-Path $pluginDirectory 'beekeeper-column-finder'
if (Test-Path $link) {
    Write-Host "Already exists: $link. Check its target before changing it."
} else {
    New-Item -ItemType Junction -Path $link -Target (Get-Location).Path | Out-Null
}

以前のバージョンをすでにリンクしている場合は、ジャンクションを再作成しないでください。最新のソースを pull し、npm install、npm test、npm run build を実行してから Beekeeper を再起動します。

コミュニティプラグインを有効にする(Beekeeper 5.7+)

Windows では、設定ファイルを開きます:

notepad "$env:APPDATA\beekeeper-studio\user.config.ini"

他の設定はそのままにして、pluginSystem セクションを 1 つ追加または更新します:

[pluginSystem]
disabled = false
communityDisabled = false

Column Finder の ID を allow[] に追加しないでください。allow[] にはバンドル済みプラグインの ID しか指定できません。この設定では他のサードパーティ製プラグインも許可されるため、信頼できるものだけをインストールしてください。管理者の system.config.ini がユーザー設定を上書きする場合があります。

Beekeeper で Tools → Manage Plugins を開き、Column Finder が有効になっていることを確認します。必要に応じて再起動してください。その後、+ の横のタブドロップダウンを使用します。

動作と制限事項

データベース 検索範囲
PostgreSQL アクティブなデータベース内のアクセス可能なすべてのユーザースキーマ(pg_catalog、information_schema、pg_toast* を除く)
MySQL DATABASE()(選択中のデータベース)
MariaDB DATABASE()(選択中のデータベース)

検索は information_schema.columns のみを読み取り、メタデータに対する権限が反映されます。入力は 16 進エンコードされた UTF-8 で扱われるため、SQL インジェクションを防ぎ、パーセントやアンダースコアも文字どおりに扱われます。書き込みは一切行いません。一致結果は最大 500 件まで表示され、それ以上ある場合はその旨が表示されます。

Structure ショートカットは、Beekeeper ですでに読み込まれているテーブル一覧に依存します。テーブルが見つかったのに移動できない場合は、エンティティ一覧を更新してください。MySQL と MariaDB では、ホストの内部表現に合わせるため、スキーマを省略して移動します。同様に、一部の PostgreSQL スキーマがホストのキャッシュに存在しない場合があります。

開発とテスト

npm install
npm test
npm run build
npm run dev
  • Node の組み込みテストランナーで、SQL 生成、インジェクション耐性、方言、テーブル移動オプションを検証します(ユニットテスト 8 件)。
  • TypeScript コンパイラで型をチェックし、Vite でプラグインを本番用にビルドします。
  • GitHub Actions が Windows と Ubuntu でテストとビルドを実行し、manifest.json + dist をアーティファクトとしてアップロードします。
  • ユニットテストは実際のデータベースに対してクエリを実行しません。MySQL/PostgreSQL/MariaDB との連携は手動で確認してください。

プロジェクト構成: src/sql.ts(SQL)、src/navigation.ts(ホストのタブ移動)、src/main.ts(SDK 連携)、src/style.css と index.html(UI)、tests/*.test.mjs(ユニットテスト)、.github/workflows/ci.yml(自動化)。

トラブルシューティング

  • プラグインが表示されない/無効になっている: Tools → Manage Plugins と user.config.ini を確認してください。
  • 古いバージョンが動作している: 実際のプラグインディレクトリまたはジャンクション先の manifest.json を確認してください。
  • Structure で「Table not found」と表示される: エンティティを更新してください。ホストはキャッシュ済みのテーブルしか開けません。
  • Windows/Linux を切り替えた後にビルドが失敗する: 使用中のプラットフォームで npm install を実行し、依存関係を再インストールしてください。
  • SDK の問題: Beekeeper の Help → Show Developer Tools で確認してください。

参考資料とライセンス

MIT ライセンス。独立したコミュニティプロジェクトであり、Beekeeper Studio が公認するものではありません。