コマンドラインツールの簡易マニュアル

Firebirdに標準で付属するコマンドラインツールの簡易マニュアル。随時追加。
有志による自由な追加求む〜。

ユーザー情報の管理 gsec

ユーザー情報の追加・削除・情報変更を行う。
ユーザーアカウント等の管理も、通常のデータベースファイルと同じような方法で行われており、 ファイル名は通常は「security.fdb」となっている。(IBやFB1.0では「isc4.gdb」なので注意)

コマンドライン

gsec [options]

操作対象を指定しないと、対話モードに入る。データベースの指定を行わないと、ローカルマシンに対して処理が行われる。
optionsは次のとおり。

対話モードでのコマンド

データベースの設定と管理 gfix

データベースの色々な設定と管理を行うコマンドです。 IBConsole では出来ないような機能も含まれていますので、GUIベースのツールを 主に使っている人でも、使い方を覚えて損はありません。
重要な処理が行えるコマンドなため、データベースの所有者（作成者） もしくは管理者(SYSDBAユーザー)でなければ本コマンドは使用できません。
非常に多機能なツールで、以下のような機能があります。

・シャットダウン
・フラッシュ指定
・スイープ
・読み書きモード・読み込み専用モードの切り替え
・SQL Diarect の変更
・データベース毎のキャッシュサイズの変更
・リンボ状態になったトランザクションのコミット
・データベースやデータのある程度の修復と検証
・シャドウデータベースの設定

コマンドライン

gfix [options] db_name

optionsは次のとおり。

データベースのバックアップと復元 gbak

　データベースのバックアップと復元(リストア)を行うコマンドです。IBConsole にも ほぼ同様の機能があり、互換が有りますので併用することが可能です。 　データベースの所有者(作成者)もしくは管理者(SYSDBAユーザー)のみが本コマンドを 使用できます。
　コンソールベースのコマンドラインツールですので、Unix/Linux の cron やデーモン、 Windows の AT コマンドやサービスなどを使用して定時バックアップを自動化し、 専任オペレーター不要な環境を構築したい場合などに非常に便利です。

　バックアップはいつでも行えますが、当然ながら処理に時間がかかりますし負荷も重く なります。実行するタイミングは熟慮して決定する必要があります。
　復元(リストア)は、アプリケーションが使用中のデータベースに対して行うことはお勧めできません。

　バックアップ先のファイル名の拡張子は、(IB時代は)".gbk"が推奨されていますが、 どのような拡張子でも問題ありません。とりあえず、".gdb"は避けておいた方が良い と思いますが。
　バックアップファイルは、デフォルトではコマンドを実行したホストマシンからアクセスできる場所に作成出来ます。別ホスト上に作成する場合は、オプションを使用して サービスマネージャを指定する必要があります。これがちょっと曲者で、通信プロトコル により指定が異なりますので注意が必要です。

　このコマンドは、データベースのバックアップ→削除→リストア(→OSによるファイルデフラグ) という一連の作業により、ガベージコレクションに利用したりもします。スイープと違って、 一度綺麗に削除した後に再構成となりますので時間はかかりますが、より綺麗に掃除する ことが出来ます。 　長時間使用しているデータベースで、初期に比べて動作が遅いというときには、 この方法を試してみれば処理速度が向上するかもしれません。

バックアップ

　バックアップ先(ターゲット)がシングルファイルの方法と、マルチファイル化する方法 があります。
　マルチファイルにバックアップすることにより、巨大なデータベースをバックアップする 時に、バックアップで作成されたファイルをリムーバブルメディアにコピーするのが容易に なります。 　また、Windows の FAT 環境や古いLinux/Unixのようにファイルサイズの制限が厳しい ターゲットマシン上にバックアップを作成することも出来ます。
　どちらの方法にせよ、バックアップ元のデータベースがマルチファイル構成の場合は、 先頭ファイルのみを指定します。

• バックアップ先がシングルファイルの場合

  gbak [-B] [options] database target

• バックアップ先がマルチファイルの場合
  　３ファイルの場合です。注意するべき点としては、最後のターゲットファイルにサイズを 指定することは出来ないということです。当然それ以外に対してのサイズ指定は必須です。

  gbak [-B] [options] database target1 size1[k｜m｜g] target2 size2[k｜m｜g] target3

• バックアップモードの引数

  database	・バックアップしたい(バックアップ元)データベースの名前です。相手がネットワーク上の場合はホスト指定(host名:)が必要です。 ・マルチファイル構成データベースの場合は、先頭ファイルのみを指定します。
  target	バックアップ先(ターゲット)を指定します。デバイス名もしくはファイル名です。 ・UNIXなどで"stdout"を指定すれば標準出力に書き出します。パイプラインを使うときに有用です。 ・サイズ指定が無い場合は、自動的に必要なファイルサイズに拡張されます。
  size	ファイルサイズの指定(バイト数)です。 ・データベースのページサイズに対する倍数で指定する必要があります。最小値は200です。 ・後にk/m/gを付ける事により、Kバイト、Mバイト、Gバイト単位で指定できます。

• バックアップモード用のオプション

  モード指定
  -b[ackup_database]	バックアップモードの指定
  アカウント・接続に関する指定
  -pa[ssword] text	実行するユーザーのパスワード
  -role name	接続時のロールを名前で指定する
  -se[rvice] servicename	・バックアップ元データベースと同じホスト上にバックアップを作成する場合に指定する ・指定ホストのサービスマネージャを呼び出すが、通信プロトコルによって名前が異なるので注意。 TCP/IP　　　　hostname:service_mgr SPX　　　　　　hostname@service_mgr 名前つきパイプライン　　\\hostname\service_mgr ローカル　　　　　　service_mgr
  -user name	実行するユーザー名。当然ながらデータベース上でのユーザー名を指定する。
  バックアップファイル作成に関する指定
  -co[nvert]	外部ファイルを内部テーブルに変換
  -e[xpand]	バックアップ時に圧縮を行わない
  -fa[ctor] n	テープデバイスに対してブロックサイズを指定
  -g[arbage_collect]	バックアップ時にガベージコレクションを行わない
  -ig[nore]	バックアップ時にチェックサムを無視する
  -l[imbo]	バックアップ時にリンボ状態のトランザクションを無視する
  -m[etadata]	メタデータのみバックアップを行う。格納されたデータレコードはバックアップされない
  -nt	互換性を考慮しないバックアップファイルを作成する
  -ol[d_descriptions]	古いフォーマットでメタデータをバックアップする
  -t[ransportable]	互換性を考慮したバックアップファイルを作成する(未指定時のデフォルト動作)
  その他
  -v[erbose]	gbakの動作状態を表示
  -y [ file｜suppress_output ]	動作メッセージを指定ファイルに出力する。 ・指定ファイルは既存のファイルを指定してはいけない ・suppress_outputを指定すると、メッセージを出力しない
  -z	gbakとデータベースのバージョンを表示

  
  
  

復元（リストア）

　バックアップとは違い、バックアップ、リストアターゲット(復元する対象のデータベース) がマルチファイル構成の場合、全てのファイルを指定する必要があります。リストア時には、 ターゲットのデータベースを新規に作成するか、既存のデータベースに対して行うかを指定する 必要があります。
　※※※※※重要※※※※※：復元(リストア)操作は、アプリケーションが使用中のデータベースに対して行うことはお勧めできません。 リストア処理でトランザクションが無視されてしまい、一貫性が失われる場合があるためです。 ネットワークを遮断するか、使用アプリケーションを全て停止させた状態での使用を お勧めします。

• 両者ともにシングルファイルの場合

  gbak {-C｜-R} [options] source dbfile

• バックアップがシングルファイルでリストアターゲットがマルチファイルの場合

  gbak {-C｜-R} [options] source dbfile1 size1 dbfile2 [ size2 dbfile3 …]

• バックアップがマルチファイルでリストアターゲットがシングルファイルの場合

  gbak {-C｜-R} [options] source1 source2 [source3 …] dbfile

• 両方ともマルチファイルの場合

  gbak {-C｜-R} [options] source1 source2 [source3 …] dbfile1 size1 dbfile2 [size2 dbfile3 …]

• リストアモードの引数

  dbfile	・リストアするターゲットデータベースの名前です。相手がネットワーク上の場合はホスト指定(host名:)が必要です。
  source	バックアップで作成されたファイル、またはデバイス名を指定します。 ・UNIXなどで"stdout"を指定すれば標準入力より読み込みます。パイプラインを使うときに有用です。
  size	ファイルサイズの指定(バイト数)です。 ・データベースのページサイズに対する倍数で指定する必要があります。最小値は200です。 ・後にk/m/gを付ける事により、Kバイト、Mバイト、Gバイト単位で指定できます。 ・各セクションの最後にファイルには指定できません。自動的に必要なサイズに拡張されます。

• リストアモード用のオプション

データベースの状態確認 gstat

　データベースの状態を確認するコマンドです。 　データベースの所有者(作成者)もしくは管理者(SYSDBAユーザー)のみが本コマンドを 使用できます。(Unix版での注意：このコマンドを使用するユーザーは、データベースの システムファイルをアクセスできる適切な権限が必要です。使用アカウントのグループ 設定などが必要になる場合があります)
　このコマンドは、ローカルなデータベースにのみ使用できます。
　また、このコマンドはデータベースが起動していなくてもある程度の機能が使用できます。

コマンドライン

gstat [options] database

　options は次のとおり。

ヘッダページ情報

ヘッダページ情報を表示します。

Checksum

ヘッダページのチェックサム

Generation

ヘッダページが書き込まれる毎に+1されるカウンタ

Page size

データベースのページサイズ

ODS version

ディスク上のファイルフォーマットのバージョン

Oldest transaction

完了していないトランザクションの中で最も古いもののID

Oldest active

有効になっているトランザクションの中で最も古いもののID

Next transaction

次のトランザクションに割り振るID
※Oldest transactionとNext transactionの差が自動スイープ実行のトリガになります。

Sequence number

ヘッダページのシーケンス番号

Next connection ID

次のデータベース接続に対して割り振る番号

Implementation ID

データベースが作成されたシステムのアーキテクチャ

1	Apollo	2	Sun, HP 9000, IMP Delta, NeXT
3	Reserved	4	VMS
5	VAX Ultrix	6	Reserved
7	HP 900	8	OS/2,Windows NT,Novell
9	Reserved	10	RS 6000
11	Data General AViiON	12	HP MPE/XL
13	Silicon Graphics Iris	14	Reserved
15	DEC OSF/1	16	Windows 32bit
17	OS/2	18	Windows 16bit
19	Linux Intel	20	Linux SPARC

Shadow count

シャドウファイルの数

Number of cache buffers

キャッシュ内のページバッファ数

Next header page

次のヘッダページのID

Database dialect

データベースのDIALECT(FBでは通常3以降)

Creation date

作成日時

Attributes

アトリビュート
・force_write　強制書き込み可能であることを示す
・no_reserve　古いデータのために領域が確保されていないことを示す
・shutdown　データベースが停止中であることを示す

Database file sequence

マルチファイルデータベース構成に関する情報

データベースログ情報

データベースサマリーのデータベースログ情報を表示します。詳しい解説は未発見。

データページ情報

データベースサマリーのデータページ情報を表示します。

Primary pointer page

テーブルの最初のポインタページのページ番号

Index root page

インデックスのルートのページ番号

Data pages

データのページ数

Data page slots

データベースページへのポインタ。ページがデータベースにあるかを示す :Average fill:データページ内にデータが配置されている割合の平均

Fill distribution

指定された率のデータで見たされたページの割合を示すヒストグラム

インデックスページ情報

データベースサマリーのインデックスページを表示します。

Index

インデックス名

Depth

インデックスページツリーの深さ

Leaf buckets

インデックスページツリーのリーフ(最下層)のページ

Nodes

ツリー内のインデックスページ総数

Average data length

キーの平均バイト数

Total dup

インデックスのコピーを持っている列の総数

Max dup

最も多いインデックスコピー数

Fill distribution

指定された率のデータで見たされたページの割合を示すヒストグラム

※インデックスページツリーの深さが３を超える場合、ソートが効率的に行われません。その場合は、データベースのページサイズを増やしてみてください。ページサイズを増やしても深さが減らない場合は、ページサイズを元の値に戻した方が良いでしょう。

システム情報

データベースのシステムテーブルの情報を表示します。

SQLによるクエリー isql

　コマンドラインによる SQL クエリーを行うツールです。対話モードでの実行や コマンドをファイルを読込んでの実行が出来ます。テーブルの作成や参照、SQLの検証、 各種管理などに使用できます。
　対話モードでは、SQL標準のコマンド以外に独自のコマンドもあります。

コマンドライン

　対話モードでの場合は次のように、

isql

　非対話モードの場合は次のようになります。

isql [options] [database_name]

　対話モードや、非対話モードでの入力情報が足りない場合には、次のプロンプト が出ますので、必要なコマンドなどを入力してください。 入力が最終行の場合には、行の最後に終端文字(通常はセミコロン(;))が必要です。
　optionsは次のとおりです。

対話モードのコマンド

　次のような独自のコマンドがあります。

• BLOBDUMP
  　BLOB の内容をファイルに出力します。

BLOBDUMP blob_id filename;

• EDIT
  　エディタを立ち上げてコマンドを編集した後に実行します。使用するエディタ は EDITOR 環境変数で指定します。指定が無い場合、Windows ではメモ帳が、 UNIX では vi が起動します。

EDIT [filename];

• EXIT
  　トランザクションをコミットして isql を終了します。

EXIT;

• HELP
  　ヘルプを表示します。

HELP;

• INPUT
  　コマンド列を指定したファイルから読込んで実行します。

INPUT filename;

• OUTPUT
  　実行結果を指定したファイルに出力します。ファイルの指定が無い場合は、 標準出力に出力されます。

OUTPUT [filename];

• QUIT
  　トランザクションをロールバックして isql を終了します。

QUIT;

• SET
  　セッションをコントロールする各 SET コマンドのステータスを出力します。

SET;

• SHELL
  　シェルでコマンドを実行します。コマンドを省略すると、シェルが子プロセスで 立ち上がります。

SHELL [os_command];

• SET AUTODDL
  　DDL 文を実行後に自動コミットを行うか指定します。デフォルトはONです。

  SET AUTODDL [ON | OFF];

• SET BLOBDISPLAY
  　表示する BLOB データのサブタイプを指定します。デフォルトはテキスト(1指定)です。

  SET BLOBDISPLAY [ n | ALL | OFF];

  n	サブタイプを整数で指定。例として、0は未知、1はテキストを示す
  ALL	全サブタイプを表示する
  OFF	全サブタイプの表示を抑制する

• SET COUNT
  　クエリ実行で取得された行の数を出力するかを指定します。デフォルトはOFFです。

  SET COUNT [ON | OFF];

• SET ECHO
  　実行コマンドを表示するかどうかを指定します。デフォルトはONです。

  SET ECHO [ON | OFF];

• SET LIST
  　結果の出力をリスト形式で行うかを指定します。デフォルトはOFFで表形式で出力されます。

  SET LIST [ON | OFF];

• SET NAMES
  　データベーストランザクションで使用するキャラクタセットを指定します。 デフォルトは NONE です。

  SET NAMES [charset];

• SET PLAN
  　クエリオプティマイザのプランを表示するか指定します。デフォルトはOFFです。

SET PLAN [ON | OFF];

※ON/OFFを省略すると、現在のモードから他方に切り替わります（スイッチ動作）。 トラブル防止のためには明示的に指定することが望ましいです。

• SET STATS
  　クエリ実行後に、動作に関する各種情報を表示するかを指定します。デフォルトは OFF です。

  SET STATS [ON | OFF];

• SET TERM
  　コマンドの終端文字（デフォルトはセミコロン）を設定します。

  SET TERM string;

• SET TIME
  　DATE型の表示を行うときに、時間を表示するかどうかを指定します。デフォルトは OFF です。

  SET TIME [ON | OFF];

• SHOW CHECK
  　テーブルに設定された CHECK 制約を全て表示します。

  SHOW CHECK table;

• SHOW DATABASE
  　現在のデータベースの情報を表示します。

SHOW [DATABASE | DB];

• SHOW DOMAINS
  　現在のドメイン情報を表示します。nameの指定を行わないと、既存のドメイン情報 を一覧で表示します。指定有り無しで微妙につづりが違うので要注意です。

SHOW {DOMAINS | DOMAIN name};

• SHOW EXCEPTIONS
  　例外(EXCEPTION)の情報を表示します。nameを指定しないと、全ての例外を一覧表示します。 指定有り無しで微妙につづりが違うので要注意です。

SHOW {EXCEPTIONS | EXCEPTION name};

• SHOW FILTERS
  　BLOBフィルタの情報を表示します。nameを指定しないと、一覧表示をします。 指定有り無しで微妙につづりが違うので要注意です。

SHOW {FILTERS | FILTER name};

• SHOW FUNCTIONS
  　UDFの情報を表示します。nameを指定しないと、一覧表示をします。指定するとより詳細な 情報を表示します。指定有り無しで微妙につづりが違うので要注意です。

SHOW {FUNCTIONS | FUNCTION name};

• SHOW GENERATORS
  　ジェネレータの情報を表示します。nameを指定しないと、一覧表示をします。 指定有り無しで微妙につづりが違うので要注意です。

SHOW {GENERATORS | GENERATOR name};

• SHOW GRANT
  　データベースオブジェクトの権限を表示します。 objectは、テーブル・ビュー・プロシージャの名前です。

SHOW GRANT object;

• SHOW INDEX または SHOW INDICES
  　インデックスを表示します。indexやtableを指定しないと、一覧表示をします。 指定有り無しで微妙につづりが違うので要注意です。

SHOW {INDICES | INDEX { index | table} };

• SHOW PROCEDURES
  　プロシージャの情報を表示します。nameを指定しないと、一覧表示をします。指定するとより 詳細な情報を表示します。指定有り無しで微妙につづりが違うので要注意です。

SHOW {PROCEDURES | PROCEDURE name};

• SHOW ROLES
  　現在のデータベースの全ロールを表示します。

SHOW {ROLES | ROLE}

• SHOW SYSTEM
  　現在のデータベースのシステム情報テーブルやビューの名前を表示します。

SHOW SYSTEM [TABLES];

• SHOW TABLES
  　テーブルの情報を表示します。nameを指定しないと、一覧表示をします。指定するとより 詳細な情報を表示します。指定有り無しで微妙につづりが違うので要注意です。

SHOW {TABLES | TABLE name};

• SHOW TRIGGERS
  　トリガの情報を表示します。nameを指定しないと、一覧表示をします。指定するとより 詳細な情報を表示します。指定有り無しで微妙につづりが違うので要注意です。

SHOW {TRIGGERS | TRIGGER name};

• SHOW VERSION
  　データベースソフトやisqlのバージョンを表示します。

SHOW VERSION;

• SHOW VIEWS
  　トリガの情報を表示します。nameを指定しないと、一覧表示をします。 指定有り無しで微妙につづりが違うので要注意です。

SHOW {VIEWS | VIEW name};