latest/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.2">
  14
  15
  16
  17         <title>sql - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.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
1253         <label class="md-nav__link md-nav__link--active" for="__toc">
1254           sql
1255           <span class="md-nav__icon md-icon"></span>
1256         </label>
1257
1258       <a href="./" class="md-nav__link md-nav__link--active">
1259         sql
1260       </a>
1261
1262
1263 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1264
1265
1266
1267
1268
1269
1270     <label class="md-nav__title" for="__toc">
1271       <span class="md-nav__icon md-icon"></span>
1272       Table of contents
1273     </label>
1274     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1275
1276         <li class="md-nav__item">
1277   <a href="#expected-value" class="md-nav__link">
1278     Expected Value
1279   </a>
1280
1281 </li>
1282
1283         <li class="md-nav__item">
1284   <a href="#features" class="md-nav__link">
1285     Features
1286   </a>
1287
1288     <nav class="md-nav" aria-label="Features">
1289       <ul class="md-nav__list">
1290
1291           <li class="md-nav__item">
1292   <a href="#logging" class="md-nav__link">
1293     Logging
1294   </a>
1295
1296 </li>
1297
1298           <li class="md-nav__item">
1299   <a href="#instance-number" class="md-nav__link">
1300     Instance Number
1301   </a>
1302
1303 </li>
1304
1305           <li class="md-nav__item">
1306   <a href="#table-type" class="md-nav__link">
1307     Table Type
1308   </a>
1309
1310 </li>
1311
1312       </ul>
1313     </nav>
1314
1315 </li>
1316
1317         <li class="md-nav__item">
1318   <a href="#limitations" class="md-nav__link">
1319     Limitations
1320   </a>
1321
1322     <nav class="md-nav" aria-label="Limitations">
1323       <ul class="md-nav__list">
1324
1325           <li class="md-nav__item">
1326   <a href="#logging_1" class="md-nav__link">
1327     Logging
1328   </a>
1329
1330 </li>
1331
1332           <li class="md-nav__item">
1333   <a href="#triggers" class="md-nav__link">
1334     Triggers
1335   </a>
1336
1337 </li>
1338
1339       </ul>
1340     </nav>
1341
1342 </li>
1343
1344         <li class="md-nav__item">
1345   <a href="#example" class="md-nav__link">
1346     Example
1347   </a>
1348
1349 </li>
1350
1351     </ul>
1352
1353 </nav>
1354
1355     </li>
1356
1357
1358
1359
1360
1361
1362
1363     <li class="md-nav__item">
1364       <a href="../style/" class="md-nav__link">
1365         style
1366       </a>
1367     </li>
1368
1369
1370
1371
1372
1373
1374
1375     <li class="md-nav__item">
1376       <a href="../template/" class="md-nav__link">
1377         template
1378       </a>
1379     </li>
1380
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../template-listener/" class="md-nav__link">
1389         templateListener
1390       </a>
1391     </li>
1392
1393
1394
1395
1396
1397
1398
1399     <li class="md-nav__item">
1400       <a href="../user-group-option/" class="md-nav__link">
1401         userGroupOption
1402       </a>
1403     </li>
1404
1405
1406
1407
1408
1409
1410
1411     <li class="md-nav__item">
1412       <a href="../user-menu/" class="md-nav__link">
1413         userMenu
1414       </a>
1415     </li>
1416
1417
1418
1419
1420
1421
1422
1423     <li class="md-nav__item">
1424       <a href="../user-notification-event/" class="md-nav__link">
1425         userNotificationEvent
1426       </a>
1427     </li>
1428
1429
1430
1431
1432
1433
1434
1435     <li class="md-nav__item">
1436       <a href="../user-option/" class="md-nav__link">
1437         userOption
1438       </a>
1439     </li>
1440
1441
1442
1443
1444
1445
1446
1447     <li class="md-nav__item">
1448       <a href="../user-profile-menu/" class="md-nav__link">
1449         userProfileMenu
1450       </a>
1451     </li>
1452
1453
1454
1455         </ul>
1456       </nav>
1457     </li>
1458
1459
1460
1461
1462
1463
1464
1465     <li class="md-nav__item">
1466       <a href="../../database-php-api/" class="md-nav__link">
1467         Database PHP API
1468       </a>
1469     </li>
1470
1471
1472
1473         </ul>
1474       </nav>
1475     </li>
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487     <li class="md-nav__item md-nav__item--nested">
1488
1489
1490         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1491
1492       <label class="md-nav__link" for="__nav_6">
1493         Migration
1494         <span class="md-nav__icon md-icon"></span>
1495       </label>
1496       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1497         <label class="md-nav__title" for="__nav_6">
1498           <span class="md-nav__icon md-icon"></span>
1499           Migration
1500         </label>
1501         <ul class="md-nav__list" data-md-scrollfix>
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item md-nav__item--nested">
1509
1510
1511         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1512
1513       <label class="md-nav__link" for="__nav_6_1">
1514         Migrating from WSC 5.3
1515         <span class="md-nav__icon md-icon"></span>
1516       </label>
1517       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1518         <label class="md-nav__title" for="__nav_6_1">
1519           <span class="md-nav__icon md-icon"></span>
1520           Migrating from WSC 5.3
1521         </label>
1522         <ul class="md-nav__list" data-md-scrollfix>
1523
1524
1525
1526
1527
1528     <li class="md-nav__item">
1529       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1530         PHP API
1531       </a>
1532     </li>
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item">
1541       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1542         Session Handling and Authentication
1543       </a>
1544     </li>
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1554         TypeScript and JavaScript
1555       </a>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1566         Templates
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576     <li class="md-nav__item">
1577       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1578         Third Party Libraries
1579       </a>
1580     </li>
1581
1582
1583
1584         </ul>
1585       </nav>
1586     </li>
1587
1588
1589
1590
1591
1592
1593
1594
1595     <li class="md-nav__item md-nav__item--nested">
1596
1597
1598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1599
1600       <label class="md-nav__link" for="__nav_6_2">
1601         Migrating from WSC 5.2
1602         <span class="md-nav__icon md-icon"></span>
1603       </label>
1604       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1605         <label class="md-nav__title" for="__nav_6_2">
1606           <span class="md-nav__icon md-icon"></span>
1607           Migrating from WSC 5.2
1608         </label>
1609         <ul class="md-nav__list" data-md-scrollfix>
1610
1611
1612
1613
1614
1615     <li class="md-nav__item">
1616       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1617         PHP API
1618       </a>
1619     </li>
1620
1621
1622
1623
1624
1625
1626
1627     <li class="md-nav__item">
1628       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1629         Templates and Languages
1630       </a>
1631     </li>
1632
1633
1634
1635
1636
1637
1638
1639     <li class="md-nav__item">
1640       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1641         Third Party Libraries
1642       </a>
1643     </li>
1644
1645
1646
1647         </ul>
1648       </nav>
1649     </li>
1650
1651
1652
1653
1654
1655
1656
1657
1658     <li class="md-nav__item md-nav__item--nested">
1659
1660
1661         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1662
1663       <label class="md-nav__link" for="__nav_6_3">
1664         Migrating from WSC 3.1
1665         <span class="md-nav__icon md-icon"></span>
1666       </label>
1667       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1668         <label class="md-nav__title" for="__nav_6_3">
1669           <span class="md-nav__icon md-icon"></span>
1670           Migrating from WSC 3.1
1671         </label>
1672         <ul class="md-nav__list" data-md-scrollfix>
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1680         PHP API
1681       </a>
1682     </li>
1683
1684
1685
1686         </ul>
1687       </nav>
1688     </li>
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item md-nav__item--nested">
1698
1699
1700         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1701
1702       <label class="md-nav__link" for="__nav_6_4">
1703         Migrating from WSC 3.0
1704         <span class="md-nav__icon md-icon"></span>
1705       </label>
1706       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1707         <label class="md-nav__title" for="__nav_6_4">
1708           <span class="md-nav__icon md-icon"></span>
1709           Migrating from WSC 3.0
1710         </label>
1711         <ul class="md-nav__list" data-md-scrollfix>
1712
1713
1714
1715
1716
1717     <li class="md-nav__item">
1718       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1719         PHP API
1720       </a>
1721     </li>
1722
1723
1724
1725
1726
1727
1728
1729     <li class="md-nav__item">
1730       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1731         JavaScript API
1732       </a>
1733     </li>
1734
1735
1736
1737
1738
1739
1740
1741     <li class="md-nav__item">
1742       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1743         Templates
1744       </a>
1745     </li>
1746
1747
1748
1749
1750
1751
1752
1753     <li class="md-nav__item">
1754       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1755         CSS
1756       </a>
1757     </li>
1758
1759
1760
1761
1762
1763
1764
1765     <li class="md-nav__item">
1766       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1767         Package Components
1768       </a>
1769     </li>
1770
1771
1772
1773         </ul>
1774       </nav>
1775     </li>
1776
1777
1778
1779
1780
1781
1782
1783
1784     <li class="md-nav__item md-nav__item--nested">
1785
1786
1787         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1788
1789       <label class="md-nav__link" for="__nav_6_5">
1790         Migrating from WCF 2.1
1791         <span class="md-nav__icon md-icon"></span>
1792       </label>
1793       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1794         <label class="md-nav__title" for="__nav_6_5">
1795           <span class="md-nav__icon md-icon"></span>
1796           Migrating from WCF 2.1
1797         </label>
1798         <ul class="md-nav__list" data-md-scrollfix>
1799
1800
1801
1802
1803
1804     <li class="md-nav__item">
1805       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1806         PHP API
1807       </a>
1808     </li>
1809
1810
1811
1812
1813
1814
1815
1816     <li class="md-nav__item">
1817       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1818         Templates
1819       </a>
1820     </li>
1821
1822
1823
1824
1825
1826
1827
1828     <li class="md-nav__item">
1829       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1830         CSS
1831       </a>
1832     </li>
1833
1834
1835
1836
1837
1838
1839
1840     <li class="md-nav__item">
1841       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1842         Package Components
1843       </a>
1844     </li>
1845
1846
1847
1848         </ul>
1849       </nav>
1850     </li>
1851
1852
1853
1854         </ul>
1855       </nav>
1856     </li>
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item md-nav__item--nested">
1869
1870
1871         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1872
1873       <label class="md-nav__link" for="__nav_7">
1874         Tutorials
1875         <span class="md-nav__icon md-icon"></span>
1876       </label>
1877       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1878         <label class="md-nav__title" for="__nav_7">
1879           <span class="md-nav__icon md-icon"></span>
1880           Tutorials
1881         </label>
1882         <ul class="md-nav__list" data-md-scrollfix>
1883
1884
1885
1886
1887
1888
1889     <li class="md-nav__item md-nav__item--nested">
1890
1891
1892         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1893
1894       <label class="md-nav__link" for="__nav_7_1">
1895         Tutorial Series
1896         <span class="md-nav__icon md-icon"></span>
1897       </label>
1898       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1899         <label class="md-nav__title" for="__nav_7_1">
1900           <span class="md-nav__icon md-icon"></span>
1901           Tutorial Series
1902         </label>
1903         <ul class="md-nav__list" data-md-scrollfix>
1904
1905
1906
1907
1908
1909     <li class="md-nav__item">
1910       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1911         Overview
1912       </a>
1913     </li>
1914
1915
1916
1917
1918
1919
1920
1921     <li class="md-nav__item">
1922       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1923         Part 1
1924       </a>
1925     </li>
1926
1927
1928
1929
1930
1931
1932
1933     <li class="md-nav__item">
1934       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1935         Part 2
1936       </a>
1937     </li>
1938
1939
1940
1941
1942
1943
1944
1945     <li class="md-nav__item">
1946       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1947         Part 3
1948       </a>
1949     </li>
1950
1951
1952
1953
1954
1955
1956
1957     <li class="md-nav__item">
1958       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1959         Part 4
1960       </a>
1961     </li>
1962
1963
1964
1965         </ul>
1966       </nav>
1967     </li>
1968
1969
1970
1971         </ul>
1972       </nav>
1973     </li>
1974
1975
1976
1977   </ul>
1978 </nav>
1979                   </div>
1980                 </div>
1981               </div>
1982
1983
1984
1985               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1986                 <div class="md-sidebar__scrollwrap">
1987                   <div class="md-sidebar__inner">
1988
1989 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1990
1991
1992
1993
1994
1995
1996     <label class="md-nav__title" for="__toc">
1997       <span class="md-nav__icon md-icon"></span>
1998       Table of contents
1999     </label>
2000     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2001
2002         <li class="md-nav__item">
2003   <a href="#expected-value" class="md-nav__link">
2004     Expected Value
2005   </a>
2006
2007 </li>
2008
2009         <li class="md-nav__item">
2010   <a href="#features" class="md-nav__link">
2011     Features
2012   </a>
2013
2014     <nav class="md-nav" aria-label="Features">
2015       <ul class="md-nav__list">
2016
2017           <li class="md-nav__item">
2018   <a href="#logging" class="md-nav__link">
2019     Logging
2020   </a>
2021
2022 </li>
2023
2024           <li class="md-nav__item">
2025   <a href="#instance-number" class="md-nav__link">
2026     Instance Number
2027   </a>
2028
2029 </li>
2030
2031           <li class="md-nav__item">
2032   <a href="#table-type" class="md-nav__link">
2033     Table Type
2034   </a>
2035
2036 </li>
2037
2038       </ul>
2039     </nav>
2040
2041 </li>
2042
2043         <li class="md-nav__item">
2044   <a href="#limitations" class="md-nav__link">
2045     Limitations
2046   </a>
2047
2048     <nav class="md-nav" aria-label="Limitations">
2049       <ul class="md-nav__list">
2050
2051           <li class="md-nav__item">
2052   <a href="#logging_1" class="md-nav__link">
2053     Logging
2054   </a>
2055
2056 </li>
2057
2058           <li class="md-nav__item">
2059   <a href="#triggers" class="md-nav__link">
2060     Triggers
2061   </a>
2062
2063 </li>
2064
2065       </ul>
2066     </nav>
2067
2068 </li>
2069
2070         <li class="md-nav__item">
2071   <a href="#example" class="md-nav__link">
2072     Example
2073   </a>
2074
2075 </li>
2076
2077     </ul>
2078
2079 </nav>
2080                   </div>
2081                 </div>
2082               </div>
2083
2084
2085           <div class="md-content" data-md-component="content">
2086             <article class="md-content__inner md-typeset">
2087
2088
2089                   <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">
2090                     <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>
2091                   </a>
2092
2093
2094                 <h1 id="sql-package-installation-plugin">SQL Package Installation Plugin<a class="headerlink" href="#sql-package-installation-plugin" title="Permanent link">#</a></h1>
2095 <p>Execute SQL instructions using a MySQL-flavored syntax.</p>
2096 <div class="admonition warning">
2097 <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>
2098 </div>
2099 <h2 id="expected-value">Expected Value<a class="headerlink" href="#expected-value" title="Permanent link">#</a></h2>
2100 <p>The <code>sql</code> package installation plugin expects a relative path to a <code>.sql</code> file.</p>
2101 <h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">#</a></h2>
2102 <h3 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">#</a></h3>
2103 <p>WoltLab Suite Core uses a SQL parser to extract queries and log certain actions.
2104 This allows WoltLab Suite Core to revert some of the changes you apply upon package uninstallation.</p>
2105 <p>The logged changes are:</p>
2106 <ul>
2107 <li><code>CREATE TABLE</code></li>
2108 <li><code>ALTER TABLE … ADD COLUMN</code></li>
2109 <li><code>ALTER TABLE … ADD … KEY</code></li>
2110 </ul>
2111 <h3 id="instance-number">Instance Number<a class="headerlink" href="#instance-number" title="Permanent link">#</a></h3>
2112 <p>It is possible to use different instance numbers, e.g. two separate WoltLab Suite Core installations within one database.
2113 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.
2114 If you every use anything other but <code>1</code>, you will eventually break things, thus always use <code>1</code>!</p>
2115 <h3 id="table-type">Table Type<a class="headerlink" href="#table-type" title="Permanent link">#</a></h3>
2116 <p>WoltLab Suite Core will determine the type of database tables on its own:
2117 If the table contains a <code>FULLTEXT</code> index, it uses <code>MyISAM</code>, otherwise <code>InnoDB</code> is used.</p>
2118 <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title="Permanent link">#</a></h2>
2119 <h3 id="logging_1">Logging<a class="headerlink" href="#logging_1" title="Permanent link">#</a></h3>
2120 <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.
2121 Additionally, WoltLab Suite Core does not track regular SQL queries such as <code>DELETE</code> or <code>UPDATE</code>.</p>
2122 <h3 id="triggers">Triggers<a class="headerlink" href="#triggers" title="Permanent link">#</a></h3>
2123 <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.
2124 If you really need triggers, you should consider adding them by custom SQL queries using a <a href="../script/">script</a>.</p>
2125 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2126 <p><code>package.xml</code>:</p>
2127 <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>
2128 </code></pre></div>
2129 <p>Example content:</p>
2130 <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>
2131     <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>
2132     <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>
2133     <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>
2134     <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>
2135
2136     <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>
2137 <span class="p">);</span>
2138
2139 <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>
2140 </code></pre></div>
2141
2142
2143
2144
2145 <hr>
2146 <div class="md-source-date">
2147   <small>
2148
2149       Last update: 2021-01-08
2150
2151   </small>
2152 </div>
2153
2154
2155
2156
2157
2158
2159
2160
2161             </article>
2162           </div>
2163         </div>
2164
2165       </main>
2166
2167
2168 <footer class="md-footer">
2169
2170     <nav class="md-footer__inner md-grid" aria-label="Footer">
2171
2172         <a href="../smiley/" class="md-footer__link md-footer__link--prev" rel="prev">
2173           <div class="md-footer__button md-icon">
2174             <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>
2175           </div>
2176           <div class="md-footer__title">
2177             <div class="md-ellipsis">
2178               <span class="md-footer__direction">
2179                 Previous
2180               </span>
2181               smiley
2182             </div>
2183           </div>
2184         </a>
2185
2186
2187         <a href="../style/" class="md-footer__link md-footer__link--next" rel="next">
2188           <div class="md-footer__title">
2189             <div class="md-ellipsis">
2190               <span class="md-footer__direction">
2191                 Next
2192               </span>
2193               style
2194             </div>
2195           </div>
2196           <div class="md-footer__button md-icon">
2197             <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>
2198           </div>
2199         </a>
2200
2201     </nav>
2202
2203   <div class="md-footer-meta md-typeset">
2204     <div class="md-footer-meta__inner md-grid">
2205       <div class="md-footer-copyright">
2206
2207           <div class="md-footer-copyright__highlight">
2208             Copyright © 2020 WoltLab GmbH
2209           </div>
2210
2211         Made with
2212         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2213           Material for MkDocs
2214         </a>
2215
2216       </div>
2217       <div class="md-footer-copyright">
2218         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2219         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2220 </div>
2221     </div>
2222   </div>
2223 </footer>
2224
2225     </div>
2226     <div class="md-dialog" data-md-component="dialog">
2227       <div class="md-dialog__inner md-typeset"></div>
2228     </div>
2229     <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>
2230
2231
2232       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2233
2234
2235   </body>
2236 </html>