js/doclinks.js

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