5.4/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
  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>sql - 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="#sql-package-installation-plugin" 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               sql
 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
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 909       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 910         <label class="md-nav__title" for="__nav_5">
 911           <span class="md-nav__icon md-icon"></span>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../../package-xml/" class="md-nav__link">
 922         package.xml
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 939
 940       <label class="md-nav__link" for="__nav_5_2">
 941         PIPs
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 944       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 945         <label class="md-nav__title" for="__nav_5_2">
 946           <span class="md-nav__icon md-icon"></span>
 947           PIPs
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../bbcode/" class="md-nav__link">
1017         bbcode
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027     <li class="md-nav__item">
1028       <a href="../box/" class="md-nav__link">
1029         box
1030       </a>
1031     </li>
1032
1033
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../clipboard-action/" class="md-nav__link">
1041         clipboardAction
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../core-object/" class="md-nav__link">
1053         coreObject
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../cronjob/" class="md-nav__link">
1065         cronjob
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../database/" class="md-nav__link">
1077         database
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../event-listener/" class="md-nav__link">
1089         eventListener
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../file/" class="md-nav__link">
1101         file
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../language/" class="md-nav__link">
1113         language
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../media-provider/" class="md-nav__link">
1125         mediaProvider
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../menu/" class="md-nav__link">
1137         menu
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../menu-item/" class="md-nav__link">
1149         menuItem
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../object-type/" class="md-nav__link">
1161         objectType
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../object-type-definition/" class="md-nav__link">
1173         objectTypeDefinition
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../option/" class="md-nav__link">
1185         option
1186       </a>
1187     </li>
1188
1189
1190
1191
1192
1193
1194
1195     <li class="md-nav__item">
1196       <a href="../page/" class="md-nav__link">
1197         page
1198       </a>
1199     </li>
1200
1201
1202
1203
1204
1205
1206
1207     <li class="md-nav__item">
1208       <a href="../pip/" class="md-nav__link">
1209         pip
1210       </a>
1211     </li>
1212
1213
1214
1215
1216
1217
1218
1219     <li class="md-nav__item">
1220       <a href="../script/" class="md-nav__link">
1221         script
1222       </a>
1223     </li>
1224
1225
1226
1227
1228
1229
1230
1231     <li class="md-nav__item">
1232       <a href="../smiley/" class="md-nav__link">
1233         smiley
1234       </a>
1235     </li>
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245     <li class="md-nav__item md-nav__item--active">
1246
1247       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1248
1249
1250
1251
1252         <label class="md-nav__link md-nav__link--active" for="__toc">
1253           sql
1254           <span class="md-nav__icon md-icon"></span>
1255         </label>
1256
1257       <a href="./" class="md-nav__link md-nav__link--active">
1258         sql
1259       </a>
1260
1261
1262 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1263
1264
1265
1266
1267
1268     <label class="md-nav__title" for="__toc">
1269       <span class="md-nav__icon md-icon"></span>
1270       Table of contents
1271     </label>
1272     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1273
1274         <li class="md-nav__item">
1275   <a href="#expected-value" class="md-nav__link">
1276     Expected Value
1277   </a>
1278
1279 </li>
1280
1281         <li class="md-nav__item">
1282   <a href="#features" class="md-nav__link">
1283     Features
1284   </a>
1285
1286     <nav class="md-nav" aria-label="Features">
1287       <ul class="md-nav__list">
1288
1289           <li class="md-nav__item">
1290   <a href="#logging" class="md-nav__link">
1291     Logging
1292   </a>
1293
1294 </li>
1295
1296           <li class="md-nav__item">
1297   <a href="#instance-number" class="md-nav__link">
1298     Instance Number
1299   </a>
1300
1301 </li>
1302
1303           <li class="md-nav__item">
1304   <a href="#table-type" class="md-nav__link">
1305     Table Type
1306   </a>
1307
1308 </li>
1309
1310       </ul>
1311     </nav>
1312
1313 </li>
1314
1315         <li class="md-nav__item">
1316   <a href="#limitations" class="md-nav__link">
1317     Limitations
1318   </a>
1319
1320     <nav class="md-nav" aria-label="Limitations">
1321       <ul class="md-nav__list">
1322
1323           <li class="md-nav__item">
1324   <a href="#logging_1" class="md-nav__link">
1325     Logging
1326   </a>
1327
1328 </li>
1329
1330           <li class="md-nav__item">
1331   <a href="#triggers" class="md-nav__link">
1332     Triggers
1333   </a>
1334
1335 </li>
1336
1337       </ul>
1338     </nav>
1339
1340 </li>
1341
1342         <li class="md-nav__item">
1343   <a href="#example" class="md-nav__link">
1344     Example
1345   </a>
1346
1347 </li>
1348
1349     </ul>
1350
1351 </nav>
1352
1353     </li>
1354
1355
1356
1357
1358
1359
1360
1361     <li class="md-nav__item">
1362       <a href="../style/" class="md-nav__link">
1363         style
1364       </a>
1365     </li>
1366
1367
1368
1369
1370
1371
1372
1373     <li class="md-nav__item">
1374       <a href="../template/" class="md-nav__link">
1375         template
1376       </a>
1377     </li>
1378
1379
1380
1381
1382
1383
1384
1385     <li class="md-nav__item">
1386       <a href="../template-listener/" class="md-nav__link">
1387         templateListener
1388       </a>
1389     </li>
1390
1391
1392
1393
1394
1395
1396
1397     <li class="md-nav__item">
1398       <a href="../user-group-option/" class="md-nav__link">
1399         userGroupOption
1400       </a>
1401     </li>
1402
1403
1404
1405
1406
1407
1408
1409     <li class="md-nav__item">
1410       <a href="../user-menu/" class="md-nav__link">
1411         userMenu
1412       </a>
1413     </li>
1414
1415
1416
1417
1418
1419
1420
1421     <li class="md-nav__item">
1422       <a href="../user-notification-event/" class="md-nav__link">
1423         userNotificationEvent
1424       </a>
1425     </li>
1426
1427
1428
1429
1430
1431
1432
1433     <li class="md-nav__item">
1434       <a href="../user-option/" class="md-nav__link">
1435         userOption
1436       </a>
1437     </li>
1438
1439
1440
1441
1442
1443
1444
1445     <li class="md-nav__item">
1446       <a href="../user-profile-menu/" class="md-nav__link">
1447         userProfileMenu
1448       </a>
1449     </li>
1450
1451
1452
1453         </ul>
1454       </nav>
1455     </li>
1456
1457
1458
1459
1460
1461
1462
1463     <li class="md-nav__item">
1464       <a href="../../database-php-api/" class="md-nav__link">
1465         Database PHP API
1466       </a>
1467     </li>
1468
1469
1470
1471         </ul>
1472       </nav>
1473     </li>
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485     <li class="md-nav__item md-nav__item--nested">
1486
1487
1488         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1489
1490       <label class="md-nav__link" for="__nav_6">
1491         Migration
1492         <span class="md-nav__icon md-icon"></span>
1493       </label>
1494       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1495         <label class="md-nav__title" for="__nav_6">
1496           <span class="md-nav__icon md-icon"></span>
1497           Migration
1498         </label>
1499         <ul class="md-nav__list" data-md-scrollfix>
1500
1501
1502
1503
1504
1505
1506     <li class="md-nav__item md-nav__item--nested">
1507
1508
1509         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1510
1511       <label class="md-nav__link" for="__nav_6_1">
1512         Migrating from WSC 5.3
1513         <span class="md-nav__icon md-icon"></span>
1514       </label>
1515       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1516         <label class="md-nav__title" for="__nav_6_1">
1517           <span class="md-nav__icon md-icon"></span>
1518           Migrating from WSC 5.3
1519         </label>
1520         <ul class="md-nav__list" data-md-scrollfix>
1521
1522
1523
1524
1525
1526     <li class="md-nav__item">
1527       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1528         PHP API
1529       </a>
1530     </li>
1531
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1540         Session Handling and Authentication
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1552         TypeScript and JavaScript
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562     <li class="md-nav__item">
1563       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1564         Templates
1565       </a>
1566     </li>
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item">
1575       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1576         Third Party Libraries
1577       </a>
1578     </li>
1579
1580
1581
1582         </ul>
1583       </nav>
1584     </li>
1585
1586
1587
1588
1589
1590
1591
1592
1593     <li class="md-nav__item md-nav__item--nested">
1594
1595
1596         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1597
1598       <label class="md-nav__link" for="__nav_6_2">
1599         Migrating from WSC 5.2
1600         <span class="md-nav__icon md-icon"></span>
1601       </label>
1602       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1603         <label class="md-nav__title" for="__nav_6_2">
1604           <span class="md-nav__icon md-icon"></span>
1605           Migrating from WSC 5.2
1606         </label>
1607         <ul class="md-nav__list" data-md-scrollfix>
1608
1609
1610
1611
1612
1613     <li class="md-nav__item">
1614       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1615         PHP API
1616       </a>
1617     </li>
1618
1619
1620
1621
1622
1623
1624
1625     <li class="md-nav__item">
1626       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1627         Templates and Languages
1628       </a>
1629     </li>
1630
1631
1632
1633
1634
1635
1636
1637     <li class="md-nav__item">
1638       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1639         Third Party Libraries
1640       </a>
1641     </li>
1642
1643
1644
1645         </ul>
1646       </nav>
1647     </li>
1648
1649
1650
1651
1652
1653
1654
1655
1656     <li class="md-nav__item md-nav__item--nested">
1657
1658
1659         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1660
1661       <label class="md-nav__link" for="__nav_6_3">
1662         Migrating from WSC 3.1
1663         <span class="md-nav__icon md-icon"></span>
1664       </label>
1665       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1666         <label class="md-nav__title" for="__nav_6_3">
1667           <span class="md-nav__icon md-icon"></span>
1668           Migrating from WSC 3.1
1669         </label>
1670         <ul class="md-nav__list" data-md-scrollfix>
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1678         PHP API
1679       </a>
1680     </li>
1681
1682
1683
1684         </ul>
1685       </nav>
1686     </li>
1687
1688
1689
1690
1691
1692
1693
1694
1695     <li class="md-nav__item md-nav__item--nested">
1696
1697
1698         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1699
1700       <label class="md-nav__link" for="__nav_6_4">
1701         Migrating from WSC 3.0
1702         <span class="md-nav__icon md-icon"></span>
1703       </label>
1704       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1705         <label class="md-nav__title" for="__nav_6_4">
1706           <span class="md-nav__icon md-icon"></span>
1707           Migrating from WSC 3.0
1708         </label>
1709         <ul class="md-nav__list" data-md-scrollfix>
1710
1711
1712
1713
1714
1715     <li class="md-nav__item">
1716       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1717         PHP API
1718       </a>
1719     </li>
1720
1721
1722
1723
1724
1725
1726
1727     <li class="md-nav__item">
1728       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1729         JavaScript API
1730       </a>
1731     </li>
1732
1733
1734
1735
1736
1737
1738
1739     <li class="md-nav__item">
1740       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1741         Templates
1742       </a>
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item">
1752       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1753         CSS
1754       </a>
1755     </li>
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item">
1764       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1765         Package Components
1766       </a>
1767     </li>
1768
1769
1770
1771         </ul>
1772       </nav>
1773     </li>
1774
1775
1776
1777
1778
1779
1780
1781
1782     <li class="md-nav__item md-nav__item--nested">
1783
1784
1785         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1786
1787       <label class="md-nav__link" for="__nav_6_5">
1788         Migrating from WCF 2.1
1789         <span class="md-nav__icon md-icon"></span>
1790       </label>
1791       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1792         <label class="md-nav__title" for="__nav_6_5">
1793           <span class="md-nav__icon md-icon"></span>
1794           Migrating from WCF 2.1
1795         </label>
1796         <ul class="md-nav__list" data-md-scrollfix>
1797
1798
1799
1800
1801
1802     <li class="md-nav__item">
1803       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1804         PHP API
1805       </a>
1806     </li>
1807
1808
1809
1810
1811
1812
1813
1814     <li class="md-nav__item">
1815       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1816         Templates
1817       </a>
1818     </li>
1819
1820
1821
1822
1823
1824
1825
1826     <li class="md-nav__item">
1827       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1828         CSS
1829       </a>
1830     </li>
1831
1832
1833
1834
1835
1836
1837
1838     <li class="md-nav__item">
1839       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1840         Package Components
1841       </a>
1842     </li>
1843
1844
1845
1846         </ul>
1847       </nav>
1848     </li>
1849
1850
1851
1852         </ul>
1853       </nav>
1854     </li>
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866     <li class="md-nav__item md-nav__item--nested">
1867
1868
1869         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1870
1871       <label class="md-nav__link" for="__nav_7">
1872         Tutorials
1873         <span class="md-nav__icon md-icon"></span>
1874       </label>
1875       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1876         <label class="md-nav__title" for="__nav_7">
1877           <span class="md-nav__icon md-icon"></span>
1878           Tutorials
1879         </label>
1880         <ul class="md-nav__list" data-md-scrollfix>
1881
1882
1883
1884
1885
1886
1887     <li class="md-nav__item md-nav__item--nested">
1888
1889
1890         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1891
1892       <label class="md-nav__link" for="__nav_7_1">
1893         Tutorial Series
1894         <span class="md-nav__icon md-icon"></span>
1895       </label>
1896       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1897         <label class="md-nav__title" for="__nav_7_1">
1898           <span class="md-nav__icon md-icon"></span>
1899           Tutorial Series
1900         </label>
1901         <ul class="md-nav__list" data-md-scrollfix>
1902
1903
1904
1905
1906
1907     <li class="md-nav__item">
1908       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1909         Overview
1910       </a>
1911     </li>
1912
1913
1914
1915
1916
1917
1918
1919     <li class="md-nav__item">
1920       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1921         Part 1
1922       </a>
1923     </li>
1924
1925
1926
1927
1928
1929
1930
1931     <li class="md-nav__item">
1932       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1933         Part 2
1934       </a>
1935     </li>
1936
1937
1938
1939
1940
1941
1942
1943     <li class="md-nav__item">
1944       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1945         Part 3
1946       </a>
1947     </li>
1948
1949
1950
1951         </ul>
1952       </nav>
1953     </li>
1954
1955
1956
1957         </ul>
1958       </nav>
1959     </li>
1960
1961
1962
1963   </ul>
1964 </nav>
1965                   </div>
1966                 </div>
1967               </div>
1968
1969
1970
1971               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1972                 <div class="md-sidebar__scrollwrap">
1973                   <div class="md-sidebar__inner">
1974
1975 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1976
1977
1978
1979
1980
1981     <label class="md-nav__title" for="__toc">
1982       <span class="md-nav__icon md-icon"></span>
1983       Table of contents
1984     </label>
1985     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1986
1987         <li class="md-nav__item">
1988   <a href="#expected-value" class="md-nav__link">
1989     Expected Value
1990   </a>
1991
1992 </li>
1993
1994         <li class="md-nav__item">
1995   <a href="#features" class="md-nav__link">
1996     Features
1997   </a>
1998
1999     <nav class="md-nav" aria-label="Features">
2000       <ul class="md-nav__list">
2001
2002           <li class="md-nav__item">
2003   <a href="#logging" class="md-nav__link">
2004     Logging
2005   </a>
2006
2007 </li>
2008
2009           <li class="md-nav__item">
2010   <a href="#instance-number" class="md-nav__link">
2011     Instance Number
2012   </a>
2013
2014 </li>
2015
2016           <li class="md-nav__item">
2017   <a href="#table-type" class="md-nav__link">
2018     Table Type
2019   </a>
2020
2021 </li>
2022
2023       </ul>
2024     </nav>
2025
2026 </li>
2027
2028         <li class="md-nav__item">
2029   <a href="#limitations" class="md-nav__link">
2030     Limitations
2031   </a>
2032
2033     <nav class="md-nav" aria-label="Limitations">
2034       <ul class="md-nav__list">
2035
2036           <li class="md-nav__item">
2037   <a href="#logging_1" class="md-nav__link">
2038     Logging
2039   </a>
2040
2041 </li>
2042
2043           <li class="md-nav__item">
2044   <a href="#triggers" class="md-nav__link">
2045     Triggers
2046   </a>
2047
2048 </li>
2049
2050       </ul>
2051     </nav>
2052
2053 </li>
2054
2055         <li class="md-nav__item">
2056   <a href="#example" class="md-nav__link">
2057     Example
2058   </a>
2059
2060 </li>
2061
2062     </ul>
2063
2064 </nav>
2065                   </div>
2066                 </div>
2067               </div>
2068
2069
2070           <div class="md-content" data-md-component="content">
2071             <article class="md-content__inner md-typeset">
2072
2073
2074                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/sql.md" title="Edit this page" class="md-content__button md-icon">
2075                     <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>
2076                   </a>
2077
2078
2079                 <h1 id="sql-package-installation-plugin">SQL Package Installation Plugin<a class="headerlink" href="#sql-package-installation-plugin" title="Permanent link">#</a></h1>
2080 <p>Execute SQL instructions using a MySQL-flavored syntax.</p>
2081 <div class="admonition warning">
2082 <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>
2083 </div>
2084 <h2 id="expected-value">Expected Value<a class="headerlink" href="#expected-value" title="Permanent link">#</a></h2>
2085 <p>The <code>sql</code> package installation plugin expects a relative path to a <code>.sql</code> file.</p>
2086 <h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">#</a></h2>
2087 <h3 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">#</a></h3>
2088 <p>WoltLab Suite Core uses a SQL parser to extract queries and log certain actions.
2089 This allows WoltLab Suite Core to revert some of the changes you apply upon package uninstallation.</p>
2090 <p>The logged changes are:</p>
2091 <ul>
2092 <li><code>CREATE TABLE</code></li>
2093 <li><code>ALTER TABLE … ADD COLUMN</code></li>
2094 <li><code>ALTER TABLE … ADD … KEY</code></li>
2095 </ul>
2096 <h3 id="instance-number">Instance Number<a class="headerlink" href="#instance-number" title="Permanent link">#</a></h3>
2097 <p>It is possible to use different instance numbers, e.g. two separate WoltLab Suite Core installations within one database.
2098 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.
2099 If you every use anything other but <code>1</code>, you will eventually break things, thus always use <code>1</code>!</p>
2100 <h3 id="table-type">Table Type<a class="headerlink" href="#table-type" title="Permanent link">#</a></h3>
2101 <p>WoltLab Suite Core will determine the type of database tables on its own:
2102 If the table contains a <code>FULLTEXT</code> index, it uses <code>MyISAM</code>, otherwise <code>InnoDB</code> is used.</p>
2103 <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title="Permanent link">#</a></h2>
2104 <h3 id="logging_1">Logging<a class="headerlink" href="#logging_1" title="Permanent link">#</a></h3>
2105 <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.
2106 Additionally, WoltLab Suite Core does not track regular SQL queries such as <code>DELETE</code> or <code>UPDATE</code>.</p>
2107 <h3 id="triggers">Triggers<a class="headerlink" href="#triggers" title="Permanent link">#</a></h3>
2108 <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.
2109 If you really need triggers, you should consider adding them by custom SQL queries using a <a href="../script/">script</a>.</p>
2110 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2111 <p><code>package.xml</code>:</p>
2112 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instruction</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>
2113 </code></pre></div>
2114 <p>Example content:</p>
2115 <div class="highlight"><pre><span></span><code><span class="k">CREATE</span> <span class="k">TABLE</span> <span class="n">wcf1_foo_bar</span> <span class="p">(</span>
2116     <span class="n">fooID</span> <span class="nb">INT</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span> <span class="n">AUTO_INCREMENT</span> <span class="k">PRIMARY</span> <span class="k">KEY</span><span class="p">,</span>
2117     <span class="n">packageID</span> <span class="nb">INT</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span>
2118     <span class="n">bar</span> <span class="nb">VARCHAR</span><span class="p">(</span><span class="mi">255</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span> <span class="k">DEFAULT</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
2119     <span class="n">foobar</span> <span class="nb">VARCHAR</span><span class="p">(</span><span class="mi">50</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span> <span class="k">DEFAULT</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
2120
2121     <span class="k">UNIQUE</span> <span class="k">KEY</span> <span class="n">baz</span> <span class="p">(</span><span class="n">bar</span><span class="p">,</span> <span class="n">foobar</span><span class="p">)</span>
2122 <span class="p">);</span>
2123
2124 <span class="k">ALTER</span> <span class="k">TABLE</span> <span class="n">wcf1_foo_bar</span> <span class="k">ADD</span> <span class="k">FOREIGN</span> <span class="k">KEY</span> <span class="p">(</span><span class="n">packageID</span><span class="p">)</span> <span class="k">REFERENCES</span> <span class="n">wcf1_package</span> <span class="p">(</span><span class="n">packageID</span><span class="p">)</span> <span class="k">ON</span> <span class="k">DELETE</span> <span class="k">CASCADE</span><span class="p">;</span>
2125 </code></pre></div>
2126
2127
2128
2129
2130 <hr>
2131 <div class="md-source-date">
2132   <small>
2133
2134       Last update: 2021-01-08
2135
2136   </small>
2137 </div>
2138
2139
2140
2141
2142
2143
2144
2145
2146             </article>
2147           </div>
2148         </div>
2149
2150       </main>
2151
2152
2153 <footer class="md-footer">
2154
2155     <nav class="md-footer__inner md-grid" aria-label="Footer">
2156
2157         <a href="../smiley/" class="md-footer__link md-footer__link--prev" rel="prev">
2158           <div class="md-footer__button md-icon">
2159             <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>
2160           </div>
2161           <div class="md-footer__title">
2162             <div class="md-ellipsis">
2163               <span class="md-footer__direction">
2164                 Previous
2165               </span>
2166               smiley
2167             </div>
2168           </div>
2169         </a>
2170
2171
2172         <a href="../style/" class="md-footer__link md-footer__link--next" rel="next">
2173           <div class="md-footer__title">
2174             <div class="md-ellipsis">
2175               <span class="md-footer__direction">
2176                 Next
2177               </span>
2178               style
2179             </div>
2180           </div>
2181           <div class="md-footer__button md-icon">
2182             <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>
2183           </div>
2184         </a>
2185
2186     </nav>
2187
2188   <div class="md-footer-meta md-typeset">
2189     <div class="md-footer-meta__inner md-grid">
2190       <div class="md-footer-copyright">
2191
2192           <div class="md-footer-copyright__highlight">
2193             Copyright © 2020 WoltLab GmbH
2194           </div>
2195
2196         Made with
2197         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2198           Material for MkDocs
2199         </a>
2200
2201       </div>
2202       <div class="md-footer-copyright">
2203         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2204         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2205 </div>
2206     </div>
2207   </div>
2208 </footer>
2209
2210     </div>
2211     <div class="md-dialog" data-md-component="dialog">
2212       <div class="md-dialog__inner md-typeset"></div>
2213     </div>
2214     <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>
2215
2216
2217       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2218
2219
2220   </body>
2221 </html>