The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
ndctl-read-labels – read out the label area on a dimm or set of dimms Synopsisndctl read-labels <nmem0> [<nmem1>..<nmemN>] [<options>]DescriptionThe namespace label area is a small persistent partition of capacity available on some NVDIMM devices. The label area is used to resolve aliasing between pmem and blk capacity by lineating namespace boundaries. This command dumps the…
ndctl-list – dump the platform nvdimm device topology and attributes in json Synopsisndctl list [<options>]Walk all the nvdimm buses in the system and list all attached devices along with some of their major attributes. Options can be specified to limit the output to devices of a certain class. Where the classes are buses, dimms, regions,…
ndctl-enable-region – enable the given region(s) and all descendant namespaces Synopsisndctl enable-region <region> [<options>]DescriptionA generic REGION device is registered for each PMEM range or BLK-aperture set. LIBNVDIMM provides a built-in driver for these REGION devices. This driver is responsible for reconciling the aliased DPA mappings across all regions, parsing the LABEL, if present, and then…
ndctl-enable-namespace – enable the given namespace(s) Synopsisndctl enable-namespace <namespace> [<options>]DescriptionA REGION, after resolving DPA aliasing and LABEL specified boundaries, surfaces one or more "namespace" devices. The arrival of a "namespace" device currently triggers either the nd_blk or nd_pmem driver to load and register a disk/block device. Options<namespace> A namespaceX.Y device name. The keyword all can…
ndctl-disable-region – disable the given region(s) and all descendant namespaces Synopsisndctl disable-region <region> [<options>]DescriptionA generic REGION device is registered for each PMEM range or BLK-aperture set. LIBNVDIMM provides a built-in driver for these REGION devices. This driver is responsible for reconciling the aliased DPA mappings across all regions, parsing the LABEL, if present, and then…
ndctl-disable-namespace – disable the given namespace(s) Synopsisndctl disable-namespace <namespace> [<options>]DescriptionA REGION, after resolving DPA aliasing and LABEL specified boundaries, surfaces one or more "namespace" devices. The arrival of a "namespace" device currently triggers either the nd_blk or nd_pmem driver to load and register a disk/block device. Options<namespace> A namespaceX.Y device name. The keyword all can…
ndctl-destroy-namespace – destroy the given namespace(s) Synopsisndctl destroy-namespace <namespace> [<options>]DescriptionA REGION, after resolving DPA aliasing and LABEL specified boundaries, surfaces one or more "namespace" devices. The arrival of a "namespace" device currently triggers either the nd_blk or nd_pmem driver to load and register a disk/block device. Options<namespace> A namespaceX.Y device name. The keyword all can…
ndctl-create-namespace – provision or reconfigure a namespace Synopsisndctl create-namespace [<options>]DescriptionA REGION, after resolving DPA aliasing and LABEL specified boundaries, surfaces one or more "namespace" devices. The arrival of a "namespace" device currently triggers either the nd_blk or nd_pmem driver to load and register a disk/block device. ExamplesCreate a maximally sized pmem namespace in memory mode…
ndbd_redo_log_reader – check and print content of cluster redo log Synopsis ndbd_redo_log_reader file_name [options]DescriptionReads a redo log file, checking it for errors, printing its contents in a human-readable format, or both. ndbd_redo_log_reader is intended for use primarily by MySQL developers and support personnel in debugging and diagnosing problems. This utility was made available as part…
ndb_waiter – wait for MySQL Cluster to reach a given status Synopsis ndb_waiter optionsDescriptionndb_waiter repeatedly (each 100 milliseconds) prints out the status of all cluster data nodes until either the cluster reaches a given status or the –timeout limit is exceeded, then exits. By default, it waits for the cluster to achieve STARTED status, in…
ndb_show_tables – display list of NDB tables Synopsis ndb_show_tables [options]Descriptionndb_show_tables displays a list of all NDB database objects in the cluster. By default, this includes not only both user-created tables and NDB system tables, but NDB-specific indexes, internal triggers, and MySQL Cluster Disk Data objects as well. The following table includes options that are specific…
ndb_select_all – print rows from an NDB table Synopsis ndb_select_all -c connect_stringtbl_name -d db_name [> file_name]Descriptionndb_select_all prints all rows from an NDB table to stdout. Usage: ndb_select_all -c connect_string tbl_name -d db_name [> file_name] Additional Options: * –lock=lock_type, -l lock_type Employs a lock when reading the table. Possible values for lock_type are: * 0: Read…
ndb_restore – restore a MySQL Cluster backup Synopsis ndb_restore optionsDescriptionThe cluster restoration program is implemented as a separate command-line utility ndb_restore, which can normally be found in the MySQL bin directory. This program reads the files created as a result of the backup and inserts the stored information into the database. ndb_restore must be executed…
ndb_print_sys_file – print NDB system file contents Synopsis ndb_print_sys_file file_nameDescriptionndb_print_sys_file obtains diagnostic information from a MySQL Cluster system file. Usage: ndb_print_sys_file file_name file_name is the name of a cluster system file (sysfile). Cluster system files are located in a data node’s data directory (DataDir); the path under this directory to system files matches the pattern…
ndb_print_schema_file – print NDB schema file contents Synopsis ndb_print_schema_file file_nameDescriptionndb_print_schema_file obtains diagnostic information from a cluster schema file. Usage: ndb_print_schema_file file_name file_name is the name of a cluster schema file. For more information about cluster schema files, see m[blue]Cluster Data Node FileSystemDir Filesm[][1]. Like ndb_print_backup_file and ndb_print_sys_file (and unlike most of the other NDB utilities…
ndb_print_backup_file – print NDB backup file contents Synopsis ndb_print_backup_file file_nameDescriptionndb_print_backup_file obtains diagnostic information from a cluster backup file. Usage: ndb_print_backup_file file_name file_name is the name of a cluster backup file. This can be any of the files (.Data, .ctl, or .log file) found in a cluster backup directory. These files are found in the data…
ndb_mgm – the MySQL Cluster management client Synopsis ndb_mgm optionsDescriptionThe ndb_mgm management client process is actually not needed to run the cluster. Its value lies in providing a set of commands for checking the cluster’s status, starting backups, and performing other administrative functions. The management client accesses the management server using a C API. Advanced…
ndb_error_reporter – NDB error-reporting utility Synopsis ndb_error_reporter optionsDescriptionndb_error_reporter creates an archive from data node and management node log files that can be used to help diagnose bugs or other problems with a cluster. It is highly recommended that you make use of this utility when filing reports of bugs in MySQL Cluster. Usage: ndb_error_reporter path/to/config-file…
ndb_drop_table – drop an NDB table Synopsis ndb_drop_table optionsDescriptionndb_drop_table drops the specified NDB table. (If you try to use this on a table created with a storage engine other than NDB, it fails with the error 723: No such table exists.) This operation is extremely fast — in some cases, it can be an order…
ndb_drop_index – drop index from an NDB table Synopsis ndb_drop_index optionsDescriptionndb_drop_index drops the specified index from an NDB table. It is recommended that you use this utility only as an example for writing NDB API applications — see the Warning later in this section for details. Usage: ndb_drop_index -c connect_string table_name index -d db_name The…