MySQL 8.0 Reference Manual Including MySQL NDB Cluster 8.0

23.4.31 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt Files Created by NDB Cluster

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

Format Description Added, Deprecated, or Removed

--compress,

-c

Compress file

ADDED: NDB 8.0.22

--decrypt-password=string

Use this password to decrypt file

ADDED: NDB 8.0.22

--decrypt-password-from-stdin[=value]

Get decryption password in a secure fashion from STDIN

ADDED: NDB 8.0.24

--encrypt-kdf-iter-count=#,

-k

Number of iterations used in key definition

ADDED: NDB 8.0.22

--encrypt-password=string

Use this password to encrypt file

ADDED: NDB 8.0.22

--encrypt-password-from-stdin[=value]

Get encryption password in a secure fashion from STDIN

ADDED: NDB 8.0.24

--help,

-?

Print usage information

ADDED: NDB 8.0.22

--info,

-i

Print file information

ADDED: NDB 8.0.22

--usage,

-?

Prints usage information; synonym for --help

ADDED: NDB 8.0.22

--version,

-V

Output version information

ADDED: NDB 8.0.22


Usage

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

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.

ndbxfrm does not take any of the options shown in Section 23.4.32, “Options Common to NDB Cluster Programs — Options Common to NDB Cluster Programs”, other than those explicitly listed in this section (that is, --help, --usage, and --version).