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