Thursday, 13 December 2007

Documentation: MySQL Server Version Reference

Stefan Hinz, MySQL's Docs Team Lead, just showed me the new restructured documentation overview page The intention of the restructuring is to make it easier for you to find the information you need.

We've amended the MySQL Reference Manual section with a subsection labeled "Excerpts from the Reference Manual", examples of which are a standalone Connectors book (covering all MySQL connectors and APIs) and guides for each individual MySQL Connector.

The key new document there is the "MySQL Server Version Reference" that should make life easier for everyone who needs cross-version information. It's available for download but you can also browse it online at

Here's an overview of the MySQL Server Version Reference document:

  1. The mysqld Options/Variables Reference contains all MySQL server options and variables for all MySQL versions. You can easily find out whether or not a particular option is available in a specific MySQL version, when it was introduced or deprecated, and more. For variables, that chapter gives a quick overview of core properties, such as if it's a status or a server system variable, if I can be changed dynamically, or if the scope is global or local.

  2. The Reserved Words list contains all words reserved in a particular MySQL (major) version, with annotations about minor versions. The list is created by running a script against all MySQL versions starting from 4.1.0. (Yes, our Docs Team has installed all MySQL versions on their documentation machine!)

  3. The Functions and Operators chapter shows which MySQL functions are available in which version, and when they were introduced or deprecated.

  4. The Build (configure) Options chapter should be useful for anyone building MySQL from source.

  5. Eventually, the Key changes in MySQL releases chapter lists security fixes and incompatible changes for the GA versions of MySQL 4.1 and 5.0 and for the beta and RC versions of MySQL 5.1.

The Server Version Reference is not a static document but is being recreated on a regular basis.

Kudos go to Martin C. Brown who created all this. We hope it will make your work with MySQL more productive and enjoyable!


No comments:

Post a comment