データベース・ツール(db-tools)の操作方法

コマンド･ライン・ツールの「db-tools」は、PaperCut データベースとデータを操作するための機能を提供します。
ツールは次の場所にあります: [app-path]/server/bin/<platform>/ (例:C:\Program Files\PaperCut MF\server\bin\win )
db-toolsはコマンド・プロンプトから実行する必要があります。
コマンドの構文は下記の通りです:

db-tools command [options]


有効なコマンド次の通りです:

・export-db…データベース・データのエクスポート/バックアップ
・import-db …データベース・データのインポート/リストア
・init-db…新規データベースにテーブルと初期データを作成
・delete-old-logs…古いログ・データの削除(トランザクション, プリント・ログ, サーバ・ログ など)


「db-tools」はコマンド･プロンプト(またはコマンド・シェル)経由でアクセスするコマンドライン・アプリケーションです。
Linux/Mac上で使用する場合は、必ずユーザ「papercut」として実行してください。

Mac上で使用する例:
sudo su – papercut
db-tools import-db -f /Users/bob/papercut-backup.zip

Windows上で使用する例:
cd "C:\Program Files\PaperCut NG\server\bin\win\"
db-tools delete-old-logs 90

Mac上で使用する例:
sudo su – papercut
cd "/Applications/PaperCut NG/server/bin/mac/"
db-tools import-db /Users/bob/papercut-backup.zip

「db-tools」のコマンドはパワフルな低レベルのユーティリティであり、その使用には慎重な検討が必要です。
使用可能なコマンドの詳細は次に説明します:



コマンド export-db

「export-db」コマンドはデータベースからデータをエクスポートします。
エクスポートを実行する前にPaperCut のサービス(PaperCut Application Server, PaperCut Print Provider) は必ず停止してください。「export-db」コマンドの構文とオプションは下記の通りです:


＜注記＞
PaperCutのサービスを停止せずにオンライン・バックアップを行う場合は、サーバ・コマンドの「perform-online-backup」を使用してください。
サーバ・コマンドの詳細は別紙「サーバ･コマンド操作ガイド」を参照してください。

使用: db-tools export-db [options]
     -d,--dir <dir>   指定したディレクトリへデータベースをエクスポート
     -f,--file <file>   指定したファイルへデータベースをエクスポート
     -h,--help         このコマンドのヘルプを表示


オプションを指定しなかった場合、データベースのエクスポート・ファイルは
ディレクト [app-path]\server\data\backups へ作成され、ファイル名は「export-[date-time].zip」となります。
「--dir」オプションは、デフォルトのバックアップ・ディレクトリを上書きするために使用されます。ファイル名は export-[date-time].zip のままです。
「--file」オプションは、バックアップが保存されているフルパスとファイル名を指定するために使用します。


＜注記＞
ディレクトリやファイル名のパラメータに空白が含まれている場合、引数は引用符で囲む必要があります。

 

コマンド import-db

「import-db」コマンドはデータ(以前のエクスポートで作成したバックアップ)をデータベースへインポートします。
インポートを実行する前にPaperCut のサービス(PaperCut Application Server, PaperCut Print Provider) は必ず停止してください。
「import-db」コマンドの構文とオプションは下記の通りです:

使用: db-tools import-db [options] import-file
     -f,--force      データをロードする前に既存のデータを削除
     -h,--help       このコマンドのヘルプを表示

データがすでにあるデータベースにデータをロードする場合は「--force」オプションが必要です。
「force」オプションにより、まず既存のデータが削除されます。

＜注記＞
インポートするファイルに空白が含まれている場合、引数は引用符で囲む必要があります。



コマンド init-db

「init-db」コマンドは、データベースを初期化し、必要なテーブルと初期データを作成します。
初期化を実行する前にPaperCut のサービス(PaperCut Application Server, PaperCut Print Provider) は必ず停止してください。
「init-db」コマンドの構文とオプションは下記の通りです:

使用: db-tools init-db [options]
     -f,--force      すでにデータベースが存在する場合、強制的にデータベースを初期化
     -h,--help       このコマンドのヘルプを表示

既にテーブルとデータが存在するデータベースを初期化する場合、「--force」オプションが必要です。
「force」オプションにより、テーブルを再作成する前に既存のテーブルをドロップします。

 

コマンド delete-old-logs

「delete-old-logs」コマンドは、システムから古いログ・データを削除するために使用します。このコマンドにより、下記のデータを永久的に削除します。
・プリント・ログ    : すべての印刷履歴と統計の記録
・アカウント処理ログ    : すべてのユーザ/共有アカウントの調整の記録
・アプリケーション・ログ: アプリケーションのステータスとエラー・メッセージの記録

使用: db-tools delete-old-logs [options] delete-older-than-days
     -n,--non-interactive   確認メッセージを表示せずに削除を実行
     -h,--help       このコマンドのヘルプを表示


「--non-interactive」オプションは、ユーザに確認メッセージを表示せずに削除を実行します。
スケジューリングされたタスクやcron ジョブとして削除を自動的に行う場合に便利です。
「delete-older-than-days」オプションにより、何日分より古いデータを削除するかを設定できます。
例えば、「delete-older-than-days」を「90」と設定すると、90日よりも古いすべてのログ･データをが削除されます。
「0(ゼロ)」を設定した場合、システムからすべてのログ・データが削除されます。