3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.3">
17 <title>sql - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.1655a90d.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#sql-package-installation-plugin" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
857 <li class=
"md-nav__item">
858 <a href=
"../" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"../acl-option/" class=
"md-nav__link">
881 <li class=
"md-nav__item">
882 <a href=
"../acp-menu/" class=
"md-nav__link">
893 <li class=
"md-nav__item">
894 <a href=
"../acp-search-provider/" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"../acp-template/" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"../bbcode/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../box/" class=
"md-nav__link">
941 <li class=
"md-nav__item">
942 <a href=
"../clipboard-action/" class=
"md-nav__link">
953 <li class=
"md-nav__item">
954 <a href=
"../core-object/" class=
"md-nav__link">
965 <li class=
"md-nav__item">
966 <a href=
"../cronjob/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../event-listener/" class=
"md-nav__link">
989 <li class=
"md-nav__item">
990 <a href=
"../file/" class=
"md-nav__link">
1001 <li class=
"md-nav__item">
1002 <a href=
"../language/" class=
"md-nav__link">
1013 <li class=
"md-nav__item">
1014 <a href=
"../media-provider/" class=
"md-nav__link">
1025 <li class=
"md-nav__item">
1026 <a href=
"../menu/" class=
"md-nav__link">
1037 <li class=
"md-nav__item">
1038 <a href=
"../menu-item/" class=
"md-nav__link">
1049 <li class=
"md-nav__item">
1050 <a href=
"../object-type/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../object-type-definition/" class=
"md-nav__link">
1063 objectTypeDefinition
1073 <li class=
"md-nav__item">
1074 <a href=
"../option/" class=
"md-nav__link">
1085 <li class=
"md-nav__item">
1086 <a href=
"../page/" class=
"md-nav__link">
1097 <li class=
"md-nav__item">
1098 <a href=
"../pip/" class=
"md-nav__link">
1109 <li class=
"md-nav__item">
1110 <a href=
"../script/" class=
"md-nav__link">
1121 <li class=
"md-nav__item">
1122 <a href=
"../smiley/" class=
"md-nav__link">
1135 <li class=
"md-nav__item md-nav__item--active">
1137 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1142 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1144 <span class=
"md-nav__icon md-icon"></span>
1147 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1152 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1158 <label class=
"md-nav__title" for=
"__toc">
1159 <span class=
"md-nav__icon md-icon"></span>
1162 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1164 <li class=
"md-nav__item">
1165 <a href=
"#expected-value" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"#features" class=
"md-nav__link">
1176 <nav class=
"md-nav" aria-label=
"Features">
1177 <ul class=
"md-nav__list">
1179 <li class=
"md-nav__item">
1180 <a href=
"#logging" class=
"md-nav__link">
1186 <li class=
"md-nav__item">
1187 <a href=
"#instance-number" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"#table-type" class=
"md-nav__link">
1205 <li class=
"md-nav__item">
1206 <a href=
"#limitations" class=
"md-nav__link">
1210 <nav class=
"md-nav" aria-label=
"Limitations">
1211 <ul class=
"md-nav__list">
1213 <li class=
"md-nav__item">
1214 <a href=
"#logging_1" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"#triggers" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"#example" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../database-php-api/" class=
"md-nav__link">
1375 <li class=
"md-nav__item md-nav__item--nested">
1378 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1380 <label class=
"md-nav__link" for=
"__nav_6">
1382 <span class=
"md-nav__icon md-icon"></span>
1384 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1385 <label class=
"md-nav__title" for=
"__nav_6">
1386 <span class=
"md-nav__icon md-icon"></span>
1389 <ul class=
"md-nav__list" data-md-scrollfix
>
1396 <li class=
"md-nav__item md-nav__item--nested">
1399 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1401 <label class=
"md-nav__link" for=
"__nav_6_1">
1402 Migrating from WSC
5.3
1403 <span class=
"md-nav__icon md-icon"></span>
1405 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1406 <label class=
"md-nav__title" for=
"__nav_6_1">
1407 <span class=
"md-nav__icon md-icon"></span>
1408 Migrating from WSC
5.3
1410 <ul class=
"md-nav__list" data-md-scrollfix
>
1416 <li class=
"md-nav__item">
1417 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1430 Session Handling and Authentication
1440 <li class=
"md-nav__item">
1441 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1452 <li class=
"md-nav__item">
1453 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1464 <li class=
"md-nav__item">
1465 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1466 Third Party Libraries
1483 <li class=
"md-nav__item md-nav__item--nested">
1486 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1488 <label class=
"md-nav__link" for=
"__nav_6_2">
1489 Migrating from WSC
5.2
1490 <span class=
"md-nav__icon md-icon"></span>
1492 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1493 <label class=
"md-nav__title" for=
"__nav_6_2">
1494 <span class=
"md-nav__icon md-icon"></span>
1495 Migrating from WSC
5.2
1497 <ul class=
"md-nav__list" data-md-scrollfix
>
1503 <li class=
"md-nav__item">
1504 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1515 <li class=
"md-nav__item">
1516 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1517 Templates and Languages
1527 <li class=
"md-nav__item">
1528 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1529 Third Party Libraries
1546 <li class=
"md-nav__item md-nav__item--nested">
1549 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1551 <label class=
"md-nav__link" for=
"__nav_6_3">
1552 Migrating from WSC
3.1
1553 <span class=
"md-nav__icon md-icon"></span>
1555 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1556 <label class=
"md-nav__title" for=
"__nav_6_3">
1557 <span class=
"md-nav__icon md-icon"></span>
1558 Migrating from WSC
3.1
1560 <ul class=
"md-nav__list" data-md-scrollfix
>
1566 <li class=
"md-nav__item">
1567 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1585 <li class=
"md-nav__item md-nav__item--nested">
1588 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1590 <label class=
"md-nav__link" for=
"__nav_6_4">
1591 Migrating from WSC
3.0
1592 <span class=
"md-nav__icon md-icon"></span>
1594 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1595 <label class=
"md-nav__title" for=
"__nav_6_4">
1596 <span class=
"md-nav__icon md-icon"></span>
1597 Migrating from WSC
3.0
1599 <ul class=
"md-nav__list" data-md-scrollfix
>
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1617 <li class=
"md-nav__item">
1618 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1641 <li class=
"md-nav__item">
1642 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1653 <li class=
"md-nav__item">
1654 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1672 <li class=
"md-nav__item md-nav__item--nested">
1675 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1677 <label class=
"md-nav__link" for=
"__nav_6_5">
1678 Migrating from WCF
2.1
1679 <span class=
"md-nav__icon md-icon"></span>
1681 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1682 <label class=
"md-nav__title" for=
"__nav_6_5">
1683 <span class=
"md-nav__icon md-icon"></span>
1684 Migrating from WCF
2.1
1686 <ul class=
"md-nav__list" data-md-scrollfix
>
1692 <li class=
"md-nav__item">
1693 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1704 <li class=
"md-nav__item">
1705 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1716 <li class=
"md-nav__item">
1717 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1728 <li class=
"md-nav__item">
1729 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1756 <li class=
"md-nav__item md-nav__item--nested">
1759 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1761 <label class=
"md-nav__link" for=
"__nav_7">
1763 <span class=
"md-nav__icon md-icon"></span>
1765 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1766 <label class=
"md-nav__title" for=
"__nav_7">
1767 <span class=
"md-nav__icon md-icon"></span>
1770 <ul class=
"md-nav__list" data-md-scrollfix
>
1777 <li class=
"md-nav__item md-nav__item--nested">
1780 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1782 <label class=
"md-nav__link" for=
"__nav_7_1">
1784 <span class=
"md-nav__icon md-icon"></span>
1786 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1787 <label class=
"md-nav__title" for=
"__nav_7_1">
1788 <span class=
"md-nav__icon md-icon"></span>
1791 <ul class=
"md-nav__list" data-md-scrollfix
>
1797 <li class=
"md-nav__item">
1798 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1809 <li class=
"md-nav__item">
1810 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1821 <li class=
"md-nav__item">
1822 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1833 <li class=
"md-nav__item">
1834 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1861 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1862 <div class=
"md-sidebar__scrollwrap">
1863 <div class=
"md-sidebar__inner">
1865 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1871 <label class=
"md-nav__title" for=
"__toc">
1872 <span class=
"md-nav__icon md-icon"></span>
1875 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1877 <li class=
"md-nav__item">
1878 <a href=
"#expected-value" class=
"md-nav__link">
1884 <li class=
"md-nav__item">
1885 <a href=
"#features" class=
"md-nav__link">
1889 <nav class=
"md-nav" aria-label=
"Features">
1890 <ul class=
"md-nav__list">
1892 <li class=
"md-nav__item">
1893 <a href=
"#logging" class=
"md-nav__link">
1899 <li class=
"md-nav__item">
1900 <a href=
"#instance-number" class=
"md-nav__link">
1906 <li class=
"md-nav__item">
1907 <a href=
"#table-type" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"#limitations" class=
"md-nav__link">
1923 <nav class=
"md-nav" aria-label=
"Limitations">
1924 <ul class=
"md-nav__list">
1926 <li class=
"md-nav__item">
1927 <a href=
"#logging_1" class=
"md-nav__link">
1933 <li class=
"md-nav__item">
1934 <a href=
"#triggers" class=
"md-nav__link">
1945 <li class=
"md-nav__item">
1946 <a href=
"#example" class=
"md-nav__link">
1960 <div class=
"md-content" data-md-component=
"content">
1961 <article class=
"md-content__inner md-typeset">
1965 <h1 id=
"sql-package-installation-plugin">SQL Package Installation Plugin
<a class=
"headerlink" href=
"#sql-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1966 <p>Execute SQL instructions using a MySQL-flavored syntax.
</p>
1967 <div class=
"admonition warning">
1968 <p class=
"admonition-title">This file is parsed by WoltLab Suite Core to allow reverting of certain changes, but not every syntax MySQL supports is recognized by the parser. To avoid any troubles, you should always use statements relying on the SQL standard.
</p>
1970 <h2 id=
"expected-value">Expected Value
<a class=
"headerlink" href=
"#expected-value" title=
"Permanent link">#
</a></h2>
1971 <p>The
<code>sql
</code> package installation plugin expects a relative path to a
<code>.sql
</code> file.
</p>
1972 <h2 id=
"features">Features
<a class=
"headerlink" href=
"#features" title=
"Permanent link">#
</a></h2>
1973 <h3 id=
"logging">Logging
<a class=
"headerlink" href=
"#logging" title=
"Permanent link">#
</a></h3>
1974 <p>WoltLab Suite Core uses a SQL parser to extract queries and log certain actions.
1975 This allows WoltLab Suite Core to revert some of the changes you apply upon package uninstallation.
</p>
1976 <p>The logged changes are:
</p>
1978 <li><code>CREATE TABLE
</code></li>
1979 <li><code>ALTER TABLE … ADD COLUMN
</code></li>
1980 <li><code>ALTER TABLE … ADD … KEY
</code></li>
1982 <h3 id=
"instance-number">Instance Number
<a class=
"headerlink" href=
"#instance-number" title=
"Permanent link">#
</a></h3>
1983 <p>It is possible to use different instance numbers, e.g. two separate WoltLab Suite Core installations within one database.
1984 WoltLab Suite Core requires you to always use
<code>wcf1_
<tableName
></code> or
<code><app
>1_
<tableName
></code> (e.g.
<code>blog1_blog
</code> in WoltLab Suite Blog), the number (
<code>1</code>) will be automatically replaced prior to execution.
1985 If you every use anything other but
<code>1</code>, you will eventually break things, thus always use
<code>1</code>!
</p>
1986 <h3 id=
"table-type">Table Type
<a class=
"headerlink" href=
"#table-type" title=
"Permanent link">#
</a></h3>
1987 <p>WoltLab Suite Core will determine the type of database tables on its own:
1988 If the table contains a
<code>FULLTEXT
</code> index, it uses
<code>MyISAM
</code>, otherwise
<code>InnoDB
</code> is used.
</p>
1989 <h2 id=
"limitations">Limitations
<a class=
"headerlink" href=
"#limitations" title=
"Permanent link">#
</a></h2>
1990 <h3 id=
"logging_1">Logging
<a class=
"headerlink" href=
"#logging_1" title=
"Permanent link">#
</a></h3>
1991 <p>WoltLab Suite Core cannot revert changes to the database structure which would cause to the data to be either changed or new data to be incompatible with the original format.
1992 Additionally, WoltLab Suite Core does not track regular SQL queries such as
<code>DELETE
</code> or
<code>UPDATE
</code>.
</p>
1993 <h3 id=
"triggers">Triggers
<a class=
"headerlink" href=
"#triggers" title=
"Permanent link">#
</a></h3>
1994 <p>WoltLab Suite Core does not support trigger since MySQL does not support execution of triggers if the event was fired by a cascading foreign key action.
1995 If you really need triggers, you should consider adding them by custom SQL queries using a
<a href=
"../script/">script
</a>.
</p>
1996 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1997 <p><code>package.xml
</code>:
</p>
1998 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"sql
"</span><span class=
"nt">></span>install.sql
<span class=
"nt"></instruction
></span>
2000 <p>Example content:
</p>
2001 <div class=
"highlight"><pre><span></span><code><span class=
"k">CREATE
</span> <span class=
"k">TABLE
</span> <span class=
"n">wcf1_foo_bar
</span> <span class=
"p">(
</span>
2002 <span class=
"n">fooID
</span> <span class=
"nb">INT
</span><span class=
"p">(
</span><span class=
"mi">10</span><span class=
"p">)
</span> <span class=
"k">NOT
</span> <span class=
"k">NULL
</span> <span class=
"n">AUTO_INCREMENT
</span> <span class=
"k">PRIMARY
</span> <span class=
"k">KEY
</span><span class=
"p">,
</span>
2003 <span class=
"n">packageID
</span> <span class=
"nb">INT
</span><span class=
"p">(
</span><span class=
"mi">10</span><span class=
"p">)
</span> <span class=
"k">NOT
</span> <span class=
"k">NULL
</span><span class=
"p">,
</span>
2004 <span class=
"n">bar
</span> <span class=
"nb">VARCHAR
</span><span class=
"p">(
</span><span class=
"mi">255</span><span class=
"p">)
</span> <span class=
"k">NOT
</span> <span class=
"k">NULL
</span> <span class=
"k">DEFAULT
</span> <span class=
"s1">''</span><span class=
"p">,
</span>
2005 <span class=
"n">foobar
</span> <span class=
"nb">VARCHAR
</span><span class=
"p">(
</span><span class=
"mi">50</span><span class=
"p">)
</span> <span class=
"k">NOT
</span> <span class=
"k">NULL
</span> <span class=
"k">DEFAULT
</span> <span class=
"s1">''</span><span class=
"p">,
</span>
2007 <span class=
"k">UNIQUE
</span> <span class=
"k">KEY
</span> <span class=
"n">baz
</span> <span class=
"p">(
</span><span class=
"n">bar
</span><span class=
"p">,
</span> <span class=
"n">foobar
</span><span class=
"p">)
</span>
2008 <span class=
"p">);
</span>
2010 <span class=
"k">ALTER
</span> <span class=
"k">TABLE
</span> <span class=
"n">wcf1_foo_bar
</span> <span class=
"k">ADD
</span> <span class=
"k">FOREIGN
</span> <span class=
"k">KEY
</span> <span class=
"p">(
</span><span class=
"n">packageID
</span><span class=
"p">)
</span> <span class=
"k">REFERENCES
</span> <span class=
"n">wcf1_package
</span> <span class=
"p">(
</span><span class=
"n">packageID
</span><span class=
"p">)
</span> <span class=
"k">ON
</span> <span class=
"k">DELETE
</span> <span class=
"k">CASCADE
</span><span class=
"p">;
</span>
2025 <footer class=
"md-footer">
2027 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2029 <a href=
"../smiley/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2030 <div class=
"md-footer__button md-icon">
2031 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2033 <div class=
"md-footer__title">
2034 <div class=
"md-ellipsis">
2035 <span class=
"md-footer__direction">
2044 <a href=
"../style/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2045 <div class=
"md-footer__title">
2046 <div class=
"md-ellipsis">
2047 <span class=
"md-footer__direction">
2053 <div class=
"md-footer__button md-icon">
2054 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2060 <div class=
"md-footer-meta md-typeset">
2061 <div class=
"md-footer-meta__inner md-grid">
2062 <div class=
"md-footer-copyright">
2064 <div class=
"md-footer-copyright__highlight">
2065 Copyright ©
2020 WoltLab GmbH
2069 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2073 <div class=
"md-footer-copyright">
2074 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2075 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2082 <div class=
"md-dialog" data-md-component=
"dialog">
2083 <div class=
"md-dialog__inner md-typeset"></div>
2085 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2088 <script src=
"../../../assets/javascripts/bundle.ca5457b8.min.js"></script>