新しい CUI ツール mssql-cli の使い方

Article
06/05/2018

Microsoft Japan Data Platform Tech Sales Team

佐藤秀和

SQL Server 2017 では Windows 以外に Linux やコンテナへの対応を行いましたので、マルチプラットフォームに対応したクライアントツールの整備を急ピッチで行っております。
今回は SQL Server の新たな CUI ツールである mssql-cli についてご紹介いたします。

クライアントツールのプラットフォーム対応状況

mssql-cliとは
CUI には繰り返しの処理実行や正確性( GUI ツールでの押し間違いなど)、実行履歴を保持できる、少ないリソースで動作できる、などGUI にはない多くのメリットがあります。
SQL Server のCUIツールとしては従来より sqlcmd がご利用いただけますが、Oracle や OSS DB 等他のDB製品をお使いになられている方々には、少し使い勝手が悪く感じられるところがあるかもしれません。また、SQL Server 2017 では、Linux やコンテナなどマルチプラットフォームに対応したこともあり、普段 Linux で CUI をお使いになっている方には、GUI ツールにはちょっと馴染めないという声をお聞きすることもあります。

そこでマイクロソフトは、OSS のコミュティである dbcli コミュニティと連携して、様々なプラットフォームで動作する SQL Server コマンドラインクエリツールを開発し、提供を始めました。それが今回ご紹介する mssql-cli です。

セットアップ
mssql-cli のセットアップには、Python が事前にインストールされている必要があります。
お使いの環境に Python がインストールされていない場合はこちらからダウンロードしてセットアップしてください。https://www.python.org/downloads/
Python は、2.7 およびそれ以降のバージョンに対応しています。

Python のセットアップの際には、pip ( Python パッケージ管理ツール) も Python のインストールの際に併せてセットアップしておくと、後ほど mssql-cli のセットアップの際に楽になります。(インストール画面のオプション機能で pip にチェックマークが入っていることを確認)
また、Windows 環境であれば Path 環境変数に Python のPath設定を追加するオプションを有効にしておくこともお勧めします。

Windows 環境の場合は、コマンドプロンプトで下記スクリプトを実行すると、mssql-cli のセットアップが完了します。

その他のプラットフォームへのセットアップについては、こちらを参照ください。
・dbcli/mssql-cli /doc/installation_guide.md
https://github.com/dbcli/mssql-cli/blob/master/doc/installation_guide.md#Alternative-Installation-via-direct-downloads

mssql-cli の特長
mssql-cli はインタラクティブなコマンドラインクエリーツールで以下の様な特徴があります。

・SQL ステートメントの IntelliSense
SQL Server Management Studio や SQL Server Data Tools, Visual Studio をお使いの方であればよくご存知かと思いますが、キーワードの自動入力補完機能です。入力候補をリストから選択することで、キー入力の省力化や、誤入力の低減により、作業性や生産性を高めることが出来ます。
例えば、SELECT クエリで対象のデータベース内のテーブル一覧からテーブルを選択して、列にはそのテーブルの列一覧が表示され、必要な列を選択するだけでクエリーが作成できます。

こちらに動作イメージのアニメーションもあります。