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