3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/package/database-php-api/">
13 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
14 <meta name=
"generator" content=
"mkdocs-1.4.0, mkdocs-material-8.5.4">
18 <title>Database PHP API - WoltLab Suite Documentation
</title>
22 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.80dcb947.min.css">
25 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.cbb835fc.min.css">
29 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
42 <script>__md_scope=new URL(
"../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
57 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
61 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
62 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
63 <label class=
"md-overlay" for=
"__drawer"></label>
64 <div data-md-component=
"skip">
67 <a href=
"#database-php-api" class=
"md-skip">
72 <div data-md-component=
"announce">
74 <aside class=
"md-banner">
75 <div class=
"md-banner__inner md-grid md-typeset">
78 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
86 <div data-md-component=
"outdated" hidden
>
93 <header class=
"md-header" data-md-component=
"header">
94 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
95 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
97 <img src=
"../../assets/logo.png" alt=
"logo">
100 <label class=
"md-header__button md-icon" for=
"__drawer">
101 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
103 <div class=
"md-header__title" data-md-component=
"header-title">
104 <div class=
"md-header__ellipsis">
105 <div class=
"md-header__topic">
106 <span class=
"md-ellipsis">
107 WoltLab Suite Documentation
110 <div class=
"md-header__topic" data-md-component=
"header-topic">
111 <span class=
"md-ellipsis">
122 <label class=
"md-header__button md-icon" for=
"__search">
123 <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>
125 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
126 <label class=
"md-search__overlay" for=
"__search"></label>
127 <div class=
"md-search__inner" role=
"search">
128 <form class=
"md-search__form" name=
"search">
129 <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" required
>
130 <label class=
"md-search__icon md-icon" for=
"__search">
131 <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>
132 <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>
134 <nav class=
"md-search__options" aria-label=
"Search">
136 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
137 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.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>
142 <div class=
"md-search__output">
143 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
144 <div class=
"md-search-result" data-md-component=
"search-result">
145 <div class=
"md-search-result__meta">
148 <ol class=
"md-search-result__list"></ol>
156 <div class=
"md-header__source">
157 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
158 <div class=
"md-source__icon md-icon">
160 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
162 <div class=
"md-source__repository">
172 <div class=
"md-container" data-md-component=
"container">
179 <main class=
"md-main" data-md-component=
"main">
180 <div class=
"md-main__inner md-grid">
184 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
185 <div class=
"md-sidebar__scrollwrap">
186 <div class=
"md-sidebar__inner">
190 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
191 <label class=
"md-nav__title" for=
"__drawer">
192 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
194 <img src=
"../../assets/logo.png" alt=
"logo">
197 WoltLab Suite Documentation
200 <div class=
"md-nav__source">
201 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
202 <div class=
"md-source__icon md-icon">
204 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
206 <div class=
"md-source__repository">
212 <ul class=
"md-nav__list" data-md-scrollfix
>
221 <li class=
"md-nav__item">
222 <a href=
"../../getting-started/" class=
"md-nav__link">
237 <li class=
"md-nav__item md-nav__item--nested">
240 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
245 <label class=
"md-nav__link" for=
"__nav_2">
247 <span class=
"md-nav__icon md-icon"></span>
250 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
251 <label class=
"md-nav__title" for=
"__nav_2">
252 <span class=
"md-nav__icon md-icon"></span>
255 <ul class=
"md-nav__list" data-md-scrollfix
>
262 <li class=
"md-nav__item">
263 <a href=
"../../php/pages/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/database-objects/" class=
"md-nav__link">
290 <li class=
"md-nav__item">
291 <a href=
"../../php/database-access/" class=
"md-nav__link">
304 <li class=
"md-nav__item">
305 <a href=
"../../php/exceptions/" class=
"md-nav__link">
319 <li class=
"md-nav__item md-nav__item--nested">
322 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
327 <label class=
"md-nav__link" for=
"__nav_2_5">
329 <span class=
"md-nav__icon md-icon"></span>
332 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
333 <label class=
"md-nav__title" for=
"__nav_2_5">
334 <span class=
"md-nav__icon md-icon"></span>
337 <ul class=
"md-nav__list" data-md-scrollfix
>
345 <li class=
"md-nav__item md-nav__item--nested">
348 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
353 <label class=
"md-nav__link" for=
"__nav_2_5_1">
355 <span class=
"md-nav__icon md-icon"></span>
358 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
359 <label class=
"md-nav__title" for=
"__nav_2_5_1">
360 <span class=
"md-nav__icon md-icon"></span>
363 <ul class=
"md-nav__list" data-md-scrollfix
>
370 <li class=
"md-nav__item">
371 <a href=
"../../php/api/caches/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
419 <li class=
"md-nav__item">
420 <a href=
"../../php/api/comments/" class=
"md-nav__link">
433 <li class=
"md-nav__item">
434 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
447 <li class=
"md-nav__item">
448 <a href=
"../../php/api/events/" class=
"md-nav__link">
462 <li class=
"md-nav__item md-nav__item--nested">
465 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
470 <label class=
"md-nav__link" for=
"__nav_2_5_5">
472 <span class=
"md-nav__icon md-icon"></span>
475 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
476 <label class=
"md-nav__title" for=
"__nav_2_5_5">
477 <span class=
"md-nav__icon md-icon"></span>
480 <ul class=
"md-nav__list" data-md-scrollfix
>
487 <li class=
"md-nav__item">
488 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
501 <li class=
"md-nav__item">
502 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
515 <li class=
"md-nav__item">
516 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
529 <li class=
"md-nav__item">
530 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
543 <li class=
"md-nav__item">
544 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
564 <li class=
"md-nav__item">
565 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
566 Package Installation Plugins
578 <li class=
"md-nav__item">
579 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
606 <li class=
"md-nav__item">
607 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../php/code-style/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../php/apps/" class=
"md-nav__link">
655 <li class=
"md-nav__item">
656 <a href=
"../../php/gdpr/" class=
"md-nav__link">
678 <li class=
"md-nav__item md-nav__item--nested">
681 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
686 <label class=
"md-nav__link" for=
"__nav_3">
687 Languages, Templates & CSS
688 <span class=
"md-nav__icon md-icon"></span>
691 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
692 <label class=
"md-nav__title" for=
"__nav_3">
693 <span class=
"md-nav__icon md-icon"></span>
694 Languages, Templates & CSS
696 <ul class=
"md-nav__list" data-md-scrollfix
>
703 <li class=
"md-nav__item">
704 <a href=
"../../view/languages/" class=
"md-nav__link">
717 <li class=
"md-nav__item">
718 <a href=
"../../view/templates/" class=
"md-nav__link">
731 <li class=
"md-nav__item">
732 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
745 <li class=
"md-nav__item">
746 <a href=
"../../view/css/" class=
"md-nav__link">
768 <li class=
"md-nav__item md-nav__item--nested">
771 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
776 <label class=
"md-nav__link" for=
"__nav_4">
777 TypeScript and JavaScript API
778 <span class=
"md-nav__icon md-icon"></span>
781 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
782 <label class=
"md-nav__title" for=
"__nav_4">
783 <span class=
"md-nav__icon md-icon"></span>
784 TypeScript and JavaScript API
786 <ul class=
"md-nav__list" data-md-scrollfix
>
793 <li class=
"md-nav__item">
794 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
807 <li class=
"md-nav__item">
808 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
822 <li class=
"md-nav__item md-nav__item--nested">
825 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
830 <label class=
"md-nav__link" for=
"__nav_4_3">
832 <span class=
"md-nav__icon md-icon"></span>
835 <nav class=
"md-nav" aria-label=
"Components" data-md-level=
"2">
836 <label class=
"md-nav__title" for=
"__nav_4_3">
837 <span class=
"md-nav__icon md-icon"></span>
840 <ul class=
"md-nav__list" data-md-scrollfix
>
847 <li class=
"md-nav__item">
848 <a href=
"../../javascript/components_confirmation/" class=
"md-nav__link">
861 <li class=
"md-nav__item">
862 <a href=
"../../javascript/components_dialog/" class=
"md-nav__link">
883 <li class=
"md-nav__item md-nav__item--nested">
886 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_4" type=
"checkbox" id=
"__nav_4_4" >
891 <label class=
"md-nav__link" for=
"__nav_4_4">
893 <span class=
"md-nav__icon md-icon"></span>
896 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
897 <label class=
"md-nav__title" for=
"__nav_4_4">
898 <span class=
"md-nav__icon md-icon"></span>
901 <ul class=
"md-nav__list" data-md-scrollfix
>
908 <li class=
"md-nav__item">
909 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
922 <li class=
"md-nav__item">
923 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
936 <li class=
"md-nav__item">
937 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
978 <li class=
"md-nav__item">
979 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
1006 <li class=
"md-nav__item">
1007 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
1008 Browser and Screen Sizes
1020 <li class=
"md-nav__item">
1021 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
1069 <li class=
"md-nav__item">
1070 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
1094 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1097 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
1102 <label class=
"md-nav__link" for=
"__nav_5">
1104 <span class=
"md-nav__icon md-icon"></span>
1107 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1108 <label class=
"md-nav__title" for=
"__nav_5">
1109 <span class=
"md-nav__icon md-icon"></span>
1112 <ul class=
"md-nav__list" data-md-scrollfix
>
1119 <li class=
"md-nav__item">
1120 <a href=
"../package-xml/" class=
"md-nav__link">
1134 <li class=
"md-nav__item md-nav__item--nested">
1137 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1142 <label class=
"md-nav__link" for=
"__nav_5_2">
1144 <span class=
"md-nav__icon md-icon"></span>
1147 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1148 <label class=
"md-nav__title" for=
"__nav_5_2">
1149 <span class=
"md-nav__icon md-icon"></span>
1152 <ul class=
"md-nav__list" data-md-scrollfix
>
1159 <li class=
"md-nav__item">
1160 <a href=
"../pip/" class=
"md-nav__link">
1173 <li class=
"md-nav__item">
1174 <a href=
"../pip/acl-option/" class=
"md-nav__link">
1187 <li class=
"md-nav__item">
1188 <a href=
"../pip/acp-menu/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../pip/acp-search-provider/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../pip/acp-template/" class=
"md-nav__link">
1229 <li class=
"md-nav__item">
1230 <a href=
"../pip/acp-template-delete/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../pip/bbcode/" class=
"md-nav__link">
1257 <li class=
"md-nav__item">
1258 <a href=
"../pip/box/" class=
"md-nav__link">
1271 <li class=
"md-nav__item">
1272 <a href=
"../pip/clipboard-action/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../pip/core-object/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../pip/cronjob/" class=
"md-nav__link">
1313 <li class=
"md-nav__item">
1314 <a href=
"../pip/database/" class=
"md-nav__link">
1327 <li class=
"md-nav__item">
1328 <a href=
"../pip/event-listener/" class=
"md-nav__link">
1341 <li class=
"md-nav__item">
1342 <a href=
"../pip/file/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../pip/file-delete/" class=
"md-nav__link">
1369 <li class=
"md-nav__item">
1370 <a href=
"../pip/language/" class=
"md-nav__link">
1383 <li class=
"md-nav__item">
1384 <a href=
"../pip/media-provider/" class=
"md-nav__link">
1397 <li class=
"md-nav__item">
1398 <a href=
"../pip/menu/" class=
"md-nav__link">
1411 <li class=
"md-nav__item">
1412 <a href=
"../pip/menu-item/" class=
"md-nav__link">
1425 <li class=
"md-nav__item">
1426 <a href=
"../pip/object-type/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../pip/object-type-definition/" class=
"md-nav__link">
1441 objectTypeDefinition
1453 <li class=
"md-nav__item">
1454 <a href=
"../pip/option/" class=
"md-nav__link">
1467 <li class=
"md-nav__item">
1468 <a href=
"../pip/page/" class=
"md-nav__link">
1481 <li class=
"md-nav__item">
1482 <a href=
"../pip/pip/" class=
"md-nav__link">
1495 <li class=
"md-nav__item">
1496 <a href=
"../pip/script/" class=
"md-nav__link">
1509 <li class=
"md-nav__item">
1510 <a href=
"../pip/smiley/" class=
"md-nav__link">
1523 <li class=
"md-nav__item">
1524 <a href=
"../pip/sql/" class=
"md-nav__link">
1537 <li class=
"md-nav__item">
1538 <a href=
"../pip/style/" class=
"md-nav__link">
1551 <li class=
"md-nav__item">
1552 <a href=
"../pip/template/" class=
"md-nav__link">
1565 <li class=
"md-nav__item">
1566 <a href=
"../pip/template-delete/" class=
"md-nav__link">
1579 <li class=
"md-nav__item">
1580 <a href=
"../pip/template-listener/" class=
"md-nav__link">
1593 <li class=
"md-nav__item">
1594 <a href=
"../pip/user-group-option/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"../pip/user-menu/" class=
"md-nav__link">
1621 <li class=
"md-nav__item">
1622 <a href=
"../pip/user-notification-event/" class=
"md-nav__link">
1623 userNotificationEvent
1635 <li class=
"md-nav__item">
1636 <a href=
"../pip/user-option/" class=
"md-nav__link">
1649 <li class=
"md-nav__item">
1650 <a href=
"../pip/user-profile-menu/" class=
"md-nav__link">
1672 <li class=
"md-nav__item md-nav__item--active">
1674 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1680 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1682 <span class=
"md-nav__icon md-icon"></span>
1685 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1691 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1698 <label class=
"md-nav__title" for=
"__toc">
1699 <span class=
"md-nav__icon md-icon"></span>
1702 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1704 <li class=
"md-nav__item">
1705 <a href=
"#database-tables" class=
"md-nav__link">
1711 <li class=
"md-nav__item">
1712 <a href=
"#columns" class=
"md-nav__link">
1718 <li class=
"md-nav__item">
1719 <a href=
"#foreign-keys" class=
"md-nav__link">
1725 <li class=
"md-nav__item">
1726 <a href=
"#indices" class=
"md-nav__link">
1755 <li class=
"md-nav__item md-nav__item--nested">
1758 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1763 <label class=
"md-nav__link" for=
"__nav_6">
1765 <span class=
"md-nav__icon md-icon"></span>
1768 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1769 <label class=
"md-nav__title" for=
"__nav_6">
1770 <span class=
"md-nav__icon md-icon"></span>
1773 <ul class=
"md-nav__list" data-md-scrollfix
>
1781 <li class=
"md-nav__item md-nav__item--nested">
1784 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1789 <label class=
"md-nav__link" for=
"__nav_6_1">
1790 From WoltLab Suite
5.5
1791 <span class=
"md-nav__icon md-icon"></span>
1794 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.5" data-md-level=
"2">
1795 <label class=
"md-nav__title" for=
"__nav_6_1">
1796 <span class=
"md-nav__icon md-icon"></span>
1797 From WoltLab Suite
5.5
1799 <ul class=
"md-nav__list" data-md-scrollfix
>
1806 <li class=
"md-nav__item">
1807 <a href=
"../../migration/wsc55/php/" class=
"md-nav__link">
1820 <li class=
"md-nav__item">
1821 <a href=
"../../migration/wsc55/javascript/" class=
"md-nav__link">
1822 TypeScript and JavaScript
1834 <li class=
"md-nav__item">
1835 <a href=
"../../migration/wsc55/templates/" class=
"md-nav__link">
1848 <li class=
"md-nav__item">
1849 <a href=
"../../migration/wsc55/icons/" class=
"md-nav__link">
1862 <li class=
"md-nav__item">
1863 <a href=
"../../migration/wsc55/dialogs/" class=
"md-nav__link">
1876 <li class=
"md-nav__item">
1877 <a href=
"../../migration/wsc55/libraries/" class=
"md-nav__link">
1878 Third Party Libraries
1890 <li class=
"md-nav__item">
1891 <a href=
"../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1892 Deprecations and Removals
1912 <li class=
"md-nav__item md-nav__item--nested">
1915 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1920 <label class=
"md-nav__link" for=
"__nav_6_2">
1921 From WoltLab Suite
5.4
1922 <span class=
"md-nav__icon md-icon"></span>
1925 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.4" data-md-level=
"2">
1926 <label class=
"md-nav__title" for=
"__nav_6_2">
1927 <span class=
"md-nav__icon md-icon"></span>
1928 From WoltLab Suite
5.4
1930 <ul class=
"md-nav__list" data-md-scrollfix
>
1937 <li class=
"md-nav__item">
1938 <a href=
"../../migration/wsc54/php/" class=
"md-nav__link">
1951 <li class=
"md-nav__item">
1952 <a href=
"../../migration/wsc54/javascript/" class=
"md-nav__link">
1953 TypeScript and JavaScript
1965 <li class=
"md-nav__item">
1966 <a href=
"../../migration/wsc54/templates/" class=
"md-nav__link">
1979 <li class=
"md-nav__item">
1980 <a href=
"../../migration/wsc54/libraries/" class=
"md-nav__link">
1981 Third Party Libraries
1993 <li class=
"md-nav__item">
1994 <a href=
"../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
1995 Deprecations and Removals
2015 <li class=
"md-nav__item md-nav__item--nested">
2018 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
2023 <label class=
"md-nav__link" for=
"__nav_6_3">
2024 From WoltLab Suite
5.3
2025 <span class=
"md-nav__icon md-icon"></span>
2028 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.3" data-md-level=
"2">
2029 <label class=
"md-nav__title" for=
"__nav_6_3">
2030 <span class=
"md-nav__icon md-icon"></span>
2031 From WoltLab Suite
5.3
2033 <ul class=
"md-nav__list" data-md-scrollfix
>
2040 <li class=
"md-nav__item">
2041 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
2054 <li class=
"md-nav__item">
2055 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
2056 Session Handling and Authentication
2068 <li class=
"md-nav__item">
2069 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
2070 TypeScript and JavaScript
2082 <li class=
"md-nav__item">
2083 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
2096 <li class=
"md-nav__item">
2097 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
2098 Third Party Libraries
2118 <li class=
"md-nav__item md-nav__item--nested">
2121 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
2126 <label class=
"md-nav__link" for=
"__nav_6_4">
2127 From WoltLab Suite
5.2
2128 <span class=
"md-nav__icon md-icon"></span>
2131 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.2" data-md-level=
"2">
2132 <label class=
"md-nav__title" for=
"__nav_6_4">
2133 <span class=
"md-nav__icon md-icon"></span>
2134 From WoltLab Suite
5.2
2136 <ul class=
"md-nav__list" data-md-scrollfix
>
2143 <li class=
"md-nav__item">
2144 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
2157 <li class=
"md-nav__item">
2158 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
2159 Templates and Languages
2171 <li class=
"md-nav__item">
2172 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
2173 Third Party Libraries
2193 <li class=
"md-nav__item md-nav__item--nested">
2196 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
2201 <label class=
"md-nav__link" for=
"__nav_6_5">
2202 From WoltLab Suite
3.1
2203 <span class=
"md-nav__icon md-icon"></span>
2206 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.1" data-md-level=
"2">
2207 <label class=
"md-nav__title" for=
"__nav_6_5">
2208 <span class=
"md-nav__icon md-icon"></span>
2209 From WoltLab Suite
3.1
2211 <ul class=
"md-nav__list" data-md-scrollfix
>
2218 <li class=
"md-nav__item">
2219 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
2240 <li class=
"md-nav__item md-nav__item--nested">
2243 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_6" type=
"checkbox" id=
"__nav_6_6" >
2248 <label class=
"md-nav__link" for=
"__nav_6_6">
2249 From WoltLab Suite
3.0
2250 <span class=
"md-nav__icon md-icon"></span>
2253 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.0" data-md-level=
"2">
2254 <label class=
"md-nav__title" for=
"__nav_6_6">
2255 <span class=
"md-nav__icon md-icon"></span>
2256 From WoltLab Suite
3.0
2258 <ul class=
"md-nav__list" data-md-scrollfix
>
2265 <li class=
"md-nav__item">
2266 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
2279 <li class=
"md-nav__item">
2280 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
2293 <li class=
"md-nav__item">
2294 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
2307 <li class=
"md-nav__item">
2308 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
2321 <li class=
"md-nav__item">
2322 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
2343 <li class=
"md-nav__item md-nav__item--nested">
2346 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_7" type=
"checkbox" id=
"__nav_6_7" >
2351 <label class=
"md-nav__link" for=
"__nav_6_7">
2353 <span class=
"md-nav__icon md-icon"></span>
2356 <nav class=
"md-nav" aria-label=
"From WCF 2.1" data-md-level=
"2">
2357 <label class=
"md-nav__title" for=
"__nav_6_7">
2358 <span class=
"md-nav__icon md-icon"></span>
2361 <ul class=
"md-nav__list" data-md-scrollfix
>
2368 <li class=
"md-nav__item">
2369 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
2382 <li class=
"md-nav__item">
2383 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
2396 <li class=
"md-nav__item">
2397 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
2410 <li class=
"md-nav__item">
2411 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
2440 <li class=
"md-nav__item md-nav__item--nested">
2443 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2448 <label class=
"md-nav__link" for=
"__nav_7">
2450 <span class=
"md-nav__icon md-icon"></span>
2453 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2454 <label class=
"md-nav__title" for=
"__nav_7">
2455 <span class=
"md-nav__icon md-icon"></span>
2458 <ul class=
"md-nav__list" data-md-scrollfix
>
2466 <li class=
"md-nav__item md-nav__item--nested">
2469 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2474 <label class=
"md-nav__link" for=
"__nav_7_1">
2476 <span class=
"md-nav__icon md-icon"></span>
2479 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2480 <label class=
"md-nav__title" for=
"__nav_7_1">
2481 <span class=
"md-nav__icon md-icon"></span>
2484 <ul class=
"md-nav__list" data-md-scrollfix
>
2491 <li class=
"md-nav__item">
2492 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2505 <li class=
"md-nav__item">
2506 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2519 <li class=
"md-nav__item">
2520 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2533 <li class=
"md-nav__item">
2534 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2547 <li class=
"md-nav__item">
2548 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
2561 <li class=
"md-nav__item">
2562 <a href=
"../../tutorial/series/part_5/" class=
"md-nav__link">
2575 <li class=
"md-nav__item">
2576 <a href=
"../../tutorial/series/part_6/" class=
"md-nav__link">
2605 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2606 <div class=
"md-sidebar__scrollwrap">
2607 <div class=
"md-sidebar__inner">
2610 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2617 <label class=
"md-nav__title" for=
"__toc">
2618 <span class=
"md-nav__icon md-icon"></span>
2621 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2623 <li class=
"md-nav__item">
2624 <a href=
"#database-tables" class=
"md-nav__link">
2630 <li class=
"md-nav__item">
2631 <a href=
"#columns" class=
"md-nav__link">
2637 <li class=
"md-nav__item">
2638 <a href=
"#foreign-keys" class=
"md-nav__link">
2644 <li class=
"md-nav__item">
2645 <a href=
"#indices" class=
"md-nav__link">
2660 <div class=
"md-content" data-md-component=
"content">
2661 <article class=
"md-content__inner md-typeset">
2665 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/6.0/docs/package/database-php-api.md" title=
"Edit this page" class=
"md-content__button md-icon">
2667 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
2671 <h1 id=
"database-php-api">Database PHP API
<a class=
"headerlink" href=
"#database-php-api" title=
"Permanent link">#
</a></h1>
2672 <p>While the
<a href=
"../pip/sql/">sql
</a> package installation plugin supports adding and removing tables, columns, and indices, it is not able to handle cases where the added table, column, or index already exist.
2673 We have added a new PHP-based API to manipulate the database scheme which can be used in combination with the
<a href=
"../pip/script/">script
</a> package installation plugin that skips parts that already exist:
</p>
2674 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2675 <span class=
"normal"> 2</span>
2676 <span class=
"normal"> 3</span>
2677 <span class=
"normal"> 4</span>
2678 <span class=
"normal"> 5</span>
2679 <span class=
"normal"> 6</span>
2680 <span class=
"normal"> 7</span>
2681 <span class=
"normal"> 8</span>
2682 <span class=
"normal"> 9</span>
2683 <span class=
"normal">10</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nv">$tables
</span> <span class=
"o">=
</span> <span class=
"p">[
</span>
2684 <span class=
"c1">// list of `DatabaseTable` objects
</span>
2685 <span class=
"p">];
</span>
2687 <span class=
"p">(
</span><span class=
"k">new
</span> <span class=
"nx">DatabaseTableChangeProcessor
</span><span class=
"p">(
</span>
2688 <span class=
"sd">/** @var ScriptPackageInstallationPlugin $this */
</span>
2689 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">installation
</span><span class=
"o">-
></span><span class=
"na">getPackage
</span><span class=
"p">(),
</span>
2690 <span class=
"nv">$tables
</span><span class=
"p">,
</span>
2691 <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getDB
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getEditor
</span><span class=
"p">())
</span>
2692 <span class=
"p">)
</span><span class=
"o">-
></span><span class=
"na">process
</span><span class=
"p">();
</span>
2693 </code></pre></div></td></tr></table></div>
2694 <p>All of the relevant components can be found in the
<code>wcf\system\database\table
</code> namespace.
</p>
2695 <p>With WoltLab Suite
5.4, you should use the new
<a href=
"../pip/database/">database
</a> package installation plugin for which you only have to return the array of affected database tables:
</p>
2696 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2697 <span class=
"normal">2</span>
2698 <span class=
"normal">3</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"k">return
</span> <span class=
"p">[
</span>
2699 <span class=
"c1">// list of `DatabaseTable` objects
</span>
2700 <span class=
"p">];
</span>
2701 </code></pre></div></td></tr></table></div>
2702 <h2 id=
"database-tables">Database Tables
<a class=
"headerlink" href=
"#database-tables" title=
"Permanent link">#
</a></h2>
2703 <p>There are two classes representing database tables:
<code>DatabaseTable
</code> and
<code>PartialDatabaseTable
</code>.
2704 If a new table should be created, use
<code>DatabaseTable
</code>.
2705 In all other cases,
<code>PartialDatabaseTable
</code> should be used as it provides an additional save-guard against accidentally creating a new table by having a typo in the table name:
2706 If the tables does not already exist, a table represented by
<code>PartialDatabaseTable
</code> will cause an exception (while a
<code>DatabaseTable
</code> table will simply be created).
</p>
2707 <p>To create a table, a
<code>DatabaseTable
</code> object with the table's name as to be created and table's columns, foreign keys and indices have to be specified:
</p>
2708 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2709 <span class=
"normal"> 2</span>
2710 <span class=
"normal"> 3</span>
2711 <span class=
"normal"> 4</span>
2712 <span class=
"normal"> 5</span>
2713 <span class=
"normal"> 6</span>
2714 <span class=
"normal"> 7</span>
2715 <span class=
"normal"> 8</span>
2716 <span class=
"normal"> 9</span>
2717 <span class=
"normal">10</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">DatabaseTable
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'foo1_bar
'</span><span class=
"p">)
</span>
2718 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span>
2719 <span class=
"c1">// columns
</span>
2720 <span class=
"p">])
</span>
2721 <span class=
"o">-
></span><span class=
"na">foreignKeys
</span><span class=
"p">([
</span>
2722 <span class=
"c1">// foreign keys
</span>
2723 <span class=
"p">])
</span>
2724 <span class=
"o">-
></span><span class=
"na">indices
</span><span class=
"p">([
</span>
2725 <span class=
"c1">// indices
</span>
2726 <span class=
"p">])
</span>
2727 </code></pre></div></td></tr></table></div>
2728 <p>To update a table, the same code as above can be used, except for
<code>PartialDatabaseTable
</code> being used instead of
<code>DatabaseTable
</code>.
</p>
2729 <p>To drop a table, only the
<code>drop()
</code> method has to be called:
</p>
2730 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2731 <span class=
"normal">2</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">PartialDatabaseTable
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'foo1_bar
'</span><span class=
"p">)
</span>
2732 <span class=
"o">-
></span><span class=
"na">drop
</span><span class=
"p">()
</span>
2733 </code></pre></div></td></tr></table></div>
2734 <h2 id=
"columns">Columns
<a class=
"headerlink" href=
"#columns" title=
"Permanent link">#
</a></h2>
2735 <p>To represent a column of a database table, you have to create an instance of the relevant column class found in the
<code>wcf\system\database\table\column
</code> namespace.
2736 Such instances are created similarly to database table objects using the
<code>create()
</code> factory method and passing the column name as the parameter.
</p>
2737 <p>Every column type supports the following methods:
</p>
2739 <li><code>defaultValue($defaultValue)
</code> sets the default value of the column (default: none).
</li>
2740 <li><code>drop()
</code> to drop the column.
</li>
2741 <li><code>notNull($notNull = true)
</code> sets if the value of the column can be
<code>NULL
</code> (default:
<code>false
</code>).
</li>
2743 <p>Depending on the specific column class implementing additional interfaces, the following methods are also available:
</p>
2745 <li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)
</code> sets if the value of the colum is auto-incremented.
</li>
2746 <li><code>IDecimalsDatabaseTableColumn::decimals($decimals)
</code> sets the number of decimals the column supports.
</li>
2747 <li><code>IEnumDatabaseTableColumn::enumValues(array $values)
</code> sets the predetermined set of valid values of the column.
</li>
2748 <li><code>ILengthDatabaseTableColumn::length($length)
</code> sets the (maximum) length of the column.
</li>
2750 <p>Additionally, there are some additionally classes of commonly used columns with specific properties:
</p>
2752 <li><code>DefaultFalseBooleanDatabaseTableColumn
</code> (a
<code>tinyint
</code> column with length
<code>1</code>, default value
<code>0</code> and whose values cannot be
<code>null
</code>)
</li>
2753 <li><code>DefaultTrueBooleanDatabaseTableColumn
</code> (a
<code>tinyint
</code> column with length
<code>0</code>, default value
<code>0</code> and whose values cannot be
<code>null
</code>)
</li>
2754 <li><code>NotNullInt10DatabaseTableColumn
</code> (a
<code>int
</code> column with length
<code>10</code> and whose values cannot be
<code>null
</code>)
</li>
2755 <li><code>NotNullVarchar191DatabaseTableColumn
</code> (a
<code>varchar
</code> column with length
<code>191</code> and whose values cannot be
<code>null
</code>)
</li>
2756 <li><code>NotNullVarchar255DatabaseTableColumn
</code> (a
<code>varchar
</code> column with length
<code>255</code> and whose values cannot be
<code>null
</code>)
</li>
2757 <li><code>ObjectIdDatabaseTableColumn
</code> (a
<code>int
</code> column with length
<code>10</code>, whose values cannot be
<code>null
</code>, and whose values are auto-incremented)
</li>
2760 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2761 <span class=
"normal">2</span>
2762 <span class=
"normal">3</span>
2763 <span class=
"normal">4</span>
2764 <span class=
"normal">5</span>
2765 <span class=
"normal">6</span>
2766 <span class=
"normal">7</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">DefaultFalseBooleanDatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'isDisabled
'</span><span class=
"p">)
</span>
2768 <span class=
"nx">NotNullInt10DatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'fooTypeID
'</span><span class=
"p">)
</span>
2770 <span class=
"nx">SmallintDatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'bar
'</span><span class=
"p">)
</span>
2771 <span class=
"o">-
></span><span class=
"na">length
</span><span class=
"p">(
</span><span class=
"mi">5</span><span class=
"p">)
</span>
2772 <span class=
"o">-
></span><span class=
"na">notNull
</span><span class=
"p">()
</span>
2773 </code></pre></div></td></tr></table></div>
2774 <h2 id=
"foreign-keys">Foreign Keys
<a class=
"headerlink" href=
"#foreign-keys" title=
"Permanent link">#
</a></h2>
2775 <p>Foreign keys are represented by
<code>DatabaseTableForeignKey
</code> objects:
</p>
2776 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2777 <span class=
"normal">2</span>
2778 <span class=
"normal">3</span>
2779 <span class=
"normal">4</span>
2780 <span class=
"normal">5</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">DatabaseTableForeignKey
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">()
</span>
2781 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
2782 <span class=
"o">-
></span><span class=
"na">referencedTable
</span><span class=
"p">(
</span><span class=
"s1">'wcf1_foo
'</span><span class=
"p">)
</span>
2783 <span class=
"o">-
></span><span class=
"na">referencedColumns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
2784 <span class=
"o">-
></span><span class=
"na">onDelete
</span><span class=
"p">(
</span><span class=
"s1">'CASCADE
'</span><span class=
"p">)
</span>
2785 </code></pre></div></td></tr></table></div>
2786 <p>The supported actions for
<code>onDelete()
</code> and
<code>onUpdate()
</code> are
<code>CASCADE
</code>,
<code>NO ACTION
</code>, and
<code>SET NULL
</code>.
2787 To drop a foreign key, all of the relevant data to create the foreign key has to be present and the
<code>drop()
</code> method has to be called.
</p>
2788 <p><code>DatabaseTableForeignKey::create()
</code> also supports the foreign key name as a parameter.
2789 If it is not present,
<code>DatabaseTable::foreignKeys()
</code> will automatically set one based on the foreign key's data.
</p>
2790 <h2 id=
"indices">Indices
<a class=
"headerlink" href=
"#indices" title=
"Permanent link">#
</a></h2>
2791 <p>Indices are represented by
<code>DatabaseTableIndex
</code> objects:
</p>
2792 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2793 <span class=
"normal">2</span>
2794 <span class=
"normal">3</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">DatabaseTableIndex
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'fooID
'</span><span class=
"p">)
</span>
2795 <span class=
"o">-
></span><span class=
"na">type
</span><span class=
"p">(
</span><span class=
"nx">DatabaseTableIndex
</span><span class=
"o">::
</span><span class=
"na">UNIQUE_TYPE
</span><span class=
"p">)
</span>
2796 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
2797 </code></pre></div></td></tr></table></div>
2798 <p>There are four different types:
<code>DatabaseTableIndex::DEFAULT_TYPE
</code> (default),
<code>DatabaseTableIndex::PRIMARY_TYPE
</code>,
<code>DatabaseTableIndex::UNIQUE_TYPE
</code>, and
<code>DatabaseTableIndex::FULLTEXT_TYPE
</code>.
2799 For primary keys, there is also the
<code>DatabaseTablePrimaryIndex
</code> class which automatically sets the type to
<code>DatabaseTableIndex::PRIMARY_TYPE
</code>.
2800 To drop a index, all of the relevant data to create the index has to be present and the
<code>drop()
</code> method has to be called.
</p>
2801 <p>The index name is specified as the parameter to
<code>DatabaseTableIndex::create()
</code>.
2802 It is strongly recommended to specify an explicit name (
<a href=
"https://github.com/WoltLab/WCF/issues/4505">WoltLab/WCF#
4505</a>).
2803 If no name is given,
<code>DatabaseTable::indices()
</code> will automatically set one based on the index data.
</p>
2806 <div class=
"md-source-file">
2828 <footer class=
"md-footer">
2831 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer" >
2834 <a href=
"../pip/user-profile-menu/" class=
"md-footer__link md-footer__link--prev" aria-label=
"Previous: userProfileMenu" rel=
"prev">
2835 <div class=
"md-footer__button md-icon">
2836 <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>
2838 <div class=
"md-footer__title">
2839 <div class=
"md-ellipsis">
2840 <span class=
"md-footer__direction">
2850 <a href=
"../../migration/wsc55/php/" class=
"md-footer__link md-footer__link--next" aria-label=
"Next: PHP API" rel=
"next">
2851 <div class=
"md-footer__title">
2852 <div class=
"md-ellipsis">
2853 <span class=
"md-footer__direction">
2859 <div class=
"md-footer__button md-icon">
2860 <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>
2866 <div class=
"md-footer-meta md-typeset">
2867 <div class=
"md-footer-meta__inner md-grid">
2868 <div class=
"md-copyright">
2870 <div class=
"md-copyright__highlight">
2871 Copyright ©
2020 WoltLab GmbH
2876 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2882 <div class=
"md-copyright">
2883 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2884 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2892 <div class=
"md-dialog" data-md-component=
"dialog">
2893 <div class=
"md-dialog__inner md-typeset"></div>
2896 <script id=
"__config" type=
"application/json">{
"base":
"../..",
"features": [
"navigation.tracking"],
"search":
"../../assets/javascripts/workers/search.5bf1dace.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version.title":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2899 <script src=
"../../assets/javascripts/bundle.078830c0.min.js"></script>