"Fossies" - the Fresh Open Source Software Archive

Member "refman-8.0-en.man-gpl/ndbxfrm.1" (25 Oct 2021, 12244 Bytes) of package /linux/misc/mysql-refman/mysql-refman-8.0-en.man-gpl.tar.gz:

Caution: As a special service "Fossies" has tried to format the requested manual source page into HTML format but links to other man pages may be missing or even erroneous. Alternatively you can here view or download the uninterpreted manual source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.




ndbxfrm − compress, decompress, encrypt, and decrypt files created by NDB Cluster


ndbxfrm options filenames


The ndbxfrm utility, introduced in NDB 8.0.22, can be used to decompress, decrypt, and output information about files created by NDB Cluster that are compressed, encrypted, or both. It can also be used to compress or encrypt files.

Table 23.51. Command−line options used with the program ndbxfrm

ndbxfrm −−info file[ file ...]
ndbxfrm −−compress input_file output_file
ndbxfrm −−decrypt−password=password input_file output_file
ndbxfrm [−−encrypt−ldf−iter−count=#] −−encrypt−password=password input_file output_file

input_file and output_file cannot be the same file. Options

−−compress, −c Compresses the input file, using the same compression method as is used for compressing NDB Cluster backups, and writes the output to an output file. To decompress a compressed NDB backup file that is not encrypted, it is necessary only to invoke ndbxfrm using the names of the compressed file and an output file (with no options required).

−−decrypt−password=password Decrypts a file encrypted by NDB using the password supplied.

−−decrypt−password−from−stdin[=TRUE|FALSE] Decrypts a file encrypted by NDB, using a password supplied from standard input. This is similar to entering a password after invoking mysql −−password with no password following the option.


Read given file after global files are read.


Read default options from given file only.


Also read groups with concat(group, suffix).

−−encrypt−kdf−iter−count=#, −k # When encrypting a file, specifies the number of iterations to use for the encryption key. Requires the −−encrypt−password option.

−−encrypt−password=password Encrypts the backup file using the password supplied by the option. The password must meet the requirements listed here:

• Uses any of the printable ASCII characters except !, ', ", $, %, \, and ^

• Is no more than 256 characters in length

• Is enclosed by single or double quotation marks

It is possible but not recommended to use an empty password ('' or "").

−−encrypt−password−from−stdin[=TRUE|FALSE] Encrypts a file using a password supplied from standard input. This is similar to entering a password is entered after invoking mysql −−password with no password following the option.

−−help, −? Prints usage information for the program.

−−info, −i Prints the following information about one or more input files:

• The name of the file

• Whether the file is compressed (compression=yes or compression=no)

• Whether the file is encrypted (encryption=yes or encryption=no)


shell> ndbxfrm −i BACKUP−10−0.5.Data BACKUP−10.5.ctl BACKUP−10.5.log
File=BACKUP−10−0.5.Data, compression=no, encryption=yes
File=BACKUP−10.5.ctl, compression=no, encryption=yes
File=BACKUP−10.5.log, compression=no, encryption=yes


Read given path from login file.


Do not read default options from any option file other than login file.


Print program argument list and exit.

−−usage, −? Synonym for −−help.

−−version, −V Prints out version information.

ndbxfrm can encrypt backups created by any version of NDB Cluster. The .Data, .ctl, and .log files comprising the backup must be encrypted separately, and these files must be encrypted separately for each data node. Once encrypted, such backups can be decrypted only by ndbxfrm, ndb_restore, or ndb_print_backup from NDB Cluster 8.0.22 or later.

An encrypted file can be re−encrypted with a new password using the −−encrypt−password and −−decrypt−password options together, like this:

ndbxfrm −−decrypt−password=old −−encrypt−password=new input_file output_file

In the example just shown, old and new are the old and new passwords, respectively; both of these must be quoted. The input file is decrypted and then encrypted as the output file. The input file itself is not changed; if you do not want it to be accessible using the old password, you must remove the input file manually.


Copyright © 1997, 2021, Oracle and/or its affiliates.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.


For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/.


Oracle Corporation (http://dev.mysql.com/).