VS Code で PostgreSQL、MySQL、MongoDB、Redis に接続する方法

著者:Sayaib Sarkar更新日:6 分で読めます

このページの内容 4 セクション

要点:データベースクライアントの拡張機能をインストールし、接続フォームに入力(または接続文字列を貼り付け)してテストし、サイドバーからテーブルを閲覧しましょう。このガイドでは DevSnip Pro の無料のデータベースクライアントを使います。PostgreSQL、CockroachDB、MySQL、MariaDB、SQL Server、Oracle、SQLite、ClickHouse、MongoDB、Redis に 1 つのパネルで対応しています。

ページ分割とフィルターで PostgreSQL のテーブルを閲覧する VS Code の DevSnip Pro データベースクライアント

開発中のデータベース作業のほとんどは、小さくて頻繁なものです。マイグレーションで列が追加されたか確かめる、API が書き込んだばかりの行を見る、壊れたテストデータを直す、コードに入れる前にクエリを試す。エディターの中で済ませれば、別のアプリケーションに移る手間がなくなります。

1. フォームまたは接続文字列で接続する

DevSnip Pro: Database Client を実行し、+ をクリックします。Form モードでデータベースの種類を選び、ホスト、ポート、ユーザー、パスワード、データベースを入力します。または Connection string に切り替えて貼り付けます:

コード
postgresql://app:secret@localhost:5432/app_dev
mysql://root:secret@localhost:3306/shop
mariadb://root:secret@localhost:3306/shop
Server=localhost,1433;Database=crm;User Id=sa;Password=…;TrustServerCertificate=true
oracle://hr:secret@localhost:1521/FREEPDB1
cockroachdb://root@localhost:26257/defaultdb?sslmode=disable
clickhouse://default:secret@localhost:8123/default
sqlite:///Users/me/project/dev.db
mongodb://localhost:27017/app
redis://localhost:6379/0

ドライバーはすべて拡張機能に同梱されています。Oracle は Thin モードを使うので、Oracle Client は不要です。TLS、クライアント証明書、SID、JDBC の URL など、さらに多くの例はデータベースクライアントのリファレンスにあります。

入力に合わせて、パネルには検出した内容が表示されます。データベースの種類、ホスト、データベース、ユーザー、TLS が有効かどうか、そしてリモートホストで TLS が無効といった警告です。Test を押し、続けて Save & connect を押します。

接続文字列は OS のキーチェーン(VS Code の SecretStorage)に保存されます。パスワードが再表示されることはなく、エラーメッセージに含まれることもありません。

接続できない場合は?メッセージに理由が表示されます:接続拒否、ホストが見つからない、認証失敗、TLS。自己署名証明書を使うローカルサーバーなら、sslmode=no-verify(PostgreSQL)、TrustServerCertificate=true(SQL Server)、tlsAllowInvalidCertificates=true(MongoDB)を追加します。SQL Server には SQL ログインが必要で、Windows 認証には対応していません。

2. データを安全に閲覧・編集する

  • 閲覧:データベース、スキーマ、テーブル、ビュー、コレクション、Redis のキー。各テーブルの列、型、キー、既定値は Structure で確認できます。
  • 行を探す:並べ替え、列をまたいだ検索、status = active のようなフィルター条件の追加。MongoDB では { plan: "pro", seats: { $gt: 5 } } のようなフィルタードキュメント、Redis では session:* のようなキーのパターンを使います。
  • 編集:行エディターは列の型、NULL、DEFAULT を理解します。MongoDB のドキュメントは Extended JSON(ObjectId()、ISODate())に対応。Redis のキーには型ごとのエディター(文字列、ハッシュ、リスト、セット、ソート済みセット)があり、TTL も扱えます。

安全策:

  • 行の削除や破壊的な文(DROP、TRUNCATE、WHERE のない DELETE/UPDATE、deleteMany、FLUSHDB)は、先に確認を求めます。
  • テーブルを削除するときは、その名前の入力が必要です。
  • 本番の接続は読み取り専用にしましょう。DevSnip Pro が書き込みを拒否します。PostgreSQL、CockroachDB、MySQL、MariaDB、Oracle、SQLite、ClickHouse では、サーバーのセッション自体も読み取り専用になります。
  • 主キーのないテーブルの行は、ctid(PostgreSQL)、ROWID(Oracle)、隠し列の rowid(CockroachDB、SQLite)で編集します。MySQL、MariaDB、SQL Server では、別の行を変えてしまう危険を避けるため、挿入はできますが編集はできません。ビューは読み取り専用です。

3. クエリを実行する

SQL の結合を実行して結果を表示する VS Code の DevSnip Pro データベースクエリコンソール

クエリコンソールは、SQL(Oracle の PL/SQL ブロックを含む)、db.collection.find({...}) の呼び出し、Redis のコマンドを、シンタックスハイライトと行番号付きで実行します。Ctrl/Cmd+Enter で選択範囲またはバッファー全体を実行します。

  • Format で SQL を整形します。
  • 構文エラーは、サーバーが見つけた位置に下線で表示されます。
  • 遅いクエリはサーバー側でキャンセルできます。
  • 結果は並べ替えやフィルターをしてから、テスト用のフィクスチャーやバグ報告のために JSON や CSV としてコピーできます。

サイドバーの Database セクションにある関連ツール:

  • SQL Formatter & Linter:一貫した整形に加え、SELECT * や WHERE の欠落などのミスを警告します。
  • SQL Query Helper:パラメーター化した SELECT、INSERT、UPDATE、UPSERT、DELETE、ページングのクエリを作成します。
  • Database Connection Strings:PostgreSQL、MySQL、MongoDB、Redis の URL を、ドライバーの設定とともに作成・修正します。
  • SQL → MongoDB Query:SQL のクエリを MongoDB の同等のクエリに変換します。

うまく回る開発サイクル

  1. 環境ごとに接続を 1 つ保存し、色を付け(ローカルは緑、本番は赤)、共有のものはすべて読み取り専用にします。
  2. マイグレーションを実行したら、テーブルの Structure を開いて確認します。
  3. REST API クライアントでエンドポイントを呼び出したら、書き込まれた行を確認します。
  4. クエリ結果を JSON としてコピーし、そのままテストのフィクスチャーにします。

本格的な管理作業(ユーザーとロール、バックアップ、大規模なクエリプラン)には専用のデータベースツールのほうが向いていますが、日々のサイクルではエディターの中にいるほうが速く進みます。

自分のエディターで試してみよう

無料・アカウント不要・ローカルで動作。Windows、macOS、Linux の VS Code 1.93 以降と JetBrains IDE に対応。

code --install-extension sayaib.hue-console