MySQL NDB Cluster Internals Manual

Abstract

This is the MySQL NDB Cluster Internals Manual, which contains information about the NDBCLUSTER storage engine that is not strictly necessary for running the NDB Cluster product, but can prove useful for development and debugging purposes. Topics covered in this Guide include, among others, communication protocols employed between nodes, file systems used by management nodes and data nodes, error messages, and debugging (DUMP) commands in the management client.

The information presented in this guide is current for recent releases of NDB Cluster 8.0 up to and including NDB Cluster 8.0.35, as well as the NDB Cluster 8.3 (8.3.0) Innovation release. Due to significant functional and other changes in NDB Cluster and its underlying APIs, you should not expect this information to apply to previous releases of the NDB Cluster software prior to NDB Cluster 7.5. Users of older NDB Cluster releases should upgrade to the latest available release of NDB Cluster 8.0, which is the most recent GA release series, or to the NDB Cluster 8.3 Innovation release.

For more information about NDB Cluster 8.0, see What is New in MySQL NDB Cluster 8.0. For information about NDB Cluster 8.3, see https://dev.mysql.com/doc/refman/8.3/en/mysql-cluster-what-is-new.html.

For legal information, see the Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Licensing information—NDB APIs.  If you are using the NDB APIs with a Commercial release of MySQL NDB Cluster, see the MySQL NDB Cluster 8.0 Commercial Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Commercial release. If you are using the NDB APIs with a Community release of MySQL NDB Cluster, see the MySQL NDB Cluster 8.0 Community Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Licensing information—MySQL NDB Cluster 8.3.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL NDB Cluster 8.3, see the MySQL NDB Cluster 8.3 Commercial Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Commercial release. If you are using a Community release of MySQL NDB Cluster 8.3, see the MySQL NDB Cluster 8.3 Community Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Licensing information—MySQL NDB Cluster 8.0.  This product may include third-party software, used under license. If you are using a Commercial release of MySQL NDB Cluster 8.0, see the MySQL NDB Cluster 8.0 Commercial Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Commercial release. If you are using a Community release of MySQL NDB Cluster 8.0, see the MySQL NDB Cluster 8.0 Community Release License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2024-03-18 (revision: 78098)

Table of Contents

Preface and Legal Notices
1 NDB Cluster File Systems
1.1 NDB Cluster Data Node File System
1.1.1 NDB Cluster Data Node Data Directory Files
1.1.2 NDB Cluster Data Node File System Directory
1.1.3 NDB Cluster Data Node Backup Data Directory
1.1.4 Files Used by NDB Cluster Disk Data Tables
1.2 NDB Cluster Management Node File System
2 NDB Cluster Management Client DUMP Commands
2.1 DUMP 1
2.2 DUMP 13
2.3 DUMP 14
2.4 DUMP 15
2.5 DUMP 16
2.6 DUMP 17
2.7 DUMP 18
2.8 DUMP 19
2.9 DUMP 20
2.10 DUMP 21
2.11 DUMP 22
2.12 DUMP 23
2.13 DUMP 24
2.14 DUMP 25
2.15 DUMP 70
2.16 DUMP 400
2.17 DUMP 401
2.18 DUMP 402
2.19 DUMP 403
2.20 DUMP 406
2.21 DUMP 502
2.22 DUMP 503
2.23 DUMP 504
2.24 DUMP 505
2.25 DUMP 506
2.26 DUMP 908
2.27 DUMP 935
2.28 DUMP 1000
2.29 DUMP 1001
2.30 DUMP 1223
2.31 DUMP 1224
2.32 DUMP 1225
2.33 DUMP 1226
2.34 DUMP 1228
2.35 DUMP 1229
2.36 DUMP 1332
2.37 DUMP 1333
2.38 DUMP 2300
2.39 DUMP 2301
2.40 DUMP 2302
2.41 DUMP 2303
2.42 DUMP 2304
2.43 DUMP 2305
2.44 DUMP 2308
2.45 DUMP 2315
2.46 DUMP 2350
2.47 DUMP 2352
2.48 DUMP 2353
2.49 DUMP 2354
2.50 DUMP 2355
2.51 DUMP 2356
2.52 DUMP 2357
2.53 DUMP 2398
2.54 DUMP 2399
2.55 DUMP 2400
2.56 DUMP 2401
2.57 DUMP 2402
2.58 DUMP 2403
2.59 DUMP 2404
2.60 DUMP 2405
2.61 DUMP 2406
2.62 DUMP 2500
2.63 DUMP 2501
2.64 DUMP 2502
2.65 DUMP 2503 (OBSOLETE)
2.66 DUMP 2504
2.67 DUMP 2505
2.68 DUMP 2506 (OBSOLETE)
2.69 DUMP 2507
2.70 DUMP 2508
2.71 DUMP 2512
2.72 DUMP 2513
2.73 DUMP 2514
2.74 DUMP 2515
2.75 DUMP 2516
2.76 DUMP 2517
2.77 DUMP 2550
2.78 DUMP 2553
2.79 DUMP 2554
2.80 DUMP 2555
2.81 DUMP 2556
2.82 DUMP 2557
2.83 DUMP 2600
2.84 DUMP 2601
2.85 DUMP 2602
2.86 DUMP 2603
2.87 DUMP 2604
2.88 DUMP 2605
2.89 DUMP 2606
2.90 DUMP 2607
2.91 DUMP 2608
2.92 DUMP 2609
2.93 DUMP 2610
2.94 DUMP 2611
2.95 DUMP 2612
2.96 DUMP 4000
2.97 DUMP 4001
2.98 DUMP 5900
2.99 DUMP 7000
2.100 DUMP 7001
2.101 DUMP 7002
2.102 DUMP 7003
2.103 DUMP 7004
2.104 DUMP 7005
2.105 DUMP 7006
2.106 DUMP 7007
2.107 DUMP 7008
2.108 DUMP 7009
2.109 DUMP 7010
2.110 DUMP 7011
2.111 DUMP 7012
2.112 DUMP 7013
2.113 DUMP 7014
2.114 DUMP 7015
2.115 DUMP 7016
2.116 DUMP 7017
2.117 DUMP 7018
2.118 DUMP 7019
2.119 DUMP 7020
2.120 DUMP 7021
2.121 DUMP 7022
2.122 DUMP 7023
2.123 DUMP 7024
2.124 DUMP 7026
2.125 DUMP 7027
2.126 DUMP 7032
2.127 DUMP 7033
2.128 DUMP 7034
2.129 DUMP 7080
2.130 DUMP 7090
2.131 DUMP 7099
2.132 DUMP 8004
2.133 DUMP 8005
2.134 DUMP 8010
2.135 DUMP 8011
2.136 DUMP 8013
2.137 DUMP 9800
2.138 DUMP 9801
2.139 DUMP 9988
2.140 DUMP 9989
2.141 DUMP 9992
2.142 DUMP 9993
2.143 DUMP 10000
2.144 DUMP 10001
2.145 DUMP 10002
2.146 DUMP 10003
2.147 DUMP 11000
2.148 DUMP 11001
2.149 DUMP 12001
2.150 DUMP 12002
2.151 DUMP 12009
2.152 DUMP 103003
2.153 DUMP 103004
2.154 DUMP 103005
2.155 DUMP 13000
2.156 DUMP 130001
2.157 DUMP 13002
2.158 DUMP 13003
2.159 DUMP 14000
2.160 DUMP 14001
2.161 DUMP 14002
2.162 DUMP 14003
2.163 DUMP 30000
2.164 DUMP 100000
2.165 DUMP 100001
2.166 DUMP 100002
2.167 DUMP 100003
2.168 DUMP 100004
2.169 DUMP 100005
2.170 DUMP 100006
2.171 DUMP 100007
2.172 DUMP 100999
2.173 DUMP 101000
2.174 DUMP 101999
2.175 DUMP 102000
2.176 DUMP 102999
2.177 DUMP 103000
2.178 DUMP 103001
2.179 DUMP 103002
2.180 DUMP 104000
2.181 DUMP 104001
2.182 DUMP 104002
2.183 DUMP 104003
2.184 DUMP 104004
3 The NDB Communication Protocol
3.1 NDB Protocol Overview
3.2 NDB Protocol Messages
3.3 Operations and Signals
4 NDB Kernel Blocks
4.1 The BACKUP Block
4.2 The CMVMI Block
4.3 The DBACC Block
4.4 The DBDICT Block
4.5 The DBDIH Block
4.6 The DBINFO Block
4.7 The DBLQH Block
4.8 The DBSPJ Block
4.9 The DBTC Block
4.10 The DBTUP Block
4.11 The DBTUX Block
4.12 The DBUTIL Block
4.13 The LGMAN Block
4.14 The NDBCNTR Block
4.15 The NDBFS Block
4.16 The PGMAN Block
4.17 The QMGR Block
4.18 The RESTORE Block
4.19 The SUMA Block
4.20 The THRMAN Block
4.21 The TRPMAN Block
4.22 The TSMAN Block
4.23 The TRIX Block
5 NDB Cluster Start Phases
5.1 Initialization Phase (Phase -1)
5.2 Configuration Read Phase (STTOR Phase -1)
5.3 STTOR Phase 0
5.4 STTOR Phase 1
5.5 STTOR Phase 2
5.6 NDB_STTOR Phase 1
5.7 STTOR Phase 3
5.8 NDB_STTOR Phase 2
5.9 STTOR Phase 4
5.10 NDB_STTOR Phase 3
5.11 STTOR Phase 5
5.12 NDB_STTOR Phase 4
5.13 NDB_STTOR Phase 5
5.14 NDB_STTOR Phase 6
5.15 STTOR Phase 6
5.16 STTOR Phase 7
5.17 STTOR Phase 8
5.18 NDB_STTOR Phase 7
5.19 STTOR Phase 9
5.20 STTOR Phase 101
5.21 System Restart Handling in Phase 4
5.22 START_MEREQ Handling
6 NDB Schema Object Versions
7 NDB Cluster API Errors
7.1 Data Node Error Messages
7.1.1 ndbd Error Classifications
7.1.2 ndbd Error Codes
7.2 NDB Transporter Errors
A NDB Internals Glossary
Index