はじめに

本記事では、vsql の起動時に参照される環境変数について、紹介します。
環境変数を有効に利用することで、利便性やセキュリティの向上を図ることができます。

指定可能な環境変数

環境変数	説明
PAGER	クエリの結果が一画面に収まらない場合に使用されるページャーを指定します。
VSQL_DATABASE	接続先のデータベースを指定します。
TMPDIR	一時ファイルを保存するディレクトリを指定します。 デフォルトはプラットフォームに依存します。 Unix やLinuxでは、デフォルトは /tmp です。
VSQL_EDITOR	\ e コマンドで使用されるエディターを指定します。左記の変数を上から順に検査し、最初に設定されている変数の設定値が使用されます。
EDITOR
VISUAL
VSQL_HOME	デフォルトでは、 vsql は実行ユーザーのホームディレクトリから vsql の構成ファイル（ .vsqlrc ）を読み取ります。 これを変更したい場合に、本変数を使って構成ファイルの場所を上書きすることができます。
VSQL_HOST	Vertica ノードのホスト名または IP アドレスを指定します。
VSQL_PASSWORD	データベースのパスワードを指定します。
VSQL_PORT	接続に使用するポートを指定します。
VSQL_SSLMODE	サーバーへの接続時に admintools などのクライアントが SSL を使用するかどうか、およびその方法を指定します。
VSQL_USER	接続に使用するユーザー名を指定します。

使用例

※上記の例では Linux 環境を例にしていますが、Windows 環境であれば set コマンドや Windows の環境変数設定画面から設定することが可能です。

想定されるユースケース

パスワードの隠蔽化

上述の「使用例」の”通常の接続方法”で記載したように、パスワードを vsql の引数として入力すると、他のユーザからプロセス表示をした際、パスワードがに丸見えになってしまいます。
これを防ぐために VSQL_PASSWORD 環境変数を設定し、パスワードの秘匿性を担保します。

よく利用するデータベース、データベースユーザの入力を省略

Windows マシンなどのクライアントから、頻繁に接続するデータベース、データベースユーザを VSQL_HOST、VSQL_DATABASE、VSQL_USER 環境変数に設定しておきます。
予め接続先を固定してしまうことで、利便性向上だけでなく、接続データベースや接続ユーザの誤りを抑止するといった効果も見込めます。

※環境変数を設定している場合でも、vsql のオプションによって接続データベース、ユーザ、パスワードが指定された場合は、指定したオプションが優先されます。

検証バージョンについて

この記事の内容はVertica 9.2で確認しています。

更新履歴

2019/11/21　本記事を公開