6.0/package/pip/sql/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/sql/">
  12
  13
  14         <link rel="prev" href="../smiley/">
  15
  16
  17         <link rel="next" href="../style/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.17">
  21
  22
  23
  24         <title>sql - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <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>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#sql-package-installation-plugin" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               sql
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <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>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <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>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <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>
 137         <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>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <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>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.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 2023 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>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.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 2023 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>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-modifiers/" class="md-nav__link">
 743         Template Modifiers
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/template-plugins/" class="md-nav__link">
 757         Template Plugins
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769     <li class="md-nav__item">
 770       <a href="../../../view/css/" class="md-nav__link">
 771         CSS
 772       </a>
 773     </li>
 774
 775
 776
 777
 778         </ul>
 779       </nav>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item md-nav__item--nested">
 793
 794
 795
 796
 797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 798
 799
 800
 801         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 802           TypeScript and JavaScript API
 803           <span class="md-nav__icon md-icon"></span>
 804         </label>
 805
 806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 807         <label class="md-nav__title" for="__nav_4">
 808           <span class="md-nav__icon md-icon"></span>
 809           TypeScript and JavaScript API
 810         </label>
 811         <ul class="md-nav__list" data-md-scrollfix>
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/general-usage/" class="md-nav__link">
 820         General Usage
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item md-nav__item--nested">
 848
 849
 850
 851
 852       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 853
 854
 855
 856         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 857           Components
 858           <span class="md-nav__icon md-icon"></span>
 859         </label>
 860
 861       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 862         <label class="md-nav__title" for="__nav_4_3">
 863           <span class="md-nav__icon md-icon"></span>
 864           Components
 865         </label>
 866         <ul class="md-nav__list" data-md-scrollfix>
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 875         Confirmation
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 889         Dialog
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 903         Google Maps
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 917         Pagination
 918       </a>
 919     </li>
 920
 921
 922
 923
 924         </ul>
 925       </nav>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item md-nav__item--nested">
 938
 939
 940
 941
 942       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 943
 944
 945
 946         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 947           New API
 948           <span class="md-nav__icon md-icon"></span>
 949         </label>
 950
 951       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 952         <label class="md-nav__title" for="__nav_4_4">
 953           <span class="md-nav__icon md-icon"></span>
 954           New API
 955         </label>
 956         <ul class="md-nav__list" data-md-scrollfix>
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 965         Writing a module
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 979         Core Functions
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 993         DOM
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007         Event Handling
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021         Ajax
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035         Dialogs
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049         Browser and Screen Sizes
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061     <li class="md-nav__item">
1062       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063         User Interface
1064       </a>
1065     </li>
1066
1067
1068
1069
1070         </ul>
1071       </nav>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084         Legacy API
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098         Code Snippets
1099       </a>
1100     </li>
1101
1102
1103
1104
1105         </ul>
1106       </nav>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1122
1123
1124
1125
1126       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1127
1128
1129
1130         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1131           Package Components
1132           <span class="md-nav__icon md-icon"></span>
1133         </label>
1134
1135       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1136         <label class="md-nav__title" for="__nav_5">
1137           <span class="md-nav__icon md-icon"></span>
1138           Package Components
1139         </label>
1140         <ul class="md-nav__list" data-md-scrollfix>
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../../package-xml/" class="md-nav__link">
1149         package.xml
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1165
1166
1167
1168
1169       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1170
1171
1172
1173         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1174           PIPs
1175           <span class="md-nav__icon md-icon"></span>
1176         </label>
1177
1178       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1179         <label class="md-nav__title" for="__nav_5_2">
1180           <span class="md-nav__icon md-icon"></span>
1181           PIPs
1182         </label>
1183         <ul class="md-nav__list" data-md-scrollfix>
1184
1185
1186
1187
1188
1189
1190     <li class="md-nav__item">
1191       <a href="../" class="md-nav__link">
1192         Overview
1193       </a>
1194     </li>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../acl-option/" class="md-nav__link">
1206         aclOption
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item">
1219       <a href="../acp-menu/" class="md-nav__link">
1220         acpMenu
1221       </a>
1222     </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232     <li class="md-nav__item">
1233       <a href="../acp-search-provider/" class="md-nav__link">
1234         acpSearchProvider
1235       </a>
1236     </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../acp-template/" class="md-nav__link">
1248         acpTemplate
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../acp-template-delete/" class="md-nav__link">
1262         acpTemplateDelete
1263       </a>
1264     </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../bbcode/" class="md-nav__link">
1276         bbcode
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../box/" class="md-nav__link">
1290         box
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item">
1303       <a href="../clipboard-action/" class="md-nav__link">
1304         clipboardAction
1305       </a>
1306     </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../core-object/" class="md-nav__link">
1318         coreObject
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../cronjob/" class="md-nav__link">
1332         cronjob
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../database/" class="md-nav__link">
1346         database
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../event-listener/" class="md-nav__link">
1360         eventListener
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../file/" class="md-nav__link">
1374         file
1375       </a>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386     <li class="md-nav__item">
1387       <a href="../file-delete/" class="md-nav__link">
1388         fileDelete
1389       </a>
1390     </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../language/" class="md-nav__link">
1402         language
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../media-provider/" class="md-nav__link">
1416         mediaProvider
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428     <li class="md-nav__item">
1429       <a href="../menu/" class="md-nav__link">
1430         menu
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../menu-item/" class="md-nav__link">
1444         menuItem
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../object-type/" class="md-nav__link">
1458         objectType
1459       </a>
1460     </li>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470     <li class="md-nav__item">
1471       <a href="../object-type-definition/" class="md-nav__link">
1472         objectTypeDefinition
1473       </a>
1474     </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484     <li class="md-nav__item">
1485       <a href="../option/" class="md-nav__link">
1486         option
1487       </a>
1488     </li>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498     <li class="md-nav__item">
1499       <a href="../page/" class="md-nav__link">
1500         page
1501       </a>
1502     </li>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512     <li class="md-nav__item">
1513       <a href="../pip/" class="md-nav__link">
1514         pip
1515       </a>
1516     </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526     <li class="md-nav__item">
1527       <a href="../script/" class="md-nav__link">
1528         script
1529       </a>
1530     </li>
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../smiley/" class="md-nav__link">
1542         smiley
1543       </a>
1544     </li>
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556     <li class="md-nav__item md-nav__item--active">
1557
1558       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1559
1560
1561
1562
1563
1564         <label class="md-nav__link md-nav__link--active" for="__toc">
1565           sql
1566           <span class="md-nav__icon md-icon"></span>
1567         </label>
1568
1569       <a href="./" class="md-nav__link md-nav__link--active">
1570         sql
1571       </a>
1572
1573
1574
1575 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1576
1577
1578
1579
1580
1581
1582     <label class="md-nav__title" for="__toc">
1583       <span class="md-nav__icon md-icon"></span>
1584       Table of contents
1585     </label>
1586     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1587
1588         <li class="md-nav__item">
1589   <a href="#expected-value" class="md-nav__link">
1590     Expected Value
1591   </a>
1592
1593 </li>
1594
1595         <li class="md-nav__item">
1596   <a href="#features" class="md-nav__link">
1597     Features
1598   </a>
1599
1600     <nav class="md-nav" aria-label="Features">
1601       <ul class="md-nav__list">
1602
1603           <li class="md-nav__item">
1604   <a href="#logging" class="md-nav__link">
1605     Logging
1606   </a>
1607
1608 </li>
1609
1610           <li class="md-nav__item">
1611   <a href="#instance-number" class="md-nav__link">
1612     Instance Number
1613   </a>
1614
1615 </li>
1616
1617           <li class="md-nav__item">
1618   <a href="#table-type" class="md-nav__link">
1619     Table Type
1620   </a>
1621
1622 </li>
1623
1624       </ul>
1625     </nav>
1626
1627 </li>
1628
1629         <li class="md-nav__item">
1630   <a href="#limitations" class="md-nav__link">
1631     Limitations
1632   </a>
1633
1634     <nav class="md-nav" aria-label="Limitations">
1635       <ul class="md-nav__list">
1636
1637           <li class="md-nav__item">
1638   <a href="#logging_1" class="md-nav__link">
1639     Logging
1640   </a>
1641
1642 </li>
1643
1644           <li class="md-nav__item">
1645   <a href="#triggers" class="md-nav__link">
1646     Triggers
1647   </a>
1648
1649 </li>
1650
1651       </ul>
1652     </nav>
1653
1654 </li>
1655
1656         <li class="md-nav__item">
1657   <a href="#example" class="md-nav__link">
1658     Example
1659   </a>
1660
1661 </li>
1662
1663     </ul>
1664
1665 </nav>
1666
1667     </li>
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677     <li class="md-nav__item">
1678       <a href="../style/" class="md-nav__link">
1679         style
1680       </a>
1681     </li>
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691     <li class="md-nav__item">
1692       <a href="../template/" class="md-nav__link">
1693         template
1694       </a>
1695     </li>
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705     <li class="md-nav__item">
1706       <a href="../template-delete/" class="md-nav__link">
1707         templateDelete
1708       </a>
1709     </li>
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719     <li class="md-nav__item">
1720       <a href="../template-listener/" class="md-nav__link">
1721         templateListener
1722       </a>
1723     </li>
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733     <li class="md-nav__item">
1734       <a href="../user-group-option/" class="md-nav__link">
1735         userGroupOption
1736       </a>
1737     </li>
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747     <li class="md-nav__item">
1748       <a href="../user-menu/" class="md-nav__link">
1749         userMenu
1750       </a>
1751     </li>
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761     <li class="md-nav__item">
1762       <a href="../user-notification-event/" class="md-nav__link">
1763         userNotificationEvent
1764       </a>
1765     </li>
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775     <li class="md-nav__item">
1776       <a href="../user-option/" class="md-nav__link">
1777         userOption
1778       </a>
1779     </li>
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789     <li class="md-nav__item">
1790       <a href="../user-profile-menu/" class="md-nav__link">
1791         userProfileMenu
1792       </a>
1793     </li>
1794
1795
1796
1797
1798         </ul>
1799       </nav>
1800     </li>
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../../database-php-api/" class="md-nav__link">
1812         Database PHP API
1813       </a>
1814     </li>
1815
1816
1817
1818
1819         </ul>
1820       </nav>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item md-nav__item--nested">
1834
1835
1836
1837
1838       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1839
1840
1841
1842         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1843           Migration
1844           <span class="md-nav__icon md-icon"></span>
1845         </label>
1846
1847       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1848         <label class="md-nav__title" for="__nav_6">
1849           <span class="md-nav__icon md-icon"></span>
1850           Migration
1851         </label>
1852         <ul class="md-nav__list" data-md-scrollfix>
1853
1854
1855
1856
1857
1858
1859
1860     <li class="md-nav__item md-nav__item--nested">
1861
1862
1863
1864
1865       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1866
1867
1868
1869         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1870           From WoltLab Suite 5.5
1871           <span class="md-nav__icon md-icon"></span>
1872         </label>
1873
1874       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1875         <label class="md-nav__title" for="__nav_6_1">
1876           <span class="md-nav__icon md-icon"></span>
1877           From WoltLab Suite 5.5
1878         </label>
1879         <ul class="md-nav__list" data-md-scrollfix>
1880
1881
1882
1883
1884
1885
1886     <li class="md-nav__item">
1887       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1888         PHP API
1889       </a>
1890     </li>
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900     <li class="md-nav__item">
1901       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1902         TypeScript and JavaScript
1903       </a>
1904     </li>
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914     <li class="md-nav__item">
1915       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1916         Templates
1917       </a>
1918     </li>
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928     <li class="md-nav__item">
1929       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1930         Icons
1931       </a>
1932     </li>
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942     <li class="md-nav__item">
1943       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1944         Dialogs
1945       </a>
1946     </li>
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956     <li class="md-nav__item">
1957       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1958         Third Party Libraries
1959       </a>
1960     </li>
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970     <li class="md-nav__item">
1971       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1972         Deprecations and Removals
1973       </a>
1974     </li>
1975
1976
1977
1978
1979         </ul>
1980       </nav>
1981     </li>
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992     <li class="md-nav__item md-nav__item--nested">
1993
1994
1995
1996
1997       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1998
1999
2000
2001         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2002           From WoltLab Suite 5.4
2003           <span class="md-nav__icon md-icon"></span>
2004         </label>
2005
2006       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2007         <label class="md-nav__title" for="__nav_6_2">
2008           <span class="md-nav__icon md-icon"></span>
2009           From WoltLab Suite 5.4
2010         </label>
2011         <ul class="md-nav__list" data-md-scrollfix>
2012
2013
2014
2015
2016
2017
2018     <li class="md-nav__item">
2019       <a href="../../../migration/wsc54/php/" class="md-nav__link">
2020         PHP API
2021       </a>
2022     </li>
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032     <li class="md-nav__item">
2033       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2034         TypeScript and JavaScript
2035       </a>
2036     </li>
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046     <li class="md-nav__item">
2047       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2048         Templates
2049       </a>
2050     </li>
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060     <li class="md-nav__item">
2061       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2062         Third Party Libraries
2063       </a>
2064     </li>
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074     <li class="md-nav__item">
2075       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2076         Deprecations and Removals
2077       </a>
2078     </li>
2079
2080
2081
2082
2083         </ul>
2084       </nav>
2085     </li>
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096     <li class="md-nav__item md-nav__item--nested">
2097
2098
2099
2100
2101       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2102
2103
2104
2105         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2106           From WoltLab Suite 5.3
2107           <span class="md-nav__icon md-icon"></span>
2108         </label>
2109
2110       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2111         <label class="md-nav__title" for="__nav_6_3">
2112           <span class="md-nav__icon md-icon"></span>
2113           From WoltLab Suite 5.3
2114         </label>
2115         <ul class="md-nav__list" data-md-scrollfix>
2116
2117
2118
2119
2120
2121
2122     <li class="md-nav__item">
2123       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2124         PHP API
2125       </a>
2126     </li>
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136     <li class="md-nav__item">
2137       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2138         Session Handling and Authentication
2139       </a>
2140     </li>
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150     <li class="md-nav__item">
2151       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2152         TypeScript and JavaScript
2153       </a>
2154     </li>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164     <li class="md-nav__item">
2165       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2166         Templates
2167       </a>
2168     </li>
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178     <li class="md-nav__item">
2179       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2180         Third Party Libraries
2181       </a>
2182     </li>
2183
2184
2185
2186
2187         </ul>
2188       </nav>
2189     </li>
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200     <li class="md-nav__item md-nav__item--nested">
2201
2202
2203
2204
2205       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2206
2207
2208
2209         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2210           From WoltLab Suite 5.2
2211           <span class="md-nav__icon md-icon"></span>
2212         </label>
2213
2214       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2215         <label class="md-nav__title" for="__nav_6_4">
2216           <span class="md-nav__icon md-icon"></span>
2217           From WoltLab Suite 5.2
2218         </label>
2219         <ul class="md-nav__list" data-md-scrollfix>
2220
2221
2222
2223
2224
2225
2226     <li class="md-nav__item">
2227       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2228         PHP API
2229       </a>
2230     </li>
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240     <li class="md-nav__item">
2241       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2242         Templates and Languages
2243       </a>
2244     </li>
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254     <li class="md-nav__item">
2255       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2256         Third Party Libraries
2257       </a>
2258     </li>
2259
2260
2261
2262
2263         </ul>
2264       </nav>
2265     </li>
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276     <li class="md-nav__item md-nav__item--nested">
2277
2278
2279
2280
2281       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2282
2283
2284
2285         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2286           From WoltLab Suite 3.1
2287           <span class="md-nav__icon md-icon"></span>
2288         </label>
2289
2290       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2291         <label class="md-nav__title" for="__nav_6_5">
2292           <span class="md-nav__icon md-icon"></span>
2293           From WoltLab Suite 3.1
2294         </label>
2295         <ul class="md-nav__list" data-md-scrollfix>
2296
2297
2298
2299
2300
2301
2302     <li class="md-nav__item">
2303       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2304         PHP API
2305       </a>
2306     </li>
2307
2308
2309
2310
2311         </ul>
2312       </nav>
2313     </li>
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324     <li class="md-nav__item md-nav__item--nested">
2325
2326
2327
2328
2329       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2330
2331
2332
2333         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2334           From WoltLab Suite 3.0
2335           <span class="md-nav__icon md-icon"></span>
2336         </label>
2337
2338       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2339         <label class="md-nav__title" for="__nav_6_6">
2340           <span class="md-nav__icon md-icon"></span>
2341           From WoltLab Suite 3.0
2342         </label>
2343         <ul class="md-nav__list" data-md-scrollfix>
2344
2345
2346
2347
2348
2349
2350     <li class="md-nav__item">
2351       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2352         PHP API
2353       </a>
2354     </li>
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364     <li class="md-nav__item">
2365       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2366         JavaScript API
2367       </a>
2368     </li>
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378     <li class="md-nav__item">
2379       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2380         Templates
2381       </a>
2382     </li>
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392     <li class="md-nav__item">
2393       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2394         CSS
2395       </a>
2396     </li>
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406     <li class="md-nav__item">
2407       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2408         Package Components
2409       </a>
2410     </li>
2411
2412
2413
2414
2415         </ul>
2416       </nav>
2417     </li>
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428     <li class="md-nav__item md-nav__item--nested">
2429
2430
2431
2432
2433       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2434
2435
2436
2437         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2438           From WCF 2.1
2439           <span class="md-nav__icon md-icon"></span>
2440         </label>
2441
2442       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2443         <label class="md-nav__title" for="__nav_6_7">
2444           <span class="md-nav__icon md-icon"></span>
2445           From WCF 2.1
2446         </label>
2447         <ul class="md-nav__list" data-md-scrollfix>
2448
2449
2450
2451
2452
2453
2454     <li class="md-nav__item">
2455       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2456         PHP API
2457       </a>
2458     </li>
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468     <li class="md-nav__item">
2469       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2470         Templates
2471       </a>
2472     </li>
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482     <li class="md-nav__item">
2483       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2484         CSS
2485       </a>
2486     </li>
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496     <li class="md-nav__item">
2497       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2498         Package Components
2499       </a>
2500     </li>
2501
2502
2503
2504
2505         </ul>
2506       </nav>
2507     </li>
2508
2509
2510
2511
2512         </ul>
2513       </nav>
2514     </li>
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526     <li class="md-nav__item md-nav__item--nested">
2527
2528
2529
2530
2531       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2532
2533
2534
2535         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2536           Tutorials
2537           <span class="md-nav__icon md-icon"></span>
2538         </label>
2539
2540       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2541         <label class="md-nav__title" for="__nav_7">
2542           <span class="md-nav__icon md-icon"></span>
2543           Tutorials
2544         </label>
2545         <ul class="md-nav__list" data-md-scrollfix>
2546
2547
2548
2549
2550
2551
2552
2553     <li class="md-nav__item md-nav__item--nested">
2554
2555
2556
2557
2558       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2559
2560
2561
2562         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2563           Tutorial Series
2564           <span class="md-nav__icon md-icon"></span>
2565         </label>
2566
2567       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2568         <label class="md-nav__title" for="__nav_7_1">
2569           <span class="md-nav__icon md-icon"></span>
2570           Tutorial Series
2571         </label>
2572         <ul class="md-nav__list" data-md-scrollfix>
2573
2574
2575
2576
2577
2578
2579     <li class="md-nav__item">
2580       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2581         Overview
2582       </a>
2583     </li>
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593     <li class="md-nav__item">
2594       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2595         Part 1
2596       </a>
2597     </li>
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607     <li class="md-nav__item">
2608       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2609         Part 2
2610       </a>
2611     </li>
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621     <li class="md-nav__item">
2622       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2623         Part 3
2624       </a>
2625     </li>
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635     <li class="md-nav__item">
2636       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2637         Part 4
2638       </a>
2639     </li>
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649     <li class="md-nav__item">
2650       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2651         Part 5
2652       </a>
2653     </li>
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663     <li class="md-nav__item">
2664       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2665         Part 6
2666       </a>
2667     </li>
2668
2669
2670
2671
2672         </ul>
2673       </nav>
2674     </li>
2675
2676
2677
2678
2679         </ul>
2680       </nav>
2681     </li>
2682
2683
2684
2685   </ul>
2686 </nav>
2687                   </div>
2688                 </div>
2689               </div>
2690
2691
2692
2693               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2694                 <div class="md-sidebar__scrollwrap">
2695                   <div class="md-sidebar__inner">
2696
2697
2698 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2699
2700
2701
2702
2703
2704
2705     <label class="md-nav__title" for="__toc">
2706       <span class="md-nav__icon md-icon"></span>
2707       Table of contents
2708     </label>
2709     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2710
2711         <li class="md-nav__item">
2712   <a href="#expected-value" class="md-nav__link">
2713     Expected Value
2714   </a>
2715
2716 </li>
2717
2718         <li class="md-nav__item">
2719   <a href="#features" class="md-nav__link">
2720     Features
2721   </a>
2722
2723     <nav class="md-nav" aria-label="Features">
2724       <ul class="md-nav__list">
2725
2726           <li class="md-nav__item">
2727   <a href="#logging" class="md-nav__link">
2728     Logging
2729   </a>
2730
2731 </li>
2732
2733           <li class="md-nav__item">
2734   <a href="#instance-number" class="md-nav__link">
2735     Instance Number
2736   </a>
2737
2738 </li>
2739
2740           <li class="md-nav__item">
2741   <a href="#table-type" class="md-nav__link">
2742     Table Type
2743   </a>
2744
2745 </li>
2746
2747       </ul>
2748     </nav>
2749
2750 </li>
2751
2752         <li class="md-nav__item">
2753   <a href="#limitations" class="md-nav__link">
2754     Limitations
2755   </a>
2756
2757     <nav class="md-nav" aria-label="Limitations">
2758       <ul class="md-nav__list">
2759
2760           <li class="md-nav__item">
2761   <a href="#logging_1" class="md-nav__link">
2762     Logging
2763   </a>
2764
2765 </li>
2766
2767           <li class="md-nav__item">
2768   <a href="#triggers" class="md-nav__link">
2769     Triggers
2770   </a>
2771
2772 </li>
2773
2774       </ul>
2775     </nav>
2776
2777 </li>
2778
2779         <li class="md-nav__item">
2780   <a href="#example" class="md-nav__link">
2781     Example
2782   </a>
2783
2784 </li>
2785
2786     </ul>
2787
2788 </nav>
2789                   </div>
2790                 </div>
2791               </div>
2792
2793
2794
2795             <div class="md-content" data-md-component="content">
2796               <article class="md-content__inner md-typeset">
2797
2798
2799
2800
2801
2802
2803
2804 <h1 id="sql-package-installation-plugin">SQL Package Installation Plugin<a class="headerlink" href="#sql-package-installation-plugin" title="Permanent link">#</a></h1>
2805 <p>Execute SQL instructions using a MySQL-flavored syntax.</p>
2806 <div class="admonition warning">
2807 <p class="admonition-title">This file is parsed by WoltLab Suite Core to allow reverting of certain changes, but not every syntax MySQL supports is recognized by the parser. To avoid any troubles, you should always use statements relying on the SQL standard.</p>
2808 </div>
2809 <h2 id="expected-value">Expected Value<a class="headerlink" href="#expected-value" title="Permanent link">#</a></h2>
2810 <p>The <code>sql</code> package installation plugin expects a relative path to a <code>.sql</code> file.</p>
2811 <h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">#</a></h2>
2812 <h3 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">#</a></h3>
2813 <p>WoltLab Suite Core uses a SQL parser to extract queries and log certain actions.
2814 This allows WoltLab Suite Core to revert some of the changes you apply upon package uninstallation.</p>
2815 <p>The logged changes are:</p>
2816 <ul>
2817 <li><code>CREATE TABLE</code></li>
2818 <li><code>ALTER TABLE … ADD COLUMN</code></li>
2819 <li><code>ALTER TABLE … ADD … KEY</code></li>
2820 </ul>
2821 <h3 id="instance-number">Instance Number<a class="headerlink" href="#instance-number" title="Permanent link">#</a></h3>
2822 <p>It is possible to use different instance numbers, e.g. two separate WoltLab Suite Core installations within one database.
2823 WoltLab Suite Core requires you to always use <code>wcf1_&lt;tableName&gt;</code> or <code>&lt;app&gt;1_&lt;tableName&gt;</code> (e.g. <code>blog1_blog</code> in WoltLab Suite Blog), the number (<code>1</code>) will be automatically replaced prior to execution.
2824 If you every use anything other but <code>1</code>, you will eventually break things, thus always use <code>1</code>!</p>
2825 <h3 id="table-type">Table Type<a class="headerlink" href="#table-type" title="Permanent link">#</a></h3>
2826 <p>WoltLab Suite Core will determine the type of database tables on its own:
2827 If the table contains a <code>FULLTEXT</code> index, it uses <code>MyISAM</code>, otherwise <code>InnoDB</code> is used.</p>
2828 <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title="Permanent link">#</a></h2>
2829 <h3 id="logging_1">Logging<a class="headerlink" href="#logging_1" title="Permanent link">#</a></h3>
2830 <p>WoltLab Suite Core cannot revert changes to the database structure which would cause to the data to be either changed or new data to be incompatible with the original format.
2831 Additionally, WoltLab Suite Core does not track regular SQL queries such as <code>DELETE</code> or <code>UPDATE</code>.</p>
2832 <h3 id="triggers">Triggers<a class="headerlink" href="#triggers" title="Permanent link">#</a></h3>
2833 <p>WoltLab Suite Core does not support trigger since MySQL does not support execution of triggers if the event was fired by a cascading foreign key action.
2834 If you really need triggers, you should consider adding them by custom SQL queries using a <a href="../script/">script</a>.</p>
2835 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2836 <p><code>package.xml</code>:</p>
2837 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;sql&quot;</span><span class="nt">&gt;</span>install.sql<span class="nt">&lt;/instruction&gt;</span>
2838 </code></pre></div></td></tr></table></div>
2839 <p>Example content:</p>
2840 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">install.sql <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/install.sql" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2841 <span class="normal"> 2</span>
2842 <span class="normal"> 3</span>
2843 <span class="normal"> 4</span>
2844 <span class="normal"> 5</span>
2845 <span class="normal"> 6</span>
2846 <span class="normal"> 7</span>
2847 <span class="normal"> 8</span>
2848 <span class="normal"> 9</span>
2849 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">CREATE</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n">wcf1_foo_bar</span><span class="w"> </span><span class="p">(</span>
2850 <span class="w">    </span><span class="n">fooID</span><span class="w"> </span><span class="nb">INT</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="w"> </span><span class="n">AUTO_INCREMENT</span><span class="w"> </span><span class="k">PRIMARY</span><span class="w"> </span><span class="k">KEY</span><span class="p">,</span>
2851 <span class="w">    </span><span class="n">packageID</span><span class="w"> </span><span class="nb">INT</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="p">,</span>
2852 <span class="w">    </span><span class="n">bar</span><span class="w"> </span><span class="nb">VARCHAR</span><span class="p">(</span><span class="mi">255</span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="w"> </span><span class="k">DEFAULT</span><span class="w"> </span><span class="s1">&#39;&#39;</span><span class="p">,</span>
2853 <span class="w">    </span><span class="n">foobar</span><span class="w"> </span><span class="nb">VARCHAR</span><span class="p">(</span><span class="mi">50</span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="w"> </span><span class="k">DEFAULT</span><span class="w"> </span><span class="s1">&#39;&#39;</span><span class="p">,</span>
2854
2855 <span class="w">    </span><span class="k">UNIQUE</span><span class="w"> </span><span class="k">KEY</span><span class="w"> </span><span class="n">baz</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">,</span><span class="w"> </span><span class="n">foobar</span><span class="p">)</span>
2856 <span class="p">);</span>
2857
2858 <span class="k">ALTER</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n">wcf1_foo_bar</span><span class="w"> </span><span class="k">ADD</span><span class="w"> </span><span class="k">FOREIGN</span><span class="w"> </span><span class="k">KEY</span><span class="w"> </span><span class="p">(</span><span class="n">packageID</span><span class="p">)</span><span class="w"> </span><span class="k">REFERENCES</span><span class="w"> </span><span class="n">wcf1_package</span><span class="w"> </span><span class="p">(</span><span class="n">packageID</span><span class="p">)</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="k">DELETE</span><span class="w"> </span><span class="k">CASCADE</span><span class="p">;</span>
2859 </code></pre></div></td></tr></table></div>
2860
2861   <hr>
2862 <div class="md-source-file">
2863   <small>
2864
2865       Last update:
2866       2021-04-23
2867
2868   </small>
2869 </div>
2870
2871
2872
2873
2874
2875
2876               </article>
2877             </div>
2878
2879
2880         </div>
2881
2882       </main>
2883
2884         <footer class="md-footer">
2885
2886   <div class="md-footer-meta md-typeset">
2887     <div class="md-footer-meta__inner md-grid">
2888       <div class="md-copyright">
2889
2890     <div class="md-copyright__highlight">
2891       Copyright © 2020 WoltLab GmbH
2892     </div>
2893
2894
2895     Made with
2896     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2897       Material for MkDocs
2898     </a>
2899
2900 </div>
2901
2902         <div class="md-copyright">
2903         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2904         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2905 </div>
2906
2907     </div>
2908   </div>
2909 </footer>
2910
2911     </div>
2912     <div class="md-dialog" data-md-component="dialog">
2913       <div class="md-dialog__inner md-typeset"></div>
2914     </div>
2915
2916     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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": "Select version"}, "version": {"provider": "mike"}}</script>
2917
2918
2919       <script src="../../../assets/javascripts/bundle.b425cdc4.min.js"></script>
2920
2921
2922   </body>
2923 </html>