1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
|
<section class="plugins">
<h1 class="h1">Sequel::Model Plugins for v<%= Sequel.version %></h1>
<div class="plugins__sidebar">
<aside class="plugins__sidebar-aside">
<nav class="nav">
<ul class="nav__ul nav__ul--column">
<li class="nav__li">
<a href="plugins.html#plugins" class="nav__a">Sequel Plugins</a>
<a href="plugins.html#plugins-sequel" class="a">Plugins that ship with Sequel</a>
<a href="plugins.html#plugins-external" class="a">External Plugins</a>
</li>
<li class="nav__li">
<a href="plugins.html#extensions" class="nav__a">Sequel Extensions</a>
<a href="plugins.html#extensions-database-sequel" class="a">Database extensions that ship with Sequel</a>
<a href="plugins.html#extensions-dataset-sequel" class="a">Dataset extensions that ship with Sequel</a>
<a href="plugins.html#extensions-global-sequel" class="a">Global extensions that ship with Sequel</a>
<a href="plugins.html#extensions-external" class="a">External Extensions</a>
<a href="plugins.html#extensions-external-adapters" class="a">External Adapters</a>
</li>
<li class="nav__li">
<a href="plugins.html#submit" class="nav__a">Submit your Plugin, Extension or Adapter</a>
</li>
</ul>
</nav>
</aside>
<div class="plugins__sidebar-content">
<a name="plugins"></a>
<h2 class="h2">Sequel::Model <span class="h2__span">has a standardized and very flexible plugin architecture, see the <a class="a" href="rdoc/classes/Sequel/Plugins.html">RDoc</a>. Here is a list of plugins that members of the Sequel community have developed. </span>
</h2>
<div class="row">
<div class="row__item">
<a name="plugins-sequel"></a>
<h3 class="h3">Plugins that ship with Sequel</h3>
<h4 class="h4">Associations</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AssociationDependencies.html">association_dependencies </a>
<span class="ul__span">Allows easy deleting, destroying, or nullifying associated objects when destroying a model object.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AssociationLazyEagerOption.html">association_lazy_eager_option </a>
<span class="ul__span">Support :eager option when calling association method, for per-call eager loading when association is not cached.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AssociationMultiAddRemove.html">association_multi_add_remove </a>
<span class="ul__span">Allows adding/removing multiple associated objects in a single method call.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AssociationPks.html">association_pks </a>
<span class="ul__span">Adds the association_pks and association_pks= to *_to_many associations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AssociationProxies.html">association_proxies </a>
<span class="ul__span">Changes the *_to_many association method to return a proxy instead of an array of objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AutoRestrictEagerGraph.html">auto_restrict_eager_graph</a>
<span class="ul__span">Automatically disallow the use of eager_graph for associations with blocks but without :graph_* conditions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ConcurrentEagerLoading.html">concurrent_eager_loading </a>
<span class="ul__span">Allows you to concurrently eagerly load multiple associations using the async_thread_pool Database extension.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/DatasetAssociations.html">dataset_associations </a>
<span class="ul__span">Adds association methods to datasets that return datasets of associated objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/DelayAddAssociation.html">delay_add_association </a>
<span class="ul__span">Delay add_<i>association</i> calls on new objects until after after the object is saved. </span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/EagerEach.html">eager_each </a>
<span class="ul__span">Makes each on an eagerly loaded dataset do eager loading.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/EagerGraphEager.html">eager_graph_eager </a>
<span class="ul__span">Allows chaining eager loads to associations loaded by eager_graph.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ForbidLazyLoad.html">forbid_lazy_load </a>
<span class="ul__span">Forbids lazy loading of associations in cases where they could cause N+1 query issues.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InstanceSpecificDefault.html">instance_specific_default</a>
<span class="ul__span">Find associations that would benefit from having the :instance_specific option specified.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ManyThroughMany.html">many_through_many </a>
<span class="ul__span">Allows you to create an association through multiple join tables.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/NestedAttributes.html">nested_attributes </a>
<span class="ul__span">Allows you to modified associated objects directly through a model object, similar to ActiveRecord's Nested Attributes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/PgArrayAssociations.html">pg_array_associations </a>
<span class="ul__span">Adds associations types to handle the case where foreign keys are stored in a PostgreSQL array in one of the tables.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/RcteTree.html">rcte_tree </a>
<span class="ul__span">Supports retrieving all ancestors and descendants for tree structured data using recursive common table expressions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/TacticalEagerLoading.html">tactical_eager_loading </a>
<span class="ul__span">Allows you to eagerly load an association for all objects retreived from the same dataset when calling the association method on any of the objects in the dataset.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Tree.html">tree </a>
<span class="ul__span">Allows you to treat model objects as being part of a tree, finding ancestors, descendants, siblings, and tree roots.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/UnusedAssociations.html">unused_associations </a>
<span class="ul__span">Determines which associations and association methods you can skip defining to save on memory.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ValidateAssociated.html">validate_associated </a>
<span class="ul__span">Supports validating associated objects at the same time as the current object.</span>
</li>
</ul>
<h4 class="h4">Attributes</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AccessedColumns.html">accessed_columns </a>
<span class="ul__span">Records which columns have been accessed for a given model instance.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/BlacklistSecurity.html">blacklist_security </a>
<span class="ul__span">Adds blacklist-based model mass-assignment protection.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/BooleanReaders.html">boolean_readers </a>
<span class="ul__span">Adds attribute? methods for all boolean columns.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ColumnConflicts.html">column_conflicts </a>
<span class="ul__span">Automatically handles column names that conflict with Ruby/Sequel method names.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ColumnEncryption.html">column_encryption </a>
<span class="ul__span">Encrypt column values stored in the database.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Dirty.html">dirty </a>
<span class="ul__span">Allows you get get initial values of columns after changing the values.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/DefaultsSetter.html">defaults_setter </a>
<span class="ul__span">Get default values for new models before saving.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Enum.html">enum </a>
<span class="ul__span">Allows for treating a column as a enum.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ForceEncoding.html">force_encoding </a>
<span class="ul__span">Forces the all model column string values to a given encoding.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InputTransformer.html">input_transformer </a>
<span class="ul__span">Automatically transform input to model column setters.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/LazyAttributes.html">lazy_attributes </a>
<span class="ul__span">Allows you to set some attributes that should not be loaded by default, but only loaded when an object requests them.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ModificationDetection.html">modification_detection </a>
<span class="ul__span">Automatically detect in-place changes to column values.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SplitValues.html">split_values </a>
<span class="ul__span">Splits noncolumn entries from values hash into separate hash.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/StringStripper.html">string_stripper </a>
<span class="ul__span">Strips strings assigned to model attributes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Uuid.html">uuid </a>
<span class="ul__span">Automatically sets UUID attribute when creating model objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/WhitelistSecurity.html">whitelist_security </a>
<span class="ul__span">Adds whitelist-based model mass-assignment protection.</span>
</li>
</ul>
<h4 class="h4">Caching</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Caching.html">caching </a>
<span class="ul__span">Supports caching primary key lookups of model objects to any object that supports the Ruby-Memcache API.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/StaticCache.html">static_cache </a>
<span class="ul__span">Caches all model instances, improving performance for static models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/StaticCacheCache.html">static_cache_cache </a>
<span class="ul__span">Support caching rows for static_cache models to a file to avoid database queries during model initialization.</span>
</li>
</ul>
<h4 class="h4">Hooks</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AfterInitialize.html">after_initialize </a>
<span class="ul__span">Adds an after_initialize hook to model objects, called for both new objects and those loaded from the database.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/HookClassMethods.html">hook_class_methods </a>
<span class="ul__span">Adds backwards compatiblity for the legacy class-level hook methods (e.g. before_save :do_something).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InstanceHooks.html">instance_hooks </a>
<span class="ul__span">Allows you to add hooks to specific model instances.</span>
</li>
</ul>
<h4 class="h4">Inheritance</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ClassTableInheritance.html">class_table_inheritance </a>
<span class="ul__span">Supports inheritance in the database by using a single database table for each class in a class hierarchy.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SingleTableInheritance.html">single_table_inheritance </a>
<span class="ul__span">Supports inheritance in the database by using a single table for all classes in a class hierarchy.</span>
</li>
</ul>
<h4 class="h4">Prepared Statements</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/PreparedStatements.html">prepared_statements </a>
<span class="ul__span">Makes models use prepared statements for deletes, inserts, updates, and lookups by primary key.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/PreparedStatementsSafe.html">prepared_statements_safe </a>
<span class="ul__span">Makes use of prepared_statements plugin more safe by setting explicit defaults for model columns when inserting and saving whole rows instead of changed columns.</span>
</li>
</ul>
<h4 class="h4">Saving</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ColumnsUpdated.html">columns_updated </a>
<span class="ul__span">Makes columns hash used for updates available in after_update and after_save hooks.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InsertConflict.html">insert_conflict </a>
<span class="ul__span">Allows handling unique constraint conflicts when saving new model instances on PostgreSQL 9.5+ and SQLite 3.24.0+.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InstanceFilters.html">instance_filters </a>
<span class="ul__span">Allows you to add per instance filters that are used when updating or destroying the instance.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/MssqlOptimisticLocking.html">mssql_optimistic_locking </a>
<span class="ul__span">Uses a timestamp/rowversion column on Microsoft SQL Server to prevent concurrent updates overwriting changes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/OptimisticLocking.html">optimistic_locking </a>
<span class="ul__span">Adds a database-independent locking mechanism to models to prevent concurrent updates overwriting changes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Sharding.html">sharding </a>
<span class="ul__span">Additional model support for Sequel's sharding support.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SkipCreateRefresh.html">skip_create_refresh </a>
<span class="ul__span">Allows you to skip the refresh when saving new model objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SkipSavingColumns.html">skip_saving_columns </a>
<span class="ul__span">Allows for marking columns to skip when saving model objects, and skips the saving of generated columns by default.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Timestamps.html">timestamps </a>
<span class="ul__span">Creates hooks for automatically setting create and update timestamps.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Touch.html">touch </a>
<span class="ul__span">Allows easily updating timestamps via Model#touch, as well as touching associations when model instances are updated or destroyed.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/UnlimitedUpdate.html">unlimited_update </a>
<span class="ul__span">Works around MySQL warnings when using replication due to LIMIT clause use when updating model instances.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/UpdateOrCreate.html">update_or_create </a>
<span class="ul__span">Adds helper methods for updating an object if it exists, or creating such an object if it does not.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/UpdatePrimaryKey.html">update_primary_key </a>
<span class="ul__span">Allows you to safely update the primary key of a model object.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/UpdateRefresh.html">update_refresh </a>
<span class="ul__span">Refreshes a model object when updating it.</span>
</li>
</ul>
<h4 class="h4">Selection</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ColumnSelect.html">column_select </a>
<span class="ul__span">Selects explicitly qualified columns (table.column1, table.column2, ...) instead of just * for model datasets.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InsertReturningSelect.html">insert_returning_select </a>
<span class="ul__span">Automatically sets RETURNING clause for INSERT queries for models that use an explicit column selection.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/TableSelect.html">table_select </a>
<span class="ul__span">Selects table.* instead of just * for model datasets.</span>
</li>
</ul>
<h4 class="h4">Serialization</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Composition.html">composition </a>
<span class="ul__span">Supports defining getters/setters for objects with data backed by the model's columns.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/CsvSerializer.html">csv_serializer </a>
<span class="ul__span">Allows you to serialize/deserialize model objects to/from CSV.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/JsonSerializer.html">json_serializer </a>
<span class="ul__span">Allows you to serialize/deserialize model objects to/from JSON.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Serialization.html">serialization </a>
<span class="ul__span">Supports serializing column values and storing them as either marshal, yaml, or json in the database.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SerializationModificationDetection.html">serialization_modification_detection </a>
<span class="ul__span">Allows you to detect changes to serialized columns.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/XmlSerializer.html">xml_serializer </a>
<span class="ul__span">Allows you to serialize/deserialize model objects to/from XML.</span>
</li>
</ul>
<h4 class="h4">Subsets</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/BooleanSubsets.html">boolean_subsets </a>
<span class="ul__span">Automatically creates a subset method for each boolean column.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/DefDatasetMethod.html">def_dataset_method </a>
<span class="ul__span">Adds Model.def_dataset_method and Model.subset for backwards compatibility.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/InvertedSubsets.html">inverted_subsets </a>
<span class="ul__span">Creates an additional method for each subset, that inverts the subset's conditions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SubsetConditions.html">subset_conditions </a>
<span class="ul__span">Creates an additional method for each subset, returning the filter conditions used for the subset.</span>
</li>
</ul>
<h4 class="h4">Validations</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AutoValidations.html">auto_validations </a>
<span class="ul__span">Automatically add presence/not_null, max length, type, and unique validations based on the model's schema.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AutoValidationsConstraintValidationsPresenceMessage.html">auto_validations_constraint<br>_validations_presence_message</a>
<span class="ul__span">Use more specific constraint_validations error message instead of generic auto_validations in certain cases.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ConstraintValidations.html">constraint_validations </a>
<span class="ul__span">Setup automatic validations for constraints added via the <a class="a" href="rdoc-plugins/files/lib/sequel/extensions/constraint_validations_rb.html">constraint_validations extension</a>. </span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/EmptyFailureBacktraces.html">empty_failure_backtraces </a>
<span class="ul__span">Uses empty backtraces for ValidationFailed and HookFailed exceptions, for much better performance on JRuby.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ErrorSplitter.html">error_splitter </a>
<span class="ul__span">Splits multi-column errors entries into separate errors, one per column.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/PgAutoConstraintValidations.html">pg_auto_constraint_validations </a>
<span class="ul__span">Automatically convert constraint violations during INSERT/UPDATE on PostgreSQL to validation failures.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ThrowFailures.html">throw_failures </a>
<span class="ul__span">Throws ValidationFailed and HookFailed exceptions instead of raising them, if a matching catch block is used.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ValidationClassMethods.html">validation_class_methods </a>
<span class="ul__span">Adds backwards compatibility for the legacy class-level validation methods (e.g. validates_presence_of :column).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ValidationContexts.html">validation_contexts </a>
<span class="ul__span">Allow specifying a context to use during validations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ValidationHelpers.html">validation_helpers </a>
<span class="ul__span">The preferred default validations plugin, which uses instance-level methods.</span>
</li>
</ul>
<h4 class="h4">Other</h4>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ActiveModel.html">active_model </a>
<span class="ul__span">Makes Sequel::Model objects compliant to the ActiveModel::Lint specs, so they should work correctly in Rails 3+.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/AsyncThreadPool.html">async_thread_pool </a>
<span class="ul__span">Adds better support for model classes to use the async_thread_pool Database extension.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Finder.html">finder </a>
<span class="ul__span">Adds Model.finder and Model.prepared_finder methods for defining optimized lookup methods.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/List.html">list </a>
<span class="ul__span">Allows you to treat model objects as being part of a list, so you can move them up/down and get next/previous entries.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/PgRow.html">pg_row </a>
<span class="ul__span">Allows Sequel::Model classes to implement PostgreSQL row-valued/composite types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/RequireValidSchema.html">primary_key_lookup_check_values </a>
<span class="ul__span">Typecasts and checks values in allowed range during lookups by primary key.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/RequireValidSchema.html">require_valid_schema </a>
<span class="ul__span">Requires that model classes selecting from simple tables have valid schema.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SingularTableNames.html">singular_table_names </a>
<span class="ul__span">Makes Sequel default to not pluralizing table names.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SqlComments.html">sql_comments </a>
<span class="ul__span">Supports automatically adding comments to queries to show which class, instance, dataset, or association method triggered the query.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/Subclasses.html">subclasses </a>
<span class="ul__span">Allows easy access all model subclasses and descendent classes, without using ObjectSpace.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/TypecastOnLoad.html">typecast_on_load </a>
<span class="ul__span">Fixes bad database typecasting when loading model objects.</span>
</li>
</ul>
<a name="plugins-external"></a>
<h3 class="h3">External Plugins</h3>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jeremyevans/forme">forme </a>
<span class="ul__span">HTML forms library for ruby that integrates with Sequel::Model for easy form creation.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/kenaniah/sequel-active_record">sequel-active_record </a>
<span class="ul__span">Provides ActiveRecord compatibility to ease transitions to Sequel.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/sequel_bulk_attributes">sequel_bulk_attributes </a>
<span class="ul__span">Provides bulk assignment functionality for one_to_many associations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/sdepold/sequel-bit_fields">sequel-bit_fields </a>
<span class="ul__span">Allows treating an integer column as a bitfield of many boolean settings.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/monterail/sequel-combine">sequel-combine </a>
<span class="ul__span">Provides functionality of composing with childrens, parents or any object where exists any relationship. Now it is possible in one query.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/sbfaulkner/sequel_container">sequel_container </a>
<span class="ul__span">Contained documents (i.e. attachments) for models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/mig-hub/sequel-crushyform">sequel_crushyform </a>
<span class="ul__span">Builds forms for you</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jrgns/sequel-elasticsearch">sequel-elasticsearch </a>
<span class="ul__span">Sync Sequel models to Elasticsearch.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/AlexWayfer/sequel-enum_values">sequel-enum_values </a>
<span class="ul__span">Provides <code class="plugins__code">enum_values(field_name)</code> method for model class and optional optional instance predicate methods like <code class="plugins__code">created?</code>. </span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/adam12/sequel-hash_id">sequel-hash_id </a>
<span class="ul__span">Obscure your primary keys with a hashid.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/elithecho/sequel_nanoid">sequel_nanoid </a>
<span class="ul__span">Obscure your primary keys using nanoID.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/sequel_mappable">sequel_mappable </a>
<span class="ul__span">Provides geocoding functionality to model and dataset.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/pkondzior/sequel_nested_set">sequel_nested_set </a>
<span class="ul__span">Nested set implementation, ported from the Awesome Nested Set Active Record plugin.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/dashingrocket/sequel-nonsequential_id">sequel-nonsequential_id </a>
<span class="ul__span">Automatically generate non-sequential (pseudo-random) IDs for Sequel Models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/boof/sequel_notnaughty">sequel_notnaughty </a>
<span class="ul__span">Port of the NotNaughty validation framework.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/sequel_paperclip">sequel_paperclip </a>
<span class="ul__span">Provides attachment functionality for models, including post processing (thumbnail generation, etc.).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/yuryroot/sequel-pg_advisory_lock">sequel-pg_advisory_lock </a>
<span class="ul__span">Allows you to use PostgreSQL advisory locks for application-level mutexes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/tycooon/sequel_pretty_print">sequel_pretty_print </a>
<span class="ul__span">Adds Ruby PrettyPrint support to models (works in Pry console).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jackdempsey/sequel_polymorphic">sequel_polymorphic </a>
<span class="ul__span">Lets you easily create polymorphic associations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/daicoden/sequel_proc_error_handling">sequel_proc_error_handling </a>
<span class="ul__span">Lets you add procs that automatically rescue and fix model errors.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/mlen/sequel_secure_password">sequel_secure_password </a>
<span class="ul__span">Adds bcrypt authentication and password hashing to models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/sequel_sexy_validations">sequel_sexy_validations </a>
<span class="ul__span">Provides sexy validations (like those in rails 3) for models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/tadman/sequel_simple_callbacks">sequel_simple_callbacks </a>
<span class="ul__span">Enables ActiveRecord-compatible class-level before and after filter declarations for models with support for conditional execution.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/pk/sequel_sluggable">sequel_sluggable </a>
<span class="ul__span">Easy slug behaviour for any model.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/QuinnHarris/sequel-table_inheritance">sequel-table_inheritance </a>
<span class="ul__span">Combines the functionality of the single table inheritance and class table inheritance plugins.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jackdempsey/sequel_taggable">sequel_taggable </a>
<span class="ul__span">Allows easily adding tags to any model.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/kenaniah/sequel-through">sequel-through </a>
<span class="ul__span">Adds support for :through associations between models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jeremyevans/sequel_validation_helpers_block">sequel_validation_helpers_block </a>
<span class="ul__span">Allows easy determination of which validation rules apply to a given column, at the expense of increased verbosity.</span>
</li>
</ul>
</div>
</div>
<hr class="hr" />
<h2 class="h2" id="sequel-extensions">Sequel Extensions <span class="h2__span">are modifications or additions to Sequel that affect either Sequel::Database objects (database extensions), Sequel::Dataset objects (dataset extensions), or the general ruby environment (global extensions). <span class="ul__span">
</h2>
<div class="row">
<div class="row__item">
<a name="extensions-database-sequel"></a>
<h3 class="h3">Database extensions that ship with Sequel</h3>
<p>Database extensions can be loaded into a single Sequel::Database object via Sequel::Database#extension, or to all databases by using Sequel::Database.extension.</p>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/arbitrary_servers_rb.html">arbitrary_servers </a>
<span class="ul__span">Adds ability to connection to arbitrary servers (instead of just preconfigured ones) in the sharding support.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/async_thread_pool_rb.html">async_thread_pool </a>
<span class="ul__span">Adds support for running queries asynchronously using a thread pool.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/caller_logging_rb.html">caller_logging </a>
<span class="ul__span">Include caller information when logging queries.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/connection_expiration_rb.html">connection_expiration </a>
<span class="ul__span">Automatically removes connections from the pool after they have been open longer than a timeout.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/connection_validator_rb.html">connection_validator </a>
<span class="ul__span">Automatically validates connections on pool checkout and handles disconnections transparently.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/constant_sql_override_rb.html">constant_sql_override </a>
<span class="ul__span">Override generated SQL for Sequel constants with configurable strings.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/constraint_validations_rb.html">constraint_validations </a>
<span class="ul__span">Creates database constraints when creating/altering tables, with metadata for <a class="a" href="rdoc-plugins/classes/Sequel/Plugins/ConstraintValidations.html">automatic model validations via the constraint_validations plugin</a>. </span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/error_sql_rb.html">error_sql </a>
<span class="ul__span">Makes DatabaseError#sql return the SQL query that caused the underlying exception.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/identifier_mangling_rb.html">identifier_mangling </a>
<span class="ul__span">Support modification for the default identifier mangling for the database.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/index_caching_rb.html">index_caching </a>
<span class="ul__span">Speeds up loading index information by saving/loading database index metadata to a file.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/integer64_rb.html">integer64 </a>
<span class="ul__span">Treats the Integer class as a 64-bit integer instead of a 32-bit integer when used as a generic database type.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/looser_typecasting_rb.html">looser_typecasting </a>
<span class="ul__span">Uses .to_f and .to_i instead of Kernel.Float and Kernel.Integer when typecasting floats and integers.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_array_rb.html">pg_array </a>
<span class="ul__span">Adds support for PostgreSQL arrays.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_auto_parameterize_rb.html">pg_auto_parameterize </a>
<span class="ul__span">Automatically parameterizes queries when using the postgres adapter with the pg driver.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_enum_rb.html">pg_enum </a>
<span class="ul__span">Adds support for PostgreSQL enums.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_extended_date_support_rb.html">pg_extended_date_support </a>
<span class="ul__span">Adds support for PostgreSQL infinite and BC date/timestamp support.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_extended_integer_support_rb.html">pg_extended_integer_support </a>
<span class="ul__span">Adds support for handling Ruby integers outside PostgreSQL bigint range.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_hstore_rb.html">pg_hstore </a>
<span class="ul__span">Adds support for the PostgreSQL hstore type.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_inet_rb.html">pg_inet </a>
<span class="ul__span">Adds support for the PostgreSQL inet and cidr types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_interval_rb.html">pg_interval </a>
<span class="ul__span">Adds support for the PostgreSQL interval type.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_json_rb.html">pg_json </a>
<span class="ul__span">Adds support for the PostgreSQL json type.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_loose_count_rb.html">pg_loose_count </a>
<span class="ul__span">Adds Database#loose_count for fast approximate counts of whole tables on PostgreSQL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_multirange_rb.html">pg_multirange </a>
<span class="ul__span">Adds support for PostgreSQL multirange types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_range_rb.html">pg_range </a>
<span class="ul__span">Adds support for PostgreSQL range types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_row_rb.html">pg_row </a>
<span class="ul__span">Adds support for PostgreSQL row-valued/composite types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_static_cache_updater_rb.html">pg_static_cache_updater </a>
<span class="ul__span">Listens for changes to underlying tables in order to automatically update models using the static_cache plugin.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_timestamptz_rb.html">pg_timestamptz </a>
<span class="ul__span">Uses timestamptz (timestamp with time zone) as the generic timestamp type used for Time and DateTime classes.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/run_transaction_hooks_rb.html">run_transaction_hooks </a>
<span class="ul__span">Support running after_commit and after_rollback transaction hooks before transaction commit/rollback, designed for transactional testing.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/schema_caching_rb.html">schema_caching </a>
<span class="ul__span">Speeds up loading a large number of models by caching database schema and loading it from a file.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/schema_dumper_rb.html">schema_dumper </a>
<span class="ul__span">Adds Database#dump_schema_migration and related methods for dumping the schema of the database as a migration that can be restored on other databases.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/server_block_rb.html">server_block </a>
<span class="ul__span">Adds Database#with_server method that makes access inside the passed block use the specified shard by default.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/server_logging_rb.html">server_logging </a>
<span class="ul__span">Include server/shard information when logging queries.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sql_comments_rb.html">sql_comments </a>
<span class="ul__span">Adds Database#with_comments method, for automatically using comments for queries exceuted inside a block.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sql_log_normalizer_rb.html">sql_log_normalizer </a>
<span class="ul__span">Normalizes SQL before logging, helpful for analytics and sensitive data.</span>
</li>
</ul>
<a name="extensions-dataset-sequel"></a>
<h3 class="h3">Dataset extensions that ship with Sequel</h3>
<p class="p">Dataset extensions can be loaded into a single Sequel::Database object via Sequel::Dataset#extension, or to all datasets for a given database via Sequel::Database#extension, or all datasets for all databases by using Sequel::Database.extension.</p>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/any_not_empty_rb.html">any_not_empty </a>
<span class="ul__span">Make Dataset#any? without block mean !empty?.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/auto_literal_strings_rb.html">auto_literal_strings </a>
<span class="ul__span">Automatically treats string arguments passed to filter methods as literal SQL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/columns_introspection_rb.html">columns_introspection </a>
<span class="ul__span">Attemps to skip database queries by introspecting the selected columns if possible.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/current_datetime_timestamp_rb.html">current_datetime_timestamp </a>
<span class="ul__span">Creates current Time/DateTime objects that are literalized as CURRENT_TIMESTAMP.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/dataset_source_alias_rb.html">dataset_source_alias </a>
<span class="ul__span">Automatically aliases datasets to their source instead of using t1, t2, etc.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/date_arithmetic_rb.html">date_arithmetic </a>
<span class="ul__span">Allows for database-independent date calculations (adding/subtracting an interval to/from a date/timestamp).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/duplicate_columns_handler_rb.html">duplicate_columns_handler </a>
<span class="ul__span">Allows you to raise or warn if the dataset returns multiple columns with the same name when returning the results.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/empty_array_consider_nulls_rb.html">empty_array_consider_nulls </a>
<span class="ul__span">Makes Sequel's handling of IN/NOT IN with an empty array use a NULL expression for NULL column values.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/exclude_or_null_rb.html">exclude_or_null </a>
<span class="ul__span">Add Dataset#exclude_or_null for only including rows where condition is false or NULL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/graph_each_rb.html">graph_each </a>
<span class="ul__span">Makes Dataset#each split returned results by table when using Dataset#graph.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/implicit_subquery_rb.html">implicit_subquery </a>
<span class="ul__span">Makes dataset methods that return datasets with modified SQL use a subquery implicitly if the current dataset uses raw SQL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/is_distinct_from_rb.html">is_distinct_from </a>
<span class="ul__span">Allows for using or emulating the IS DISTINCT FROM operator.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/null_dataset_rb.html">null_dataset </a>
<span class="ul__span">Adds Dataset#nullify to get a dataset that will never issue a query.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/mssql_emulate_lateral_with_apply_rb.html">mssql_emulate_lateral_with_apply </a>
<span class="ul__span">Emulates LATERAL queries using CROSS/OUTER APPLY on Microsoft SQL Server.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pagination_rb.html">pagination </a>
<span class="ul__span">Adds Dataset#paginate for easier pagination of datasets.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pretty_table_rb.html">pretty_table </a>
<span class="ul__span">Adds Dataset#print for printing a dataset as a simple plain-text table.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/query_rb.html">query </a>
<span class="ul__span">Adds Dataset#query for a different interface to creating queries that doesn't use method chaining.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/round_timestamps_rb.html">round_timestamps </a>
<span class="ul__span">Automatically round timestamp values to database supported precision before literalizing them.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/select_remove_rb.html">select_remove </a>
<span class="ul__span">Adds Dataset#select_remove to remove selected columns from a dataset.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sequel_4_dataset_methods_rb.html">sequel_4_dataset_methods </a>
<span class="ul__span">Adds #and, #exclude_where, #interval, and #range dataset methods.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/split_array_nil_rb.html">split_array_nil </a>
<span class="ul__span">Splits nils out of IN/NOT IN arrays into separate OR IS NULL or AND IS NOT NULL clauses.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sql_comments_rb.html">sql_comments </a>
<span class="ul__span">Adds Dataset#comment method, for setting an SQL comment in the queries created by the dataset.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/string_agg_rb.html">string_agg </a>
<span class="ul__span">Adds generic database support for aggregate string concatentation.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/synchronize_sql_rb.html">synchronize_sql </a>
<span class="ul__span">Checks out a connection while generating SQL strings, improving performance in some cases.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/to_dot_rb.html">to_dot </a>
<span class="ul__span">Adds Dataset#to_dot method, which returns a string suitable for processing by graphviz's dot program to get a visualization of the dataset's abstract syntax tree.</span>
</li>
</ul>
<a name="extensions-global-sequel"></a>
<h3 class="h3">Global extensions that ship with Sequel</h3>
<p class="p">Global extensions can affect other parts of Sequel or the general ruby environment, and are loaded with Sequel.extension.</p>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/blank_rb.html">blank</a>
<span class="ul__span">Adds blank? instance methods to all objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/core_extensions_rb.html">core_extensions</a>
<span class="ul__span">Extends the Array, Hash, String, and Symbol classes with methods that return Sequel expression objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/core_refinements_rb.html">core_refinements</a>
<span class="ul__span">Adds refinement versions of Sequel's core extensions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/eval_inspect_rb.html">eval_inspect</a>
<span class="ul__span">Makes inspect on Sequel's expression objects attempt to return a string suitable for eval.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/escaped_like_rb.html">escaped_like</a>
<span class="ul__span">Support creation of LIKE expressions with placeholders in the pattern without access to a dataset.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/date_parse_input_handler_rb.html">date_parse_input_handler</a>
<span class="ul__span">Allows for custom handling of input strings to the date parsing methods.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/datetime_parse_to_time_rb.html">datetime_parse_to_time</a>
<span class="ul__span">Uses DateTime.parse.to_time to parse timestamp strings without offset information where such timestamps are assumed to be in UTC.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/fiber_concurrency_rb.html">fiber_concurrency</a>
<span class="ul__span">Uses Fiber.current instead of Thread.current as the key for checking out connections.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/inflector_rb.html">inflector</a>
<span class="ul__span">Adds instance-level inflection methods to String.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/migration_rb.html">migration</a>
<span class="ul__span">Adds Migration and Migrator classes for easily migrating the database schema forward or reverting to a previous version.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/named_timezones_rb.html">named_timezones</a>
<span class="ul__span">Allows you to use named timezones instead of just :local and :utc (requires <a class="a" href="http://tzinfo.github.io/">TZInfo</a>).</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_array_ops_rb.html">pg_array_ops</a>
<span class="ul__span">Adds DSL support for calling PostgreSQL array operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_hstore_ops_rb.html">pg_hstore_ops</a>
<span class="ul__span">Adds DSL support for calling PostgreSQL hstore operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_inet_ops_rb.html">pg_inet_ops</a>
<span class="ul__span">Adds DSL support for calling PostgreSQL inet/cidr operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_json_ops_rb.html">pg_json_ops</a>
<span class="ul__span">Adds DSL support for calling PostgreSQL json operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_range_ops_rb.html">pg_range_ops</a>
<span class="ul__span">Adds DSL support for calling PostgreSQL range and multirange operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/pg_row_ops_rb.html">pg_row_ops</a>
<span class="ul__span">Adds DSL support for dealing with PostgreSQL row-valued/composite types.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/s_rb.html">s</a>
<span class="ul__span">Adds Sequel::S module with #S private method for easily calling Sequel.expr, including use as a refinement.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sql_expr_rb.html">sql_expr</a>
<span class="ul__span">Adds sql_expr method to all objects, allowing easy use of Sequel's DSL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/sqlite_json_ops_rb.html">sqlite_json_ops</a>
<span class="ul__span">Adds DSL support for calling SQLite json operators and functions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/string_date_time_rb.html">string_date_time</a>
<span class="ul__span">Adds instance methods to String for converting the string into a Date/Time/DateTime.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/symbol_aref_rb.html">symbol_aref</a>
<span class="ul__span">Extends Symbol#[] to create a qualified identifier if given a symbol, identifier, or qualified identifier.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/symbol_aref_refinement_rb.html">symbol_aref_refinement</a>
<span class="ul__span">Adds refinement version of symbol_aref extension.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/symbol_as_rb.html">symbol_as</a>
<span class="ul__span">Adds Symbol#as to create aliased expressions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/symbol_as_refinement_rb.html">symbol_as_refinement</a>
<span class="ul__span">Adds refinement version of symbol_as extension.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/thread_local_timezones_rb.html">thread_local_timezones</a>
<span class="ul__span">Allows for per-thread overrides of the global timezone settings.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/files/lib/sequel/extensions/virtual_row_method_block_rb.html">virtual_row_method_block</a>
<span class="ul__span">Supports passing blocks to virtual row method for terser SQL function creation.</span>
</li>
</ul>
<a name="extensions-external"></a>
<h3 class="h3">External Extensions</h3>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/kennym/annotate-sequel">annotate-sequel </a>
<span class="ul__span">Generates model annotations for Sequel models.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jeremyevans/fixture_dependencies">fixture_dependencies </a>
<span class="ul__span">YAML fixture loader that handles dependencies/associated objects, respecting foreign key constraints.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/i18n_backend_sequel">i18n_backend_sequel </a>
<span class="ul__span">Allows Sequel to be a backend for i18n translations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/raxoft/miguel">miguel </a>
<span class="ul__span">Allows management of database schemas, including auto generation/application of migrations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/pusewicz/rails_sequel/">rails_sequel </a>
<span class="ul__span">Rails 2 plugin that allows you to use Sequel instead of ActiveRecord.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/refile/refile-sequel">refile-sequel </a>
<span class="ul__span">Provides an extension for using Refile with Sequel.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/openhood/rspec_sequel_matchers">rspec_sequel_matchers </a>
<span class="ul__span">RSpec matchers for Sequel validations, associations, and columns.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/janko/sequel-activerecord_connection">sequel-activerecord_connection </a>
<span class="ul__span">Allows Sequel to use ActiveRecord's connection for database interaction.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/jeremyevans/sequel-annotate">sequel-annotate </a>
<span class="ul__span">Generates model annotations for Sequel models, including constraint and trigger information on PostgreSQL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gyordanov/sequel_extjs">sequel_extjs </a>
<span class="ul__span">Generates JSON from datasets that is consumable by the ExtJS JsonStore.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/nickgartmann/sequel-location">sequel-location </a>
<span class="ul__span">Easy setup and syntax for doing geolocation search on PostgreSQL.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jeremyevans/sequel_pg">sequel_pg </a>
<span class="ul__span">Faster SELECTs when using Sequel with pg.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/celsworth/sequel-pg_advisory_locking">sequel-pg_advisory_locking </a>
<span class="ul__span">Adds PostreSQL advisory locking support.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/mpalmer/sequel-pg-comment">sequel-pg-comment </a>
<span class="ul__span">Document your schema by setting comments on all your PgSQL objects.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/mwlang/sequel_plus">sequel_plus </a>
<span class="ul__span">Collection of sequel extensions.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jeremyevans/sequel_postgresql_triggers">sequel_postgresql_triggers </a>
<span class="ul__span">Database enforced timestamps, immutable columns, and counter/sum caches.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/brasten/sequel-rails">sequel-rails </a>
<span class="ul__span">Rails 3 plugin that allows you to use Sequel instead of ActiveRecord.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/gucki/sequel_rails3">sequel_rails3 </a>
<span class="ul__span">Another Rails 3 plugin that allows you to use Sequel instead of ActiveRecord.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/pabloh/sequel-force-hooks">sequel-force-hooks </a>
<span class="ul__span">Have after_commit/after_rollback hooks apply to current savepoint instead of transaction.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/earaujoassis/sequel-seed">sequel-seed </a>
<span class="ul__span">A Sequel extension to make seeds/fixtures manageable like migrations.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/rosenfeld/sequel_tools">sequel_tools </a>
<span class="ul__span">Tools to help with managing database operations with Sequel through Rake tasks.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="http://github.com/jsvd/sequel_vectorized">sequel_vectorized </a>
<span class="ul__span">Allows Sequel::Dataset to be exported as an Hash of Arrays and NArrays.</span>
</li>
</ul>
<a name="extensions-external-adapters"></a>
<h3 class="h3">External Adapters</h3>
<p class="p">Adapters allow Sequel to communicate with databases. Sequel ships with many adapters, but here are links to external adapters:</p>
<ul class="ul ul--grid">
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/djanowski/sequel-fusiontables">fusiontables </a>
<span class="ul__span">Fusion Tables adapter using <a class="a" href="https://github.com/djanowski/ft">ft</a> driver</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/hrp/sequel-hive-adapter">hive </a>
<span class="ul__span">Hadoop Hive adapter using <a class="a" href="https://github.com/forward3d/rbhive">rbhive</a> driver</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/outcomesinsights/sequel-impala">impala </a>
<span class="ul__span">Impala adapter, including jdbc/hive2 adapter</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/ahto/sequel-jdbc-crate">jdbc-crate </a>
<span class="ul__span">JDBC subadapter for Crate database</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/colincasey/sequel-jdbc-hxtt-adapter">jdbc-hxtt </a>
<span class="ul__span">JDBC subadapter for MS Access databases</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/gimoh/sequel-openedge-adapter">openedge </a>
<span class="ul__span">ODBC and JDBC subadapters for OpenEdge database</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/Yesware/sequel-snowflake">snowflake </a>
<span class="ul__span">ODBC subadapter for <a class="a" href="https://www.snowflake.com">Snowflake</a> databases</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/camilo/sequel-vertica">vertica </a>
<span class="ul__span">Vertica adapter using <a class="a" href="https://github.com/wvanbergen/vertica">vertica</a> driver</span>
</li>
</ul>
</div>
</div>
<hr class="hr" />
<div class="row">
<div class="row__item">
<a name="submit"></a>
<h3 class="h3">Submitting Your Plugin/Extension/Adapter</h3>
<p class="p">If you have created a Sequel plugin/extension/adapter and would like to list it here, please submit a request to code AT jeremyevans DOT net, or send a pull request via <a class="a" href="https://github.com/jeremyevans/sequel/pulls">GitHub</a>.</p>
</div>
</div>
</div>
</div>
</section>
|