js/doclinks.js

   1 /**
   2  * Definition of links to MySQL documentation.
   3  */
   4
   5 var mysql_doc_keyword = {
   6     /* Multi word */
   7     'CHARACTER SET': Array('charset'),
   8     'SHOW AUTHORS': Array('show-authors'),
   9     'SHOW BINARY LOGS': Array('show-binary-logs'),
  10     'SHOW BINLOG EVENTS': Array('show-binlog-events'),
  11     'SHOW CHARACTER SET': Array('show-character-set'),
  12     'SHOW COLLATION': Array('show-collation'),
  13     'SHOW COLUMNS': Array('show-columns'),
  14     'SHOW CONTRIBUTORS': Array('show-contributors'),
  15     'SHOW CREATE DATABASE': Array('show-create-database'),
  16     'SHOW CREATE EVENT': Array('show-create-event'),
  17     'SHOW CREATE FUNCTION': Array('show-create-function'),
  18     'SHOW CREATE PROCEDURE': Array('show-create-procedure'),
  19     'SHOW CREATE TABLE': Array('show-create-table'),
  20     'SHOW CREATE TRIGGER': Array('show-create-trigger'),
  21     'SHOW CREATE VIEW': Array('show-create-view'),
  22     'SHOW DATABASES': Array('show-databases'),
  23     'SHOW ENGINE': Array('show-engine'),
  24     'SHOW ENGINES': Array('show-engines'),
  25     'SHOW ERRORS': Array('show-errors'),
  26     'SHOW EVENTS': Array('show-events'),
  27     'SHOW FUNCTION CODE': Array('show-function-code'),
  28     'SHOW FUNCTION STATUS': Array('show-function-status'),
  29     'SHOW GRANTS': Array('show-grants'),
  30     'SHOW INDEX': Array('show-index'),
  31     'SHOW MASTER STATUS': Array('show-master-status'),
  32     'SHOW OPEN TABLES': Array('show-open-tables'),
  33     'SHOW PLUGINS': Array('show-plugins'),
  34     'SHOW PRIVILEGES': Array('show-privileges'),
  35     'SHOW PROCEDURE CODE': Array('show-procedure-code'),
  36     'SHOW PROCEDURE STATUS': Array('show-procedure-status'),
  37     'SHOW PROCESSLIST': Array('show-processlist'),
  38     'SHOW PROFILE': Array('show-profile'),
  39     'SHOW PROFILES': Array('show-profiles'),
  40     'SHOW RELAYLOG EVENTS': Array('show-relaylog-events'),
  41     'SHOW SLAVE HOSTS': Array('show-slave-hosts'),
  42     'SHOW SLAVE STATUS': Array('show-slave-status'),
  43     'SHOW STATUS': Array('show-status'),
  44     'SHOW TABLE STATUS': Array('show-table-status'),
  45     'SHOW TABLES': Array('show-tables'),
  46     'SHOW TRIGGERS': Array('show-triggers'),
  47     'SHOW VARIABLES': Array('show-variables'),
  48     'SHOW WARNINGS': Array('show-warnings'),
  49     'LOAD DATA INFILE': Array('load-data'),
  50     'LOAD XML': Array('load-xml'),
  51     'LOCK TABLES': Array('lock-tables'),
  52     'UNLOCK TABLES': Array('lock-tables'),
  53     'ALTER DATABASE': Array('alter-database'),
  54     'ALTER EVENT': Array('alter-event'),
  55     'ALTER LOGFILE GROUP': Array('alter-logfile-group'),
  56     'ALTER FUNCTION': Array('alter-function'),
  57     'ALTER PROCEDURE': Array('alter-procedure'),
  58     'ALTER SERVER': Array('alter-server'),
  59     'ALTER TABLE': Array('alter-table'),
  60     'ALTER TABLESPACE': Array('alter-tablespace'),
  61     'ALTER VIEW': Array('alter-view'),
  62     'CREATE DATABASE': Array('create-database'),
  63     'CREATE EVENT': Array('create-event'),
  64     'CREATE FUNCTION': Array('create-function'),
  65     'CREATE INDEX': Array('create-index'),
  66     'CREATE LOGFILE GROUP': Array('create-logfile-group'),
  67     'CREATE PROCEDURE': Array('create-procedure'),
  68     'CREATE SERVER': Array('create-server'),
  69     'CREATE TABLE': Array('create-table'),
  70     'CREATE TABLESPACE': Array('create-tablespace'),
  71     'CREATE TRIGGER': Array('create-trigger'),
  72     'CREATE VIEW': Array('create-view'),
  73     'DROP DATABASE': Array('drop-database'),
  74     'DROP EVENT': Array('drop-event'),
  75     'DROP FUNCTION': Array('drop-function'),
  76     'DROP INDEX': Array('drop-index'),
  77     'DROP LOGFILE GROUP': Array('drop-logfile-group'),
  78     'DROP PROCEDURE': Array('drop-procedure'),
  79     'DROP SERVER': Array('drop-server'),
  80     'DROP TABLE': Array('drop-table'),
  81     'DROP TABLESPACE': Array('drop-tablespace'),
  82     'DROP TRIGGER': Array('drop-trigger'),
  83     'DROP VIEW': Array('drop-view'),
  84     'RENAME TABLE': Array('rename-table'),
  85     'TRUNCATE TABLE': Array('truncate-table'),
  86
  87     /* Statements */
  88     'SELECT': Array('select'),
  89     'SET': Array('set'),
  90     'EXPLAIN': Array('explain'),
  91     'DESCRIBE': Array('describe'),
  92     'DELETE': Array('delete'),
  93     'SHOW': Array('show'),
  94     'UPDATE': Array('update'),
  95     'INSERT': Array('insert'),
  96     'REPLACE': Array('replace'),
  97     'CALL': Array('call'),
  98     'DO': Array('do'),
  99     'HANDLER': Array('handler'),
 100     'COLLATE': Array('charset-collations'),
 101
 102     /* Functions */
 103     'ABS': Array('mathematical-functions', 'function_abs'),
 104     'ACOS': Array('mathematical-functions', 'function_acos'),
 105     'ADDDATE': Array('date-and-time-functions', 'function_adddate'),
 106     'ADDTIME': Array('date-and-time-functions', 'function_addtime'),
 107     'AES_DECRYPT': Array('encryption-functions', 'function_aes_decrypt'),
 108     'AES_ENCRYPT': Array('encryption-functions', 'function_aes_encrypt'),
 109     'AND': Array('logical-operators', 'operator_and'),
 110     'ASCII': Array('string-functions', 'function_ascii'),
 111     'ASIN': Array('mathematical-functions', 'function_asin'),
 112     'ATAN2': Array('mathematical-functions', 'function_atan2'),
 113     'ATAN': Array('mathematical-functions', 'function_atan'),
 114     'AVG': Array('group-by-functions', 'function_avg'),
 115     'BENCHMARK': Array('information-functions', 'function_benchmark'),
 116     'BIN': Array('string-functions', 'function_bin'),
 117     'BINARY': Array('cast-functions', 'operator_binary'),
 118     'BIT_AND': Array('group-by-functions', 'function_bit_and'),
 119     'BIT_COUNT': Array('bit-functions', 'function_bit_count'),
 120     'BIT_LENGTH': Array('string-functions', 'function_bit_length'),
 121     'BIT_OR': Array('group-by-functions', 'function_bit_or'),
 122     'BIT_XOR': Array('group-by-functions', 'function_bit_xor'),
 123     'CASE': Array('control-flow-functions', 'operator_case'),
 124     'CAST': Array('cast-functions', 'function_cast'),
 125     'CEIL': Array('mathematical-functions', 'function_ceil'),
 126     'CEILING': Array('mathematical-functions', 'function_ceiling'),
 127     'CHAR_LENGTH': Array('string-functions', 'function_char_length'),
 128     'CHAR': Array('string-functions', 'function_char'),
 129     'CHARACTER_LENGTH': Array('string-functions', 'function_character_length'),
 130     'CHARSET': Array('information-functions', 'function_charset'),
 131     'COALESCE': Array('comparison-operators', 'function_coalesce'),
 132     'COERCIBILITY': Array('information-functions', 'function_coercibility'),
 133     'COLLATION': Array('information-functions', 'function_collation'),
 134     'COMPRESS': Array('encryption-functions', 'function_compress'),
 135     'CONCAT_WS': Array('string-functions', 'function_concat_ws'),
 136     'CONCAT': Array('string-functions', 'function_concat'),
 137     'CONNECTION_ID': Array('information-functions', 'function_connection_id'),
 138     'CONV': Array('mathematical-functions', 'function_conv'),
 139     'CONVERT_TZ': Array('date-and-time-functions', 'function_convert_tz'),
 140     'Convert': Array('cast-functions', 'function_convert'),
 141     'COS': Array('mathematical-functions', 'function_cos'),
 142     'COT': Array('mathematical-functions', 'function_cot'),
 143     'COUNT': Array('group-by-functions', 'function_count'),
 144     'CRC32': Array('mathematical-functions', 'function_crc32'),
 145     'CURDATE': Array('date-and-time-functions', 'function_curdate'),
 146     'CURRENT_DATE': Array('date-and-time-functions', 'function_current_date'),
 147     'CURRENT_TIME': Array('date-and-time-functions', 'function_current_time'),
 148     'CURRENT_TIMESTAMP': Array('date-and-time-functions', 'function_current_timestamp'),
 149     'CURRENT_USER': Array('information-functions', 'function_current_user'),
 150     'CURTIME': Array('date-and-time-functions', 'function_curtime'),
 151     'DATABASE': Array('information-functions', 'function_database'),
 152     'DATE_ADD': Array('date-and-time-functions', 'function_date_add'),
 153     'DATE_FORMAT': Array('date-and-time-functions', 'function_date_format'),
 154     'DATE_SUB': Array('date-and-time-functions', 'function_date_sub'),
 155     'DATE': Array('date-and-time-functions', 'function_date'),
 156     'DATEDIFF': Array('date-and-time-functions', 'function_datediff'),
 157     'DAY': Array('date-and-time-functions', 'function_day'),
 158     'DAYNAME': Array('date-and-time-functions', 'function_dayname'),
 159     'DAYOFMONTH': Array('date-and-time-functions', 'function_dayofmonth'),
 160     'DAYOFWEEK': Array('date-and-time-functions', 'function_dayofweek'),
 161     'DAYOFYEAR': Array('date-and-time-functions', 'function_dayofyear'),
 162     'DECLARE': Array('declare', 'declare'),
 163     'DECODE': Array('encryption-functions', 'function_decode'),
 164     'DEFAULT': Array('miscellaneous-functions', 'function_default'),
 165     'DEGREES': Array('mathematical-functions', 'function_degrees'),
 166     'DES_DECRYPT': Array('encryption-functions', 'function_des_decrypt'),
 167     'DES_ENCRYPT': Array('encryption-functions', 'function_des_encrypt'),
 168     'DIV': Array('arithmetic-functions', 'operator_div'),
 169     'ELT': Array('string-functions', 'function_elt'),
 170     'ENCODE': Array('encryption-functions', 'function_encode'),
 171     'ENCRYPT': Array('encryption-functions', 'function_encrypt'),
 172     'EXP': Array('mathematical-functions', 'function_exp'),
 173     'EXPORT_SET': Array('string-functions', 'function_export_set'),
 174     'EXTRACT': Array('date-and-time-functions', 'function_extract'),
 175     'ExtractValue': Array('xml-functions', 'function_extractvalue'),
 176     'FIELD': Array('string-functions', 'function_field'),
 177     'FIND_IN_SET': Array('string-functions', 'function_find_in_set'),
 178     'FLOOR': Array('mathematical-functions', 'function_floor'),
 179     'FORMAT': Array('string-functions', 'function_format'),
 180     'FOUND_ROWS': Array('information-functions', 'function_found_rows'),
 181     'FROM_DAYS': Array('date-and-time-functions', 'function_from_days'),
 182     'FROM_UNIXTIME': Array('date-and-time-functions', 'function_from_unixtime'),
 183     'GET_FORMAT': Array('date-and-time-functions', 'function_get_format'),
 184     'GET_LOCK': Array('miscellaneous-functions', 'function_get_lock'),
 185     'GREATEST': Array('comparison-operators', 'function_greatest'),
 186     'GROUP_CONCAT': Array('group-by-functions', 'function_group_concat'),
 187     'HEX': Array('string-functions', 'function_hex'),
 188     'HOUR': Array('date-and-time-functions', 'function_hour'),
 189     'IF': Array('control-flow-functions', 'function_if'),
 190     'IFNULL': Array('control-flow-functions', 'function_ifnull'),
 191     'IN': Array('comparison-operators', 'function_in'),
 192     'INET_ATON': Array('miscellaneous-functions', 'function_inet_aton'),
 193     'INET_NTOA': Array('miscellaneous-functions', 'function_inet_ntoa'),
 194     'INSTR': Array('string-functions', 'function_instr'),
 195     'INTERVAL': Array('comparison-operators', 'function_interval'),
 196     'IS_FREE_LOCK': Array('miscellaneous-functions', 'function_is_free_lock'),
 197     'IS_USED_LOCK': Array('miscellaneous-functions', 'function_is_used_lock'),
 198     'IS': Array('comparison-operators', 'operator_is'),
 199     'ISNULL': Array('comparison-operators', 'function_isnull'),
 200     'LAST_DAY': Array('date-and-time-functions', 'function_last_day'),
 201     'LAST_INSERT_ID': Array('information-functions', 'function_last_insert_id'),
 202     'LCASE': Array('string-functions', 'function_lcase'),
 203     'LEAST': Array('comparison-operators', 'function_least'),
 204     'LEFT': Array('string-functions', 'function_left'),
 205     'LENGTH': Array('string-functions', 'function_length'),
 206     'LIKE': Array('string-comparison-functions', 'operator_like'),
 207     'LN': Array('mathematical-functions', 'function_ln'),
 208     'LOAD_FILE': Array('string-functions', 'function_load_file'),
 209     'LOCALTIME': Array('date-and-time-functions', 'function_localtime'),
 210     'LOCALTIMESTAMP': Array('date-and-time-functions', 'function_localtimestamp'),
 211     'LOCATE': Array('string-functions', 'function_locate'),
 212     'LOG10': Array('mathematical-functions', 'function_log10'),
 213     'LOG2': Array('mathematical-functions', 'function_log2'),
 214     'LOG': Array('mathematical-functions', 'function_log'),
 215     'LOWER': Array('string-functions', 'function_lower'),
 216     'LPAD': Array('string-functions', 'function_lpad'),
 217     'LTRIM': Array('string-functions', 'function_ltrim'),
 218     'MAKE_SET': Array('string-functions', 'function_make_set'),
 219     'MAKEDATE': Array('date-and-time-functions', 'function_makedate'),
 220     'MAKETIME': Array('date-and-time-functions', 'function_maketime'),
 221     'MASTER_POS_WAIT': Array('miscellaneous-functions', 'function_master_pos_wait'),
 222     'MATCH': Array('fulltext-search', 'function_match'),
 223     'MAX': Array('group-by-functions', 'function_max'),
 224     'MD5': Array('encryption-functions', 'function_md5'),
 225     'MICROSECOND': Array('date-and-time-functions', 'function_microsecond'),
 226     'MID': Array('string-functions', 'function_mid'),
 227     'MIN': Array('group-by-functions', 'function_min'),
 228     'MINUTE': Array('date-and-time-functions', 'function_minute'),
 229     'MOD': Array('mathematical-functions', 'function_mod'),
 230     'MONTH': Array('date-and-time-functions', 'function_month'),
 231     'MONTHNAME': Array('date-and-time-functions', 'function_monthname'),
 232     'NAME_CONST': Array('miscellaneous-functions', 'function_name_const'),
 233     'NOT': Array('logical-operators', 'operator_not'),
 234     'NOW': Array('date-and-time-functions', 'function_now'),
 235     'NULLIF': Array('control-flow-functions', 'function_nullif'),
 236     'OCT': Array('mathematical-functions', 'function_oct'),
 237     'OCTET_LENGTH': Array('string-functions', 'function_octet_length'),
 238     'OLD_PASSWORD': Array('encryption-functions', 'function_old_password'),
 239     'OR': Array('logical-operators', 'operator_or'),
 240     'ORD': Array('string-functions', 'function_ord'),
 241     'PASSWORD': Array('encryption-functions', 'function_password'),
 242     'PERIOD_ADD': Array('date-and-time-functions', 'function_period_add'),
 243     'PERIOD_DIFF': Array('date-and-time-functions', 'function_period_diff'),
 244     'PI': Array('mathematical-functions', 'function_pi'),
 245     'POSITION': Array('string-functions', 'function_position'),
 246     'POW': Array('mathematical-functions', 'function_pow'),
 247     'POWER': Array('mathematical-functions', 'function_power'),
 248     'QUARTER': Array('date-and-time-functions', 'function_quarter'),
 249     'QUOTE': Array('string-functions', 'function_quote'),
 250     'RADIANS': Array('mathematical-functions', 'function_radians'),
 251     'RAND': Array('mathematical-functions', 'function_rand'),
 252     'REGEXP': Array('regexp', 'operator_regexp'),
 253     'RELEASE_LOCK': Array('miscellaneous-functions', 'function_release_lock'),
 254     'REPEAT': Array('string-functions', 'function_repeat'),
 255     'REVERSE': Array('string-functions', 'function_reverse'),
 256     'RIGHT': Array('string-functions', 'function_right'),
 257     'RLIKE': Array('regexp', 'operator_rlike'),
 258     'ROUND': Array('mathematical-functions', 'function_round'),
 259     'ROW_COUNT': Array('information-functions', 'function_row_count'),
 260     'RPAD': Array('string-functions', 'function_rpad'),
 261     'RTRIM': Array('string-functions', 'function_rtrim'),
 262     'SCHEMA': Array('information-functions', 'function_schema'),
 263     'SEC_TO_TIME': Array('date-and-time-functions', 'function_sec_to_time'),
 264     'SECOND': Array('date-and-time-functions', 'function_second'),
 265     'SESSION_USER': Array('information-functions', 'function_session_user'),
 266     'SHA': Array('encryption-functions', 'function_sha1'),
 267     'SHA1': Array('encryption-functions', 'function_sha1'),
 268     'SIGN': Array('mathematical-functions', 'function_sign'),
 269     'SIN': Array('mathematical-functions', 'function_sin'),
 270     'SLEEP': Array('miscellaneous-functions', 'function_sleep'),
 271     'SOUNDEX': Array('string-functions', 'function_soundex'),
 272     'SPACE': Array('string-functions', 'function_space'),
 273     'SQRT': Array('mathematical-functions', 'function_sqrt'),
 274     'STD': Array('group-by-functions', 'function_std'),
 275     'STDDEV_POP': Array('group-by-functions', 'function_stddev_pop'),
 276     'STDDEV_SAMP': Array('group-by-functions', 'function_stddev_samp'),
 277     'STDDEV': Array('group-by-functions', 'function_stddev'),
 278     'STR_TO_DATE': Array('date-and-time-functions', 'function_str_to_date'),
 279     'STRCMP': Array('string-comparison-functions', 'function_strcmp'),
 280     'SUBDATE': Array('date-and-time-functions', 'function_subdate'),
 281     'SUBSTR': Array('string-functions', 'function_substr'),
 282     'SUBSTRING_INDEX': Array('string-functions', 'function_substring_index'),
 283     'SUBSTRING': Array('string-functions', 'function_substring'),
 284     'SUBTIME': Array('date-and-time-functions', 'function_subtime'),
 285     'SUM': Array('group-by-functions', 'function_sum'),
 286     'SYSDATE': Array('date-and-time-functions', 'function_sysdate'),
 287     'SYSTEM_USER': Array('information-functions', 'function_system_user'),
 288     'TAN': Array('mathematical-functions', 'function_tan'),
 289     'TIME_FORMAT': Array('date-and-time-functions', 'function_time_format'),
 290     'TIME_TO_SEC': Array('date-and-time-functions', 'function_time_to_sec'),
 291     'TIME': Array('date-and-time-functions', 'function_time'),
 292     'TIMEDIFF': Array('date-and-time-functions', 'function_timediff'),
 293     'TIMESTAMP': Array('date-and-time-functions', 'function_timestamp'),
 294     'TIMESTAMPADD': Array('date-and-time-functions', 'function_timestampadd'),
 295     'TIMESTAMPDIFF': Array('date-and-time-functions', 'function_timestampdiff'),
 296     'TO_DAYS': Array('date-and-time-functions', 'function_to_days'),
 297     'TRIM': Array('string-functions', 'function_trim'),
 298     'TRUNCATE': Array('mathematical-functions', 'function_truncate'),
 299     'UCASE': Array('string-functions', 'function_ucase'),
 300     'UNCOMPRESS': Array('encryption-functions', 'function_uncompress'),
 301     'UNCOMPRESSED_LENGTH': Array('encryption-functions', 'function_uncompressed_length'),
 302     'UNHEX': Array('string-functions', 'function_unhex'),
 303     'UNIX_TIMESTAMP': Array('date-and-time-functions', 'function_unix_timestamp'),
 304     'UpdateXML': Array('xml-functions', 'function_updatexml'),
 305     'UPPER': Array('string-functions', 'function_upper'),
 306     'USER': Array('information-functions', 'function_user'),
 307     'UTC_DATE': Array('date-and-time-functions', 'function_utc_date'),
 308     'UTC_TIME': Array('date-and-time-functions', 'function_utc_time'),
 309     'UTC_TIMESTAMP': Array('date-and-time-functions', 'function_utc_timestamp'),
 310     'UUID_SHORT': Array('miscellaneous-functions', 'function_uuid_short'),
 311     'UUID': Array('miscellaneous-functions', 'function_uuid'),
 312     'VALUES': Array('miscellaneous-functions', 'function_values'),
 313     'VAR_POP': Array('group-by-functions', 'function_var_pop'),
 314     'VAR_SAMP': Array('group-by-functions', 'function_var_samp'),
 315     'VARIANCE': Array('group-by-functions', 'function_variance'),
 316     'VERSION': Array('information-functions', 'function_version'),
 317     'WEEK': Array('date-and-time-functions', 'function_week'),
 318     'WEEKDAY': Array('date-and-time-functions', 'function_weekday'),
 319     'WEEKOFYEAR': Array('date-and-time-functions', 'function_weekofyear'),
 320     'XOR': Array('logical-operators', 'operator_xor'),
 321     'YEAR': Array('date-and-time-functions', 'function_year'),
 322     'YEARWEEK': Array('date-and-time-functions', 'function_yearweek'),
 323     'SOUNDS_LIKE': Array('string-functions', 'operator_sounds-like'),
 324     'IS_NOT_NULL': Array('comparison-operators', 'operator_is-not-null'),
 325     'IS_NOT': Array('comparison-operators', 'operator_is-not'),
 326     'IS_NULL': Array('comparison-operators', 'operator_is-null'),
 327     'NOT_LIKE': Array('string-comparison-functions', 'operator_not-like'),
 328     'NOT_REGEXP': Array('regexp', 'operator_not-regexp'),
 329     'COUNT_DISTINCT': Array('group-by-functions', 'function_count-distinct'),
 330     'NOT_IN': Array('comparison-operators', 'function_not-in')
 331 };
 332
 333 var mysql_doc_builtin = {
 334     'TINYINT': Array('numeric-types'),
 335     'SMALLINT': Array('numeric-types'),
 336     'MEDIUMINT': Array('numeric-types'),
 337     'INT': Array('numeric-types'),
 338     'BIGINT': Array('numeric-types'),
 339     'DECIMAL': Array('numeric-types'),
 340     'FLOAT': Array('numeric-types'),
 341     'DOUBLE': Array('numeric-types'),
 342     'REAL': Array('numeric-types'),
 343     'BIT': Array('numeric-types'),
 344     'BOOLEAN': Array('numeric-types'),
 345     'SERIAL': Array('numeric-types'),
 346     'DATE': Array('date-and-time-types'),
 347     'DATETIME': Array('date-and-time-types'),
 348     'TIMESTAMP': Array('date-and-time-types'),
 349     'TIME': Array('date-and-time-types'),
 350     'YEAR': Array('date-and-time-types'),
 351     'CHAR': Array('string-types'),
 352     'VARCHAR': Array('string-types'),
 353     'TINYTEXT': Array('string-types'),
 354     'TEXT': Array('string-types'),
 355     'MEDIUMTEXT': Array('string-types'),
 356     'LONGTEXT': Array('string-types'),
 357     'BINARY': Array('string-types'),
 358     'VARBINARY': Array('string-types'),
 359     'TINYBLOB': Array('string-types'),
 360     'MEDIUMBLOB': Array('string-types'),
 361     'BLOB': Array('string-types'),
 362     'LONGBLOB': Array('string-types'),
 363     'ENUM': Array('string-types'),
 364     'SET': Array('string-types')
 365 };