mysqldump — データベースバックアッププログラム

いくつかの機能を除いて --optの効果を選択したい場合、除きたい各機能に対して--skipオプションを選択してください。例えば、メモリバッファと拡張インサートを無効化するには、--opt --skip-extended-insert --skip-quickを使用してください。(MySQL 5.1では、--skip-extended-insert --skip-quickで十分です。これは--optがデフォルトで有効になっているためです。)

インデックス無効化とテーブルロック機能を生かして 他の--optの機能を無効化したい場合、--skip-opt --disable-keys --lock-tablesを使用してください。

--help, -?

ヘルプ メッセージを表示し、閉じます。

--add-drop-database

DROP DATABASEステートメントをCREATE DATABASEステートメントの前に追加します。

--add-drop-table

DROP TABLEステートメントをCREATE TABLEステートメントの前に追加します。

--add-locks

LOCK TABLESとUNLOCK TABLESステートメントで各テーブルダンプを囲みます。ダンプファイルを再ロードする際のインサートの速度が向上します。項 「INSERTステートメントの速度」 を参照してください。

--all-databases, -A

すべてのデータベース内のすべてのテーブルをダンプします。これは--databasesオプションを使用してコマンドラインですべてのデータベース名を指定するのと同じです。

--all-tablespaces, -Y

テーブルダンプに、NDB Clusterテーブルに使用されるテーブルスペース作成に必要なSQLステートメントを追加します。でなければ、この情報はmysqldumpの出力には含まれていません。このオプションは、現在MySQLクラスタテーブルに対してのみ有効です。

このオプションはMySQL で加されました。

--allow-keywords

キーワードであるカラム名の作成を許容します。これは各カラム名のプリフィクスにテーブル名を用いることで可能になります。

--character-sets-dir=path

キャラクタ セットがインストールされるディレクトリです。項 「データおよびソート用キャラクタ セット」 を参照してください。

--comments, -i

プログラムバージョン、サーババージョンやホストといった追加情報をダンプファイルに書き込みます。このオプションはデフォルトで有効となっています。追加情報を抑制するには、--skip-commentsを使用してください。

--compact

verbose生成を少なくします。このオプションはコメントを抑制し、--skip-add-drop-table、--no-set-names、--skip-disable-keys、そして--skip-add-locksオプションを有効化します。

--compatible=name

古いMySQLサーバや他のデータベースシステムと互換性のある出力を生成します。nameの値はansi、mysql323、mysql40、postgresql、oracle、mssql、db2、maxdb、no_key_options、no_table_options、あるいはno_field_optionsとなります。複数の値を使用する場合カンマで離してください。これらの値はサーバSQLモードの設定用の対応しているオプションと同じ意味を持っています。項 「SQL モード」 を参照してください。

このオプションは他のサーバとの互換性を保証するものではありません。現在提供されている、ダンプ出力の互換性を挙げるためのSQLモード値を有効化するだけです。例えば、--compatible=oracleはデータタイプをOracleタイプにマップしたり、Oracleコメント構文を使用したりしません。

--complete-insert, -c

カラム名を含んだ、完全なINSERTステートメントを使用します。

--compress, -C

双方が圧縮をサポートしている場合、クライアント・サーバ間で行きかう情報を全て圧縮します。

--create-options

MySQL独特のオプションをCREATE TABLEステートメントに含みます。

--databases, -B

複数のデータベースをダンプします。通常、mysqldumpはコマンドライン上の最初のアーギュメント名とそれに続く名をテーブル名として認識します。このオプションを使用するうことで、名前のついたアーギュメントを全てデータベース名として認識します。CREATE DATABASEやUSEステートメントは新しいデータベースの前の出力に含まれています。

--debug[=debug_options], -# [debug_options]

デバッグのログを書き込みます。debug_options文字列は大抵'd:t:o,file_name'になります。.'d:t:o,/tmp/mysqladmin.trace'がデフォルトになります。

--default-character-set=charset_name

charset_nameをデフォルトキャラクタセットとして使用します。項 「データおよびソート用キャラクタ セット」を参照してください。文字列が特定されていない場合、mysqldumpはutf8を使用します。

--delayed-insert

INSERTステートメントよりもINSERT DELAYEDステートメントを書き出します。

--delete-master-logs

マスタ複製サーバで、ダンプを実行後バイナリログを消去します。このオプションは自動的に--master-dataを有効化します。

--disable-keys, -K

各テーブルごとに、INSERTステートメントを/*!40000 ALTER TABLE tbl_name DISABLE KEYS */;と/*!40000 ALTER TABLE tbl_name ENABLE KEYS */;ステートメントで囲んでください。行が全て挿入された後にインデックスが作成されるため、ダンプファイルのロードが早くなります。このオプションはMyISAMテーブルに対してのみ効果的です。

--events, -E

ダンプされたデータベースからイベントをダンプします。このオプションはMySQL で追加されました。

--extended-insert, -e

複数のVALUESリストを含む、複数行INSERT構文を使用してください。これにより、ダンプファイルサイズを小さくし、ファイルが再ロードされる際の挿入スピードがあがります。

--fields-terminated-by=..., --fields-enclosed-by=..., --fields-optionally-enclosed-by=..., --fields-escaped-by=...

これらのオプションは-Tオプションと共に使用され、LOAD DATA INFILEに対応する節と同じ意味があります。項 「LOAD DATA INFILE 構文」 を参照してください。

--first-slave, -x

Deprecated.現在は--lock-all-tablesと名づけられています。

--flush-logs, -F

ダンプを始める前にMySQLサーバログファイルをフラッシュします。このオプションはRELOAD権限を要求します。このオプションを--all-databases (あるいは-A) オプションと併用した場合、ログはダンプされたデータベースごとにフラッシュされます。例外は、--lock-all-tablesまたは--master-dataを使用しているときです。この場合、ログは全てのテーブルがロックされた瞬間に一度だけフラッシュされます。ログのフラッシュとダンプを同時に行いたい場合、--flush-logsを--lock-all-tablesや--master-dataと併用してください。

--flush-privileges

mysqlデータベースのダンプ後、.FLUSH PRIVILEGESステートメントを発行してください。このオプションはダンプにmysqlデータベースが含まれている場合と、正しいリストアのためにmysqlデータベース内に含まれているデータに依存するデータベースが含まれている場合に使用するべきです。このオプションはMySQL で追加されました。

--force, -f

テーブルダンプの最中にSQLエラーが発生しても続行します。

このオプションの使用例を挙げると、mysqldumpに無効となったビューに遭遇しても続けて実行させることです。これは、定義が消去されたテーブルを参照するものだからです。--forceなしでは、mysqldumpはエラーメッセージを発し閉じます。--forceを使用した場合、mysqldumpエラーメッセージをプリントしますが、ダンプ出力のビュー定義を含むSQLコメントを書き出し、実行を続けます。

--host=host_name, -h host_name

与えられたホスト上でMySQLサーバからデータをダンプします。デフォルト設定では、localhostがホストになります。

--hex-blob

16進変換表記法を使用しているバイナリカラムをダンプします(例えば、'abc'は0x616263となります)。影響を受けるデータタイプはBINARY、VARBINARY、BLOB、そしてBITになります。

--ignore-table=db_name.tbl_name

データベースとテーブル名の両方を使用して特定されなければいけないテーブルをダンプしないでください。複数テーブルを無視するには、このオプションを複数回使用してください。

--insert-ignore

INSERTステートメントをIGNOREオプションで書いてください。

--lines-terminated-by=...

これらのオプションは-Tオプションと共に使用され、LOAD DATA INFILEに対応する節と同じ意味があります。項 「LOAD DATA INFILE 構文」 を参照してください。

--lock-all-tables, -x

データベース内のテーブルを全てロックします。これは全ダンプの期間、グローバルリードロックを取得することで達成されます。このオプションは自動的に--single-transactionと--lock-tablesをオフにします。

--lock-tables, -l

ダンプする前に全てのテーブルをロックします。テーブルはREAD LOCALでロックされ、これによりMyISAMテーブルの場合同時インサートが許容されます。InnoDBといったトランザクションテーブルには、--single-transactionはテーブルをロックする必要が無いため、はるかにいいオプションです。

複数データベースをダンプする際は、--lock-tablesは各データベースのテーブルを個別にロックします。よって、このオプションはダンプファイル内のテーブルがデータベース間で矛盾していないことを保証するわけではありません。異なるデータベース内のテーブルは完全に異なるステートでダンプされることがあります。

--master-data[=value]

出力にバイナリログファイル名とポジションを書きます。このオプションはRELOAD権限を要求し、バイナリログが有効化されていなければいけません。オプション値が1と等価の場合、ポジションとファイル名はダンプ出力に書き出され、CHANGE MASTERステートメントのフォームを取ります。ダンプがマスタサーバから行われ、それを利用してスレーブサーバをセットアップする場合、CHANGE MASTERステートメントはスレーブを、マスタのバイナリログ内の正しいポジションからスタートするようにします。オプション値が2と等価の場合、CHANGE MASTERステートメントはSQLコメントとして書かれます。(値が省かれていた場合のデフォルトアクションになります。)

--master-dataオプションは自動的に--lock-tablesをオフにします。--single-transactionも指定されていなければ、--lock-all-tablesをオンにもします(この場合、global read lockがダンプの最初に短い間、取得されています）。--single-transactionの説明も参照してください。どの場合でも、ログに対するアクションは全てダンプと同時に発生します。

--no-autocommit

各ダンプされたテーブルごとにINSERTステートメントをSET AUTOCOMMIT=0とCOMMIT ステートメントで囲みます。

--no-create-db, -n

このオプションは--databasesや--all-databasesオプションが提供されていた場合出力に含まれるCREATE DATABASEステートメントを抑制します。

--no-create-info, -t

各ダンプされたテーブルを再作成するCREATE TABLEステートメントを書かないでください。

--no-data, -d

テーブル行情報を書かないでください(つまりテーブル内容をダンプしないでください)。これはテーブルのCREATE TABLEステートメントのみをダンプしたい場合に非常に便利です。

--opt

このオプションはショートハンドです。--add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charsetを特定することと同じことです。速いダンプオプレーションを提供し、MySQLサーバにすばやく再ロードできるダンプファイルを生成します。

--optオプションはデフォルトで有効化されています。無効化するには--skip-optを使用してください。--optによって影響されるオプションの部分の一部を有効化・無効化する情報に関しては、このセクションの始めのディスカッションを参照してください。

--order-by-primary

各テーブルの行をプライマリキーか、存在する場合、最初のユニークインデックスでソートします。これは、InnoDBテーブルにロードするMyISAMテーブルをダンプしているときに便利ですが、ダンプに要する時間がかなり伸びます。

--password[=password], -p[password]

サーバに接続する際使用するパスワードです。ショートオプションフォーム(-p)を使用した場合、オプションとパスワードの間にスペースを置くことはできません。コマンドライン上で--password あるいは-pに続くオプションからpassword値を取り除いた場合、パスワード値を求められます。

コマンドライン上でのパスワードの特定は安全ではありません。項 「パスワードのセキュリティ」 を参照してください。

--port=port_num, -P port_num

コネクションに使用するTCP/IPポート番号です。

--protocol={TCP|SOCKET|PIPE|MEMORY}

使用するべき接続プロトコルです。

--quick, -q

このオプションは大きなテーブルのダンプに便利です。これにより、mysqldumpは全結果セットを取得、メモリ内でバッファ後表示といった一連の作業を一気にこなさず、サーバから１行ずつ結果を取得します。

--quote-names, -Q

‘`’文字でデータベース、テーブル、そしてカラム名をクオートします。ANSI_QUOTESSQLモードが有効化されている場合、名前は‘"’キャラクタでクオートされます。このオプションはデフォルトで有効となっています。--skip-quote-namesで無効化することもできますが、このオプションは--compatibleのような--quote-namesを有効化するオプションの後に与えられるべきです。

--replace

INSERTステートメントよりもREPLACEステートメントを書き出します。MySQL より提供されています。

--result-file=file, -r file

提供されているファイルに出力を導きます。このオプションはWindows上で‘\n’ニューライン文字が‘\r\n’carriage return/newlineシーケンスに変換されるのを阻止するために使用します。ダンプ生成中にエラーが発生しても、結果ファイルは作成され、内容は上書きされます。以前の内容は失われます。

--routines, -R

記憶されたルーチンを(関数とプロシージャ) ダンプされたデータベースからダンプします。.このオプションの使用はmysql.procテーブルのためのSELECT権限を要求します。--routinesを使用して生成された出力はルーチンの再作成のため、CREATE PROCEDUREとCREATE FUNCTIONステートメントを含んでいます。ただし、これらのステートメントはルーチン作成や改良タイムスタンプといった属性を含んでいません。つまりルーチンが再ロードされたとき、再ロードに要した時間と等価のタイムスタンプで作成されます。

ルーチンを元のタイムスタンプ属性で再作成しなければいけない場合、--routinesを使用しないでください。代わりに、mysqlデータベースの正しい権限を持っているMySQLアカウントを使用してmysql.procテーブルの内容を直接ダンプ、再ロードしてください。

このオプションはMySQL で追加されました。これ以前では、記憶されたルーチンはダンプされませんでした。ルーチンDEFINER値はMySQL までダンプされませんでした。つまり、5.1.8,以前でルーチンが再ロードされた場合、再ロードユーザにセットされたデファイナで作成されます。元のデファイナでルーチンを再作成しなければいけない場合、mysql.procテーブルの内容を、以前説明したとおりに、直接ダンプしロードしてください。

--set-charset

出力にSET NAMES default_character_setを追加してください。このオプションはデフォルトで有効となっています。SET NAMESステートメントを抑制するには、--skip-set-charsetを使用してください。

--single-transaction

このオプションはサーバからデータをダンプする前にBEGIN SQLステートメントを発行します。InnoDBといったトランザクションテーブルに対してのみ便利です。なぜなら、アプリケーションをブロックせずに、BEGINが発行された当時のデータベースの状態をダンプするからです。

このオプションを使用しているときは、一定の状態でダンプされるのはInnoDBテーブルのみだということを留意してください。例えば、このオプションを使用中にダンプされたMyISAMやMEMORYテーブルは状態が変化する可能性があります。

このオプションはMySQLクラスタテーブルではサポートされていません。NDBClusterストレージエンジンがREAD_COMMITTEDtransaction isolation levelのみをサポートするため、結果が一定である保証がありません。代わりに必ずNDBバックアップを使用し、リストアしてください。

--single-transactionオプションと--lock-tablesは互いに関連していません。これは、LOCK TABLESが待機中のトランザクションを必然的にコミットさせるからです。

大きなテーブルをダンプするには、このオプションを--quickと併用してください。

--skip-opt

--optオプションの詳細を参照してください。

--socket=path, -S path

localhostの接続用に使用する、ユニックスではソケットファイル、Windowsでは使用する名づけられたパイプ。

--skip-comments

--commentsオプションの詳細を参照してください。

--ssl*

--sslで始まるオプションは、SSLを介してサーバに接続し、SSL キーや証明の場所を明示するか否かを指定します。項3. 「SSL コマンド オプション」 を参照してください。

--tab=path, -T path

タブによって分けられたデータファイルを生成します。各ダンプされたテーブルごとに、mysqldumpはテーブルを作成するCREATE TABLEステートメントを含むtbl_name.sqlファイルと、そのデータを含むtbl_name.txtファイルを作成します。オプション値はファイルを書き込むディレクトリです。

デフォルトで、.txtデータファイルはカラム値と、各行の最後で新しいラインの間にタブキャラクタを使用してフォーマットされます。このフォーマットは明示的に--fields-xxxと--lines-terminated-byオプションを使用することで特定することができます。

注:このオプションはmysqldumpがmysqldサーバと同一のマシンで作動している場合のみ使用されるべきです。FILE権限を保持しており、サーバはユーザの指定してアファイルをディレクトリ内に書き込む権限を与えられていなければいけません。

--tables

--databasesあるいは-Bオプションをオーバーライドしてください。mysqldumpはオプションに続く名前アーギュメントをテーブル名として認識しています。

--triggers

ダンプされたテーブルごとにトリガをダンプします。このオプションはデフォルトで有効化されています。--skip-triggersを使用して無効化してください。

--tz-utc

ダンプファイルにSET TIME_ZONE='+00:00'を追加してください。これにより、TIMESTAMPカラムは異なるタイムゾーンにあるサーバ間でダンプ・再ロードされます。このオプションなしでは、TIMESTAMPカラムはソースとデスティネーションサーバのタイムゾーンにダンプ・再ロードされ、値が変わる場合があります。--tz-utcはサマータイムによる時間の変更に対してもプロテクトします。--tz-utcはデフォルトで有効化されています。無効化するには、--skip-tz-utcを使用してください。このオプションはMySQL で追加されました。

--user=user_name, -u user_name

サーバに接続する際使用するMySQLユーザ名です。

--verbose, -v

Verbose モードプログラムの動作についてさらに情報をプリントアウトする。

--version, -V

バージョン情報を表示し、閉じます。

--where='where_condition', -w 'where_condition'

あるWHERE状態に選択された行のみダンプします。ユーザのコマンドインタープリタにとって特別なキャラクタ、もしくはスペースを含んでいる場合、状態の周りをクオートで囲まなければいけません。

例：

--where="user='jimf'"
-w"userid>1"
-w"userid<1"

--xml, -X

ダンプ出力と、well-formed　XMLも書き出します。

NULL, 'NULL', and Empty Values:column_nameと名づけられたカラム、NULL値、空の文字列、文字値'NULL'はこのオプションによって生成された出力では以下の様に差別化します。

MySQL 5.1.12に始まり、--xmlオプションを使用しているときのmysqlクライアントもこれらのルールを守ります。（詳しくは項 「mysql オプション」をご確認ください。）

max_allowed_packet

クライアント･サーバ通信のバッファの最大サイズ最大は1GBです。

net_buffer_length

クライアント･サーバ通信のバッファの初期サイズ複数・行・挿入ステートメントを作成する際(--extended-insertや--optオプションを使用するとき)、mysqldump はnet_buffer_length長さの新しい行を作成します。この変数を増やした場合、MySQLサーバ内のnet_buffer_length変数も最低同じ大きさでなければいけません。