mydumper/docs/myloader_usage.rst
2017-03-24 11:42:13 +01:00

100 lines
2.2 KiB
ReStructuredText

Myloader Usage
==============
Synopsis
--------
:program:`myloader` :option:`--directory <myloader --directory>` = /path/to/mydumper/backup [:ref:`OPTIONS <myloader-options-label>`]
Description
-----------
:program:`myloader` is a tool used for multi-threaded restoration of mydumper
backups.
.. _myloader-options-label:
Options
-------
The :program:`myloader` tool has several available options:
.. program:: myloader
.. option:: --help, -?
Show help text
.. option:: --host, -h
Hostname of MySQL server to connect to (default localhost)
.. option:: --user, -u
MySQL username with the correct privileges to execute the restoration
.. option:: --password, -p
The corresponding password for the MySQL user
.. option:: --port, -P
The port for the MySQL connection.
.. note::
For localhost TCP connections use 127.0.0.1 for :option:`--host`.
.. option:: --socket, -S
The UNIX domain socket file to use for the connection
.. option:: --threads, -t
The number of threads to use for restoring data, default is 4
.. option:: --version, -V
Show the program version and exit
.. option:: --compress-protocol, -C
Use client protocol compression for connections to the MySQL server
.. option:: --directory, -d
The directory of the mydumper backup to restore
.. option:: --database, -B
An alternative database to load the dump into
.. note::
For use with single database dumps. When using with multi-database dumps
that have duplicate table names in more than one database it may cause
errors. Alternatively this scenario may give unpredictable results with
:option:`--overwrite-tables`.
.. option:: --source-db, -s
Database to restore, useful in combination with --database
.. option:: --queries-per-transaction, -q
Number of INSERT queries to execute per transaction during restore, default
is 1000.
.. option:: --overwrite-tables, -o
Drop any existing tables when restoring schemas
.. option:: --enable-binlog, -e
Log the data loading in the MySQL binary log if enabled (off by default)
.. option:: --verbose, -v
The verbosity of messages. 0 = silent, 1 = errors, 2 = warnings, 3 = info.
Default is 2.