latest/package/database-php-api/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>Database PHP API - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#database-php-api" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  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" data-md-component="logo">
  83
  84   <img src="../../assets/logo.png" alt="logo">
  85
  86     </a>
  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>
  89     </label>
  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
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               Database PHP API
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <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>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <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>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <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>
 120         <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>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <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>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309     <li class="md-nav__item">
 310       <a href="../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 826
 827
 828         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 829
 830       <label class="md-nav__link" for="__nav_5">
 831         Package Components
 832         <span class="md-nav__icon md-icon"></span>
 833       </label>
 834       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 835         <label class="md-nav__title" for="__nav_5">
 836           <span class="md-nav__icon md-icon"></span>
 837           Package Components
 838         </label>
 839         <ul class="md-nav__list" data-md-scrollfix>
 840
 841
 842
 843
 844
 845     <li class="md-nav__item">
 846       <a href="../package-xml/" class="md-nav__link">
 847         package.xml
 848       </a>
 849     </li>
 850
 851
 852
 853
 854
 855
 856
 857
 858     <li class="md-nav__item md-nav__item--nested">
 859
 860
 861         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 862
 863       <label class="md-nav__link" for="__nav_5_2">
 864         PIPs
 865         <span class="md-nav__icon md-icon"></span>
 866       </label>
 867       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 868         <label class="md-nav__title" for="__nav_5_2">
 869           <span class="md-nav__icon md-icon"></span>
 870           PIPs
 871         </label>
 872         <ul class="md-nav__list" data-md-scrollfix>
 873
 874
 875
 876
 877
 878     <li class="md-nav__item">
 879       <a href="../pip/" class="md-nav__link">
 880         Overview
 881       </a>
 882     </li>
 883
 884
 885
 886
 887
 888
 889
 890     <li class="md-nav__item">
 891       <a href="../pip/acl-option/" class="md-nav__link">
 892         aclOption
 893       </a>
 894     </li>
 895
 896
 897
 898
 899
 900
 901
 902     <li class="md-nav__item">
 903       <a href="../pip/acp-menu/" class="md-nav__link">
 904         acpMenu
 905       </a>
 906     </li>
 907
 908
 909
 910
 911
 912
 913
 914     <li class="md-nav__item">
 915       <a href="../pip/acp-search-provider/" class="md-nav__link">
 916         acpSearchProvider
 917       </a>
 918     </li>
 919
 920
 921
 922
 923
 924
 925
 926     <li class="md-nav__item">
 927       <a href="../pip/acp-template/" class="md-nav__link">
 928         acpTemplate
 929       </a>
 930     </li>
 931
 932
 933
 934
 935
 936
 937
 938     <li class="md-nav__item">
 939       <a href="../pip/bbcode/" class="md-nav__link">
 940         bbcode
 941       </a>
 942     </li>
 943
 944
 945
 946
 947
 948
 949
 950     <li class="md-nav__item">
 951       <a href="../pip/box/" class="md-nav__link">
 952         box
 953       </a>
 954     </li>
 955
 956
 957
 958
 959
 960
 961
 962     <li class="md-nav__item">
 963       <a href="../pip/clipboard-action/" class="md-nav__link">
 964         clipboardAction
 965       </a>
 966     </li>
 967
 968
 969
 970
 971
 972
 973
 974     <li class="md-nav__item">
 975       <a href="../pip/core-object/" class="md-nav__link">
 976         coreObject
 977       </a>
 978     </li>
 979
 980
 981
 982
 983
 984
 985
 986     <li class="md-nav__item">
 987       <a href="../pip/cronjob/" class="md-nav__link">
 988         cronjob
 989       </a>
 990     </li>
 991
 992
 993
 994
 995
 996
 997
 998     <li class="md-nav__item">
 999       <a href="../pip/event-listener/" class="md-nav__link">
1000         eventListener
1001       </a>
1002     </li>
1003
1004
1005
1006
1007
1008
1009
1010     <li class="md-nav__item">
1011       <a href="../pip/file/" class="md-nav__link">
1012         file
1013       </a>
1014     </li>
1015
1016
1017
1018
1019
1020
1021
1022     <li class="md-nav__item">
1023       <a href="../pip/language/" class="md-nav__link">
1024         language
1025       </a>
1026     </li>
1027
1028
1029
1030
1031
1032
1033
1034     <li class="md-nav__item">
1035       <a href="../pip/media-provider/" class="md-nav__link">
1036         mediaProvider
1037       </a>
1038     </li>
1039
1040
1041
1042
1043
1044
1045
1046     <li class="md-nav__item">
1047       <a href="../pip/menu/" class="md-nav__link">
1048         menu
1049       </a>
1050     </li>
1051
1052
1053
1054
1055
1056
1057
1058     <li class="md-nav__item">
1059       <a href="../pip/menu-item/" class="md-nav__link">
1060         menuItem
1061       </a>
1062     </li>
1063
1064
1065
1066
1067
1068
1069
1070     <li class="md-nav__item">
1071       <a href="../pip/object-type/" class="md-nav__link">
1072         objectType
1073       </a>
1074     </li>
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../pip/object-type-definition/" class="md-nav__link">
1084         objectTypeDefinition
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094     <li class="md-nav__item">
1095       <a href="../pip/option/" class="md-nav__link">
1096         option
1097       </a>
1098     </li>
1099
1100
1101
1102
1103
1104
1105
1106     <li class="md-nav__item">
1107       <a href="../pip/page/" class="md-nav__link">
1108         page
1109       </a>
1110     </li>
1111
1112
1113
1114
1115
1116
1117
1118     <li class="md-nav__item">
1119       <a href="../pip/pip/" class="md-nav__link">
1120         pip
1121       </a>
1122     </li>
1123
1124
1125
1126
1127
1128
1129
1130     <li class="md-nav__item">
1131       <a href="../pip/script/" class="md-nav__link">
1132         script
1133       </a>
1134     </li>
1135
1136
1137
1138
1139
1140
1141
1142     <li class="md-nav__item">
1143       <a href="../pip/smiley/" class="md-nav__link">
1144         smiley
1145       </a>
1146     </li>
1147
1148
1149
1150
1151
1152
1153
1154     <li class="md-nav__item">
1155       <a href="../pip/sql/" class="md-nav__link">
1156         sql
1157       </a>
1158     </li>
1159
1160
1161
1162
1163
1164
1165
1166     <li class="md-nav__item">
1167       <a href="../pip/style/" class="md-nav__link">
1168         style
1169       </a>
1170     </li>
1171
1172
1173
1174
1175
1176
1177
1178     <li class="md-nav__item">
1179       <a href="../pip/template/" class="md-nav__link">
1180         template
1181       </a>
1182     </li>
1183
1184
1185
1186
1187
1188
1189
1190     <li class="md-nav__item">
1191       <a href="../pip/template-listener/" class="md-nav__link">
1192         templateListener
1193       </a>
1194     </li>
1195
1196
1197
1198
1199
1200
1201
1202     <li class="md-nav__item">
1203       <a href="../pip/user-group-option/" class="md-nav__link">
1204         userGroupOption
1205       </a>
1206     </li>
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../pip/user-menu/" class="md-nav__link">
1216         userMenu
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226     <li class="md-nav__item">
1227       <a href="../pip/user-notification-event/" class="md-nav__link">
1228         userNotificationEvent
1229       </a>
1230     </li>
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../pip/user-option/" class="md-nav__link">
1240         userOption
1241       </a>
1242     </li>
1243
1244
1245
1246
1247
1248
1249
1250     <li class="md-nav__item">
1251       <a href="../pip/user-profile-menu/" class="md-nav__link">
1252         userProfileMenu
1253       </a>
1254     </li>
1255
1256
1257
1258         </ul>
1259       </nav>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item md-nav__item--active">
1271
1272       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1273
1274
1275
1276
1277         <label class="md-nav__link md-nav__link--active" for="__toc">
1278           Database PHP API
1279           <span class="md-nav__icon md-icon"></span>
1280         </label>
1281
1282       <a href="./" class="md-nav__link md-nav__link--active">
1283         Database PHP API
1284       </a>
1285
1286
1287 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1288
1289
1290
1291
1292
1293     <label class="md-nav__title" for="__toc">
1294       <span class="md-nav__icon md-icon"></span>
1295       Table of contents
1296     </label>
1297     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1298
1299         <li class="md-nav__item">
1300   <a href="#database-tables" class="md-nav__link">
1301     Database Tables
1302   </a>
1303
1304 </li>
1305
1306         <li class="md-nav__item">
1307   <a href="#columns" class="md-nav__link">
1308     Columns
1309   </a>
1310
1311 </li>
1312
1313         <li class="md-nav__item">
1314   <a href="#foreign-keys" class="md-nav__link">
1315     Foreign Keys
1316   </a>
1317
1318 </li>
1319
1320         <li class="md-nav__item">
1321   <a href="#indices" class="md-nav__link">
1322     Indices
1323   </a>
1324
1325 </li>
1326
1327     </ul>
1328
1329 </nav>
1330
1331     </li>
1332
1333
1334
1335         </ul>
1336       </nav>
1337     </li>
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349     <li class="md-nav__item md-nav__item--nested">
1350
1351
1352         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1353
1354       <label class="md-nav__link" for="__nav_6">
1355         Migration
1356         <span class="md-nav__icon md-icon"></span>
1357       </label>
1358       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1359         <label class="md-nav__title" for="__nav_6">
1360           <span class="md-nav__icon md-icon"></span>
1361           Migration
1362         </label>
1363         <ul class="md-nav__list" data-md-scrollfix>
1364
1365
1366
1367
1368
1369
1370     <li class="md-nav__item md-nav__item--nested">
1371
1372
1373         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1374
1375       <label class="md-nav__link" for="__nav_6_1">
1376         Migrating from WSC 5.3
1377         <span class="md-nav__icon md-icon"></span>
1378       </label>
1379       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1380         <label class="md-nav__title" for="__nav_6_1">
1381           <span class="md-nav__icon md-icon"></span>
1382           Migrating from WSC 5.3
1383         </label>
1384         <ul class="md-nav__list" data-md-scrollfix>
1385
1386
1387
1388
1389
1390     <li class="md-nav__item">
1391       <a href="../../migration/wsc53/php/" class="md-nav__link">
1392         PHP API
1393       </a>
1394     </li>
1395
1396
1397
1398
1399
1400
1401
1402     <li class="md-nav__item">
1403       <a href="../../migration/wsc53/session/" class="md-nav__link">
1404         Session Handling and Authentication
1405       </a>
1406     </li>
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1416         JavaScript
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426     <li class="md-nav__item">
1427       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1428         Templates
1429       </a>
1430     </li>
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1440         Third Party Libraries
1441       </a>
1442     </li>
1443
1444
1445
1446         </ul>
1447       </nav>
1448     </li>
1449
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item md-nav__item--nested">
1458
1459
1460         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1461
1462       <label class="md-nav__link" for="__nav_6_2">
1463         Migrating from WSC 5.2
1464         <span class="md-nav__icon md-icon"></span>
1465       </label>
1466       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1467         <label class="md-nav__title" for="__nav_6_2">
1468           <span class="md-nav__icon md-icon"></span>
1469           Migrating from WSC 5.2
1470         </label>
1471         <ul class="md-nav__list" data-md-scrollfix>
1472
1473
1474
1475
1476
1477     <li class="md-nav__item">
1478       <a href="../../migration/wsc52/php/" class="md-nav__link">
1479         PHP API
1480       </a>
1481     </li>
1482
1483
1484
1485
1486
1487
1488
1489     <li class="md-nav__item">
1490       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1491         Templates and Languages
1492       </a>
1493     </li>
1494
1495
1496
1497
1498
1499
1500
1501     <li class="md-nav__item">
1502       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1503         Third Party Libraries
1504       </a>
1505     </li>
1506
1507
1508
1509         </ul>
1510       </nav>
1511     </li>
1512
1513
1514
1515
1516
1517
1518
1519
1520     <li class="md-nav__item md-nav__item--nested">
1521
1522
1523         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1524
1525       <label class="md-nav__link" for="__nav_6_3">
1526         Migrating from WSC 3.1
1527         <span class="md-nav__icon md-icon"></span>
1528       </label>
1529       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1530         <label class="md-nav__title" for="__nav_6_3">
1531           <span class="md-nav__icon md-icon"></span>
1532           Migrating from WSC 3.1
1533         </label>
1534         <ul class="md-nav__list" data-md-scrollfix>
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../../migration/wsc31/php/" class="md-nav__link">
1542         PHP API
1543       </a>
1544     </li>
1545
1546
1547
1548         </ul>
1549       </nav>
1550     </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559     <li class="md-nav__item md-nav__item--nested">
1560
1561
1562         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1563
1564       <label class="md-nav__link" for="__nav_6_4">
1565         Migrating from WSC 3.0
1566         <span class="md-nav__icon md-icon"></span>
1567       </label>
1568       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1569         <label class="md-nav__title" for="__nav_6_4">
1570           <span class="md-nav__icon md-icon"></span>
1571           Migrating from WSC 3.0
1572         </label>
1573         <ul class="md-nav__list" data-md-scrollfix>
1574
1575
1576
1577
1578
1579     <li class="md-nav__item">
1580       <a href="../../migration/wsc30/php/" class="md-nav__link">
1581         PHP API
1582       </a>
1583     </li>
1584
1585
1586
1587
1588
1589
1590
1591     <li class="md-nav__item">
1592       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1593         JavaScript API
1594       </a>
1595     </li>
1596
1597
1598
1599
1600
1601
1602
1603     <li class="md-nav__item">
1604       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1605         Templates
1606       </a>
1607     </li>
1608
1609
1610
1611
1612
1613
1614
1615     <li class="md-nav__item">
1616       <a href="../../migration/wsc30/css/" class="md-nav__link">
1617         CSS
1618       </a>
1619     </li>
1620
1621
1622
1623
1624
1625
1626
1627     <li class="md-nav__item">
1628       <a href="../../migration/wsc30/package/" class="md-nav__link">
1629         Package Components
1630       </a>
1631     </li>
1632
1633
1634
1635         </ul>
1636       </nav>
1637     </li>
1638
1639
1640
1641
1642
1643
1644
1645
1646     <li class="md-nav__item md-nav__item--nested">
1647
1648
1649         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1650
1651       <label class="md-nav__link" for="__nav_6_5">
1652         Migrating from WCF 2.1
1653         <span class="md-nav__icon md-icon"></span>
1654       </label>
1655       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1656         <label class="md-nav__title" for="__nav_6_5">
1657           <span class="md-nav__icon md-icon"></span>
1658           Migrating from WCF 2.1
1659         </label>
1660         <ul class="md-nav__list" data-md-scrollfix>
1661
1662
1663
1664
1665
1666     <li class="md-nav__item">
1667       <a href="../../migration/wcf21/php/" class="md-nav__link">
1668         PHP API
1669       </a>
1670     </li>
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1680         Templates
1681       </a>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690     <li class="md-nav__item">
1691       <a href="../../migration/wcf21/css/" class="md-nav__link">
1692         CSS
1693       </a>
1694     </li>
1695
1696
1697
1698
1699
1700
1701
1702     <li class="md-nav__item">
1703       <a href="../../migration/wcf21/package/" class="md-nav__link">
1704         Package Components
1705       </a>
1706     </li>
1707
1708
1709
1710         </ul>
1711       </nav>
1712     </li>
1713
1714
1715
1716         </ul>
1717       </nav>
1718     </li>
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730     <li class="md-nav__item md-nav__item--nested">
1731
1732
1733         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1734
1735       <label class="md-nav__link" for="__nav_7">
1736         Tutorials
1737         <span class="md-nav__icon md-icon"></span>
1738       </label>
1739       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1740         <label class="md-nav__title" for="__nav_7">
1741           <span class="md-nav__icon md-icon"></span>
1742           Tutorials
1743         </label>
1744         <ul class="md-nav__list" data-md-scrollfix>
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item md-nav__item--nested">
1752
1753
1754         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1755
1756       <label class="md-nav__link" for="__nav_7_1">
1757         Tutorial Series
1758         <span class="md-nav__icon md-icon"></span>
1759       </label>
1760       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1761         <label class="md-nav__title" for="__nav_7_1">
1762           <span class="md-nav__icon md-icon"></span>
1763           Tutorial Series
1764         </label>
1765         <ul class="md-nav__list" data-md-scrollfix>
1766
1767
1768
1769
1770
1771     <li class="md-nav__item">
1772       <a href="../../tutorial/series/overview/" class="md-nav__link">
1773         Overview
1774       </a>
1775     </li>
1776
1777
1778
1779
1780
1781
1782
1783     <li class="md-nav__item">
1784       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1785         Part 1
1786       </a>
1787     </li>
1788
1789
1790
1791
1792
1793
1794
1795     <li class="md-nav__item">
1796       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1797         Part 2
1798       </a>
1799     </li>
1800
1801
1802
1803
1804
1805
1806
1807     <li class="md-nav__item">
1808       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1809         Part 3
1810       </a>
1811     </li>
1812
1813
1814
1815         </ul>
1816       </nav>
1817     </li>
1818
1819
1820
1821         </ul>
1822       </nav>
1823     </li>
1824
1825
1826
1827   </ul>
1828 </nav>
1829                   </div>
1830                 </div>
1831               </div>
1832
1833
1834
1835               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1836                 <div class="md-sidebar__scrollwrap">
1837                   <div class="md-sidebar__inner">
1838
1839 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1840
1841
1842
1843
1844
1845     <label class="md-nav__title" for="__toc">
1846       <span class="md-nav__icon md-icon"></span>
1847       Table of contents
1848     </label>
1849     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1850
1851         <li class="md-nav__item">
1852   <a href="#database-tables" class="md-nav__link">
1853     Database Tables
1854   </a>
1855
1856 </li>
1857
1858         <li class="md-nav__item">
1859   <a href="#columns" class="md-nav__link">
1860     Columns
1861   </a>
1862
1863 </li>
1864
1865         <li class="md-nav__item">
1866   <a href="#foreign-keys" class="md-nav__link">
1867     Foreign Keys
1868   </a>
1869
1870 </li>
1871
1872         <li class="md-nav__item">
1873   <a href="#indices" class="md-nav__link">
1874     Indices
1875   </a>
1876
1877 </li>
1878
1879     </ul>
1880
1881 </nav>
1882                   </div>
1883                 </div>
1884               </div>
1885
1886
1887           <div class="md-content" data-md-component="content">
1888             <article class="md-content__inner md-typeset">
1889
1890
1891                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/database-php-api.md" title="Edit this page" class="md-content__button md-icon">
1892                     <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>
1893                   </a>
1894
1895
1896                 <h1 id="database-php-api">Database PHP API<a class="headerlink" href="#database-php-api" title="Permanent link">#</a></h1>
1897 <div class="admonition info">
1898 <p class="admonition-title">Available since WoltLab Suite 5.2.</p>
1899 </div>
1900 <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.
1901 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>
1902 <div class="highlight"><pre><span></span><code><span class="nv">$tables</span> <span class="o">=</span> <span class="p">[</span>
1903     <span class="c1">// list of `DatabaseTable` objects</span>
1904 <span class="p">];</span>
1905
1906 <span class="p">(</span><span class="k">new</span> <span class="nx">DatabaseTableChangeProcessor</span><span class="p">(</span>
1907     <span class="sd">/** @var ScriptPackageInstallationPlugin $this */</span>
1908     <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">installation</span><span class="o">-&gt;</span><span class="na">getPackage</span><span class="p">(),</span>
1909     <span class="nv">$tables</span><span class="p">,</span>
1910     <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getEditor</span><span class="p">())</span>
1911 <span class="p">)</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">();</span>
1912 </code></pre></div>
1913 <p>All of the relevant components can be found in the <code>wcf\system\database\table</code> namespace.</p>
1914 <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>
1915 <div class="highlight"><pre><span></span><code><span class="k">return</span> <span class="p">[</span>
1916     <span class="c1">// list of `DatabaseTable` objects</span>
1917 <span class="p">];</span>
1918 </code></pre></div>
1919 <h2 id="database-tables">Database Tables<a class="headerlink" href="#database-tables" title="Permanent link">#</a></h2>
1920 <p>There are two classes representing database tables: <code>DatabaseTable</code> and <code>PartialDatabaseTable</code>.
1921 If a new table should be created, use <code>DatabaseTable</code>.
1922 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:
1923 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>
1924 <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>
1925 <div class="highlight"><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">&#39;foo1_bar&#39;</span><span class="p">)</span>
1926     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
1927         <span class="c1">// columns</span>
1928     <span class="p">])</span>
1929     <span class="o">-&gt;</span><span class="na">foreignKeys</span><span class="p">([</span>
1930         <span class="c1">// foreign keys</span>
1931     <span class="p">])</span>
1932     <span class="o">-&gt;</span><span class="na">indices</span><span class="p">([</span>
1933         <span class="c1">// indices</span>
1934     <span class="p">])</span>
1935 </code></pre></div>
1936 <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>
1937 <p>To drop a table, only the <code>drop()</code> method has to be called:</p>
1938 <div class="highlight"><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">&#39;foo1_bar&#39;</span><span class="p">)</span>
1939     <span class="o">-&gt;</span><span class="na">drop</span><span class="p">()</span>
1940 </code></pre></div>
1941 <h2 id="columns">Columns<a class="headerlink" href="#columns" title="Permanent link">#</a></h2>
1942 <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.
1943 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>
1944 <p>Every column type supports the following methods:</p>
1945 <ul>
1946 <li><code>defaultValue($defaultValue)</code> sets the default value of the column (default: none).</li>
1947 <li><code>drop()</code> to drop the column.</li>
1948 <li><code>notNull($notNull = true)</code> sets if the value of the column can be <code>NULL</code> (default: <code>false</code>).</li>
1949 </ul>
1950 <p>Depending on the specific column class implementing additional interfaces, the following methods are also available:</p>
1951 <ul>
1952 <li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)</code> sets if the value of the colum is auto-incremented.</li>
1953 <li><code>IDecimalsDatabaseTableColumn::decimals($decimals)</code> sets the number of decimals the column supports.</li>
1954 <li><code>IEnumDatabaseTableColumn::enumValues(array $values)</code> sets the predetermined set of valid values of the column.</li>
1955 <li><code>ILengthDatabaseTableColumn::length($length)</code> sets the (maximum) length of the column.</li>
1956 </ul>
1957 <p>Additionally, there are some additionally classes of commonly used columns with specific properties:</p>
1958 <ul>
1959 <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>
1960 <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>
1961 <li><code>NotNullInt10DatabaseTableColumn</code> (a <code>int</code> column with length <code>10</code> and whose values cannot be <code>null</code>)</li>
1962 <li><code>NotNullVarchar191DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>191</code> and whose values cannot be <code>null</code>)</li>
1963 <li><code>NotNullVarchar255DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>255</code> and whose values cannot be <code>null</code>)</li>
1964 <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>
1965 </ul>
1966 <p>Examples:</p>
1967 <div class="highlight"><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">&#39;isDisabled&#39;</span><span class="p">)</span>
1968
1969 <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;fooTypeID&#39;</span><span class="p">)</span>
1970
1971 <span class="nx">SmallintDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;bar&#39;</span><span class="p">)</span>
1972     <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
1973     <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">()</span>
1974 </code></pre></div>
1975 <h2 id="foreign-keys">Foreign Keys<a class="headerlink" href="#foreign-keys" title="Permanent link">#</a></h2>
1976 <p>Foreign keys are represented by <code>DatabaseTableForeignKey</code> objects: </p>
1977 <div class="highlight"><pre><span></span><code><span class="nx">DatabaseTableForeignKey</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
1978     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
1979     <span class="o">-&gt;</span><span class="na">referencedTable</span><span class="p">(</span><span class="s1">&#39;wcf1_foo&#39;</span><span class="p">)</span>
1980     <span class="o">-&gt;</span><span class="na">referencedColumns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
1981     <span class="o">-&gt;</span><span class="na">onDelete</span><span class="p">(</span><span class="s1">&#39;CASCADE&#39;</span><span class="p">)</span>
1982 </code></pre></div>
1983 <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>.
1984 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>
1985 <p><code>DatabaseTableForeignKey::create()</code> also supports the foreign key name as a parameter.
1986 If it is not present, <code>DatabaseTable::foreignKeys()</code> will automatically set one based on the foreign key's data.</p>
1987 <h2 id="indices">Indices<a class="headerlink" href="#indices" title="Permanent link">#</a></h2>
1988 <p>Indices are represented by <code>DatabaseTableIndex</code> objects: </p>
1989 <div class="highlight"><pre><span></span><code><span class="nx">DatabaseTableIndex</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
1990     <span class="o">-&gt;</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>
1991     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
1992 </code></pre></div>
1993 <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>.
1994 For primary keys, there is also the <code>DatabaseTablePrimaryIndex</code> class which automatically sets the type to <code>DatabaseTableIndex::PRIMARY_TYPE</code>.
1995 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>
1996 <p><code>DatabaseTableIndex::create()</code> also supports the index name as a parameter.
1997 If it is not present, <code>DatabaseTable::indices()</code> will automatically set one based on the index data.</p>
1998
1999
2000
2001
2002 <hr>
2003 <div class="md-source-date">
2004   <small>
2005
2006       Last update: 2021-03-16
2007
2008   </small>
2009 </div>
2010
2011
2012
2013
2014
2015
2016
2017
2018             </article>
2019           </div>
2020         </div>
2021
2022       </main>
2023
2024
2025 <footer class="md-footer">
2026
2027     <nav class="md-footer__inner md-grid" aria-label="Footer">
2028
2029         <a href="../pip/user-profile-menu/" 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>
2032           </div>
2033           <div class="md-footer__title">
2034             <div class="md-ellipsis">
2035               <span class="md-footer__direction">
2036                 Previous
2037               </span>
2038               userProfileMenu
2039             </div>
2040           </div>
2041         </a>
2042
2043
2044         <a href="../../migration/wsc53/php/" 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">
2048                 Next
2049               </span>
2050               PHP API
2051             </div>
2052           </div>
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>
2055           </div>
2056         </a>
2057
2058     </nav>
2059
2060   <div class="md-footer-meta md-typeset">
2061     <div class="md-footer-meta__inner md-grid">
2062       <div class="md-footer-copyright">
2063
2064           <div class="md-footer-copyright__highlight">
2065             Copyright © 2020 WoltLab GmbH
2066           </div>
2067
2068         Made with
2069         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2070           Material for MkDocs
2071         </a>
2072
2073       </div>
2074       <div class="md-footer-copyright">
2075         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2076         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2077 </div>
2078     </div>
2079   </div>
2080 </footer>
2081
2082     </div>
2083     <div class="md-dialog" data-md-component="dialog">
2084       <div class="md-dialog__inner md-typeset"></div>
2085     </div>
2086     <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.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2087
2088
2089       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2090
2091
2092   </body>
2093 </html>