MySQL Internals Manual
Section Navigation [Toggle]
- MySQL Internals Manual
- Preface and Legal Notice
- 1 A Guided Tour Of The MySQL Source Code
- 2 Coding Guidelines
- 3 Reusable Classes and Templates
- 4 How to Build MySQL Server with CMake
- 5 Autotools to CMake Transition Guide
- 6 Plugins
- 7 Transaction Handling in the Server
- 8 The Optimizer
- 9 Tracing the Optimizer
- 10 Memory Allocation
- 11 Important Algorithms and Structures
- 12 File Formats
- 13 How MySQL Performs Different Selects
- 14 How MySQL Transforms Subqueries
- 15 MySQL Client/Server Protocol
- 16 Stored Programs
- 17 Prepared Statement and Stored Routine Re-Execution
- 18 Writing a Procedure
- 19 Replication
- 20 The Binary Log
- 21 MySQL Backup
- 22 MyISAM Storage Engine
- 23 InnoDB Storage Engine
- 24 Writing a Custom Storage Engine
- 25 Test Synchronization
- 26 Injecting Test Faults
- 27 How to Create Good Test Cases
- 28 Porting to Other Systems
- 29 Error Messages
- A MySQL Source Code Distribution
- B InnoDB Source Code Distribution
- Index
Abstract
This is the MySQL Internals Manual.
Document generated on: 2013-06-05 (revision: 77)
For legal information, see the Legal Notice.
Table of Contents [+/-]
- 1.1. Getting the Source Tree
- 1.2. The Major Directories [+/-]
- 1.3. The Flow
- 1.4. The Open-Source Directories
- 1.5. The Internal and External Storage Engine Directories
- 1.6. The OS-Specific Directories
- 1.7. Odds and Ends
- 1.8. A Chunk of Code in
/sql/sql_update.cc - 1.9. The Skeleton of the Server Code
- 1.10. Recap
- 2.1. General Development Guidelines [+/-]
- 2.1.1. C/C++ Coding Guidelines of MySQL Server
- 2.1.2. How we maintain the server coding guidelines
- 2.1.3. Indentation and Spacing
- 2.1.4. Naming Conventions
- 2.1.5. Commenting Code
- 2.1.6. Header Files
- 2.1.7. Additional suggestions
- 2.1.8. Suggested mode in
emacs - 2.1.9. Basic
vimsetup - 2.1.10. Another
vimsetup - 2.1.11. An example setup for
ctags
- 2.2. C++ Coding Guidelines for the NDB Storage Engine [+/-]
- 2.3. DBUG Tags
- 6.1. CMake Variables to Control Plugin Building (MySQL 5.5 and Later)
- 6.2. CMake Macro to Define the Plugin
- 6.3. Autotools configure Support (MySQL 5.1)
- 6.4. Autotools Plugin Macros
- 6.5. Specifying
mysqldVariables Within a Plugin - 6.6. Additional Accessors for Plugins
- 6.7. MySQL Services for Plugins [+/-]
- 9.1. Typical Usage
- 9.2. System Variables Controlling the Trace
- 9.3. The
INFORMATION_SCHEMA.OPTIMIZER_TRACETable - 9.4. Traceable Queries
- 9.5. Automatic Trace Purging
- 9.6. Tuning Trace Purging
- 9.7. Tracing Memory Usage
- 9.8. Privilege Checking
- 9.9. Interaction with the --debug Option
- 9.10. The
optimizer_traceSystem Variable - 9.11. The
end_markers_in_jsonSystem Variable - 9.12. Selecting Optimizer Features to Trace
- 9.13. General Trace Structure
- 9.14. Example
- 9.15. Nicely Displaying a Trace
- 9.16. Preventing Use of Optimizer Trace
- 9.17. Testing
- 9.18. Implementation
- 11.1. The
ItemClass - 11.2. How MySQL Does Sorting (
filesort) - 11.3. Bulk Insert
- 11.4. How MySQL Does Caching
- 11.5. How MySQL Uses the Join Buffer Cache
- 11.6. How MySQL Handles
FLUSH TABLES - 11.7. Full-Text Search
- 11.8.
FLOATandDOUBLEData Type Representation - 11.9. Date and Time Data Type Representation
- 11.10. Threads
- 11.11. Character Sets and Collations
- 11.12. Error Flags and Functions
- 11.13. Functions in the
mysysLibrary - 11.14. Bitmaps
- 15.1. Overview [+/-]
- 15.2. Connection Phase [+/-]
- 15.3. Authentication Method [+/-]
- 15.4. Compression [+/-]
- 15.5. SSL
- 15.6. Text Protocol [+/-]
- 15.6.1. COM_SLEEP
- 15.6.2. COM_QUIT
- 15.6.3. COM_INIT_DB
- 15.6.4. COM_QUERY
- 15.6.5. COM_FIELD_LIST
- 15.6.6. COM_CREATE_DB
- 15.6.7. COM_DROP_DB
- 15.6.8. COM_REFRESH
- 15.6.9. COM_SHUTDOWN
- 15.6.10. COM_STATISTICS
- 15.6.11. COM_PROCESS_INFO
- 15.6.12. COM_CONNECT
- 15.6.13. COM_PROCESS_KILL
- 15.6.14. COM_DEBUG
- 15.6.15. COM_PING
- 15.6.16. COM_TIME
- 15.6.17. COM_DELAYED_INSERT
- 15.6.18. COM_CHANGE_USER
- 15.6.19. COM_DAEMON
- 15.7. Prepared Statements [+/-]
- 15.8. Stored Procedures [+/-]
- 15.9. Replication Protocol [+/-]
- 15.10. Row Based Replication [+/-]
- 15.11. Semi-Sync Replication [+/-]
- 15.12. Protocol Examples [+/-]
- 15.13. Source Code Locations [+/-]
- 20.1. Binary Log Overview
- 20.2. High-Level Binary Log Structure and Contents
- 20.3. Source Files Related to the Binary Log [+/-]
- 20.4. Generating Browsable Binary Log Information
- 20.5. Event Classes and Types [+/-]
- 20.6. Event Meanings
- 20.7. Event Structure [+/-]
- 20.8. Binary Log Versions [+/-]
- 20.9. Event Data for Specific Event Types [+/-]
- 20.10. Row-Based Binary Logging
- 20.11. Additional Resources
- 21.1. Glossary
- 21.2. Architectural Design & APIs [+/-]
- 21.3. Backup Engines and Drivers [+/-]
- 21.3.1. Stub for WL#3570 material (Default algorithm backup & restore (blocking))
- 21.3.2. Stub for WL#3776 material (Consistent snapshot backup for MVCC)
- 21.3.3. Stub for WL#866 material (Online backup: MyISAM native driver (redo-log algorithm, modify source file, log byte changes))
- 21.3.4. Stub for WL#4064 material (Online Backup: Adapt native MyISAM driver to new kernel architecture)
- 21.3.5. Stub for WL#4205 material (Online Backup: modify kernel to use object services API)
- 21.4. Stub for WL#3576 material (synchronization with binary log)
- 21.5. Stub for WL#4060 material (kernel updates)
- 21.6. Stub for WL#4062 material (DDL blocker, A.K.A metadata freeze)
- 21.7. Stub for WL#3956 material (commit blocker)
- 21.8. Error Handling [+/-]
- 21.9. Testing [+/-]
- 21.10. Data Formats [+/-]
MyISAM Storage Engine [+/-]InnoDB Storage Engine [+/-]- 24.1. Additional Resources
- 24.2. Overview
- 24.3. Creating Storage Engine Source Files
- 24.4. Adding Engine Specific Variables and Parameters
- 24.5. Creating the
handlerton - 24.6. Handling Handler Instantiation
- 24.7. Defining Filename Extensions
- 24.8. Creating Tables
- 24.9. Opening a Table
- 24.10. Implementing Basic Table Scanning [+/-]
- 24.11. Closing a Table
- 24.12. Adding Support for
INSERTto a Storage Engine - 24.13. Adding Support for
UPDATEto a Storage Engine - 24.14. Adding Support for
DELETEto a Storage Engine - 24.15. Supporting Non-Sequential Reads [+/-]
- 24.16. Supporting Indexing [+/-]
- 24.16.1. Indexing Overview
- 24.16.2. Getting Index Information During
CREATE TABLEOperations - 24.16.3. Creating Index Keys
- 24.16.4. Parsing Key Information
- 24.16.5. Providing Index Information to the Optimizer
- 24.16.6. Preparing for Index Use with
index_init() - 24.16.7. Cleaning up with
index_end() - 24.16.8. Implementing the
index_read()Method - 24.16.9. Implementing the
index_read_idx()Method - 24.16.10. Implementing the
index_read_last()Method - 24.16.11. Implementing the
index_next()Method - 24.16.12. Implementing the
index_prev()Method - 24.16.13. Implementing the
index_first()Method - 24.16.14. Implementing the
index_last()Method
- 24.17. Supporting Transactions [+/-]
- 24.18. API Reference [+/-]
- 24.18.1. bas_ext
- 24.18.2. close
- 24.18.3. create
- 24.18.4. delete_row
- 24.18.5. delete_table
- 24.18.6. external_lock
- 24.18.7. extra
- 24.18.8. index_end
- 24.18.9. index_first
- 24.18.10. index_init
- 24.18.11. index_last
- 24.18.12. index_next
- 24.18.13. index_prev
- 24.18.14. index_read
- 24.18.15. index_read_idx
- 24.18.16. index_read_last
- 24.18.17. info
- 24.18.18. open
- 24.18.19. position
- 24.18.20. records_in_range
- 24.18.21. rnd_init
- 24.18.22. rnd_next
- 24.18.23. rnd_pos
- 24.18.24. start_stmt
- 24.18.25. store_lock
- 24.18.26. update_row
- 24.18.27. write_row
- 24.19. FAQ
- 27.1. Formal Stuff [+/-]
- 27.2. Comments Everywhere [+/-]
- 27.3. Some Rules Outside of the Formal Stuff [+/-]
- 27.4. “Negative” Tests
- 27.5. Tests with Several Variants [+/-]
- 27.6. Miscellaneous Tips [+/-]
- 27.6.1. Stability Checks for Random Timing Problems
- 27.6.2. Stability Checks for Hostname-Related Problems
- 27.6.3. Stability Checks for Unexpected Problems
- 27.6.4. Row Order Within Result Sets
- 27.6.5. Test Case Behavior Should Depend on the Result of a
SHOW - 27.6.6. Does a Test Execution Hang?
- 27.6.7. If Your Test is Complicated, Support Debugging
- 27.6.8. You Need to Know Some Syntax, an Option, Etc., but Hate Reading Manuals
- 27.7. Notes on MTR2
- 27.8. Examples of “Suspicious” Tests and Scripts [+/-]
- A.1. Directory Listing [+/-]
- A.1.1. The
BUILDDirectory - A.1.2. The
clientDirectory - A.1.3. The
configDirectory - A.1.4. The
cmd-line-utilsDirectory - A.1.5. The
dbugDirectory - A.1.6. The
DocsDirectory - A.1.7. The
extraDirectory - A.1.8. The
heapDirectory - A.1.9. The
includeDirectory - A.1.10. The
innobaseDirectory - A.1.11. The
libmysqlDirectory - A.1.12. The
libmysql_rDirectory - A.1.13. The
libmysqldDirectory - A.1.14. The
manDirectory - A.1.15. The
myisamDirectory - A.1.16. The
myisammrgDirectory - A.1.17. The
mysql-testDirectory - A.1.18. The
mysysDirectory - A.1.19. The
ndbDirectory - A.1.20. The
netwareDirectory - A.1.21. The
NEW-RPMSDirectory - A.1.22. The
os2Directory - A.1.23. The
pstackDirectory - A.1.24. The
regexDirectory - A.1.25. The
SCCSDirectory - A.1.26. The
scriptsDirectory - A.1.27. The
server-toolsDirectory - A.1.28. The
sqlDirectory - A.1.29. The
sql-benchDirectory - A.1.30. The
sql-commonDirectory - A.1.31. The
SSLDirectory - A.1.32. The
stringsDirectory - A.1.33. The
support-filesDirectory - A.1.34. The
testsDirectory - A.1.35. The
toolsDirectory - A.1.36. The
VC++FilesDirectory - A.1.37. The
vioDirectory - A.1.38. The
zlibDirectory
- A.1.1. The
InnoDB Source Code Distribution
Copyright © 1997, 2012, Oracle and/or its affiliates. All
rights reserved.
Legal Notices
