Enhanced PHP File Manager

⬆️ Go Up (..)

📊 Server Information

Server:

LiteSpeed

System:

Linux 5.14.0-611.55.1.el9_7.x86_64

PHP Version:

8.2.30

User:

u891914234

Directory:

/home/u891914234/domains/blsmspl.com/public_html/user_guide/database

Free Space:

8.88 TB

🔧 Quick Actions

✏️ Editing: query_builder.html

<!DOCTYPE html>

 <html class="no-js" lang="en" > 
<head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <title>Query Builder Class &mdash; CodeIgniter 3.1.6 documentation</title>

</head>

<div id="nav">
 <div id="nav_inner">
 
 
 
 <div id="pulldown-menu" class="ciNav">
 <ul>
<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Database Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="examples.html">Quick Start: Usage Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Database Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="connecting.html">Connecting to a Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="queries.html">Running Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html">Generating Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="helpers.html">Query Helper Functions</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Query Builder Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html">Getting MetaData</a></li>
<li class="toctree-l2"><a class="reference internal" href="call_function.html">Custom Function Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching.html">Query Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="forge.html">Database Manipulation with Database Forge</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Database Utilities Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="db_driver_reference.html">Database Driver Reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
</ul>
</li>
</ul>

</div>
 
 
 </div>
</div>
<div id="nav2">
 <a href="#" id="openToc">
 <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
 </a>
</div>

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
 <div class="wy-side-nav-search">
 
 <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
 
 
<div role="search">
 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
 <input type="text" name="q" placeholder="Search docs" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
</div>
 </div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
 
 
 <ul>
<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Database Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="examples.html">Quick Start: Usage Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Database Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="connecting.html">Connecting to a Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="queries.html">Running Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html">Generating Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="helpers.html">Query Helper Functions</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Query Builder Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html">Getting MetaData</a></li>
<li class="toctree-l2"><a class="reference internal" href="call_function.html">Custom Function Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching.html">Query Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="forge.html">Database Manipulation with Database Forge</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Database Utilities Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="db_driver_reference.html">Database Driver Reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
</ul>
</li>
</ul>

</div>
 &nbsp;
 </nav>

<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
 <a href="../index.html">CodeIgniter</a>
 </nav>

<div class="wy-nav-content">
 <div class="rst-content">
 <div role="navigation" aria-label="breadcrumbs navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="../index.html">Docs</a> &raquo;</li>
 
 <li><a href="index.html">Database Reference</a> &raquo;</li>
 
 <li>Query Builder Class</li>
 <li class="wy-breadcrumbs-aside">
 
 </li>
 <div style="float:right;margin-left:5px;" id="closeMe">
 <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
 </div>
 </ul>
 <hr/>
</div>
 <div role="main" class="document">
 
 <div class="section" id="query-builder-class">
<h1>Query Builder Class<a class="headerlink" href="#query-builder-class" title="Permalink to this headline">¶</a></h1>
CodeIgniter gives you access to a Query Builder class. This pattern
allows information to be retrieved, inserted, and updated in your
database with minimal scripting. In some cases only one or two lines
of code are necessary to perform a database action.
CodeIgniter does not require that each database table be its own class
file. It instead provides a more simplified interface.
Beyond simplicity, a major benefit to using the Query Builder features
is that it allows you to create database independent applications, since
the query syntax is generated by each database adapter. It also allows
for safer queries, since the values are escaped automatically by the
system.
<div class="admonition note">
Note
If you intend to write your own queries you can disable this
class in your database config file, allowing the core database library
and adapter to utilize fewer resources.
</div>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#selecting-data" id="id1">Selecting Data</a></li>
<li><a class="reference internal" href="#looking-for-specific-data" id="id2">Looking for Specific Data</a></li>
<li><a class="reference internal" href="#looking-for-similar-data" id="id3">Looking for Similar Data</a></li>
<li><a class="reference internal" href="#ordering-results" id="id4">Ordering results</a></li>
<li><a class="reference internal" href="#limiting-or-counting-results" id="id5">Limiting or Counting Results</a></li>
<li><a class="reference internal" href="#query-grouping" id="id6">Query grouping</a></li>
<li><a class="reference internal" href="#inserting-data" id="id7">Inserting Data</a></li>
<li><a class="reference internal" href="#updating-data" id="id8">Updating Data</a></li>
<li><a class="reference internal" href="#deleting-data" id="id9">Deleting Data</a></li>
<li><a class="reference internal" href="#method-chaining" id="id10">Method Chaining</a></li>
<li><a class="reference internal" href="#query-builder-caching" id="id11">Query Builder Caching</a></li>
<li><a class="reference internal" href="#resetting-query-builder" id="id12">Resetting Query Builder</a></li>
<li><a class="reference internal" href="#class-reference" id="id13">Class Reference</a></li>
</ul>
</div>
<div class="section" id="selecting-data">
<h2><a class="toc-backref" href="#id1">Selecting Data</a><a class="headerlink" href="#selecting-data" title="Permalink to this headline">¶</a></h2>
The following functions allow you to build SQL SELECT statements.
$this-&gt;db-&gt;get()
Runs the selection query and returns the result. Can be used by itself
to retrieve all records from a table:
<div class="highlight-ci"><div class="highlight"><pre>$query = $this-&gt;db-&gt;get(&#39;mytable&#39;); // Produces: SELECT * FROM mytable
</pre></div>
</div>
The second and third parameters enable you to set a limit and offset
clause:
<div class="highlight-ci"><div class="highlight"><pre>$query = $this-&gt;db-&gt;get(&#39;mytable&#39;, 10, 20);

// Executes: SELECT * FROM mytable LIMIT 20, 10
// (in MySQL. Other databases have slightly different syntax)
</pre></div>
</div>
You’ll notice that the above function is assigned to a variable named
$query, which can be used to show the results:
<div class="highlight-ci"><div class="highlight"><pre>$query = $this-&gt;db-&gt;get(&#39;mytable&#39;);

foreach ($query-&gt;result() as $row)
{
 echo $row-&gt;title;
}
</pre></div>
</div>
Please visit the <a class="reference internal" href="results.html">result functions</a> page for a full
discussion regarding result generation.
$this-&gt;db-&gt;get_compiled_select()
Compiles the selection query just like $this-&gt;db-&gt;get() but does not run
the query. This method simply returns the SQL query as a string.
Example:
<div class="highlight-ci"><div class="highlight"><pre>$sql = $this-&gt;db-&gt;get_compiled_select(&#39;mytable&#39;);
echo $sql;

// Prints string: SELECT * FROM mytable
</pre></div>
</div>
The second parameter enables you to set whether or not the query builder query
will be reset (by default it will be reset, just like when using <cite>$this-&gt;db-&gt;get()</cite>):
<div class="highlight-ci"><div class="highlight"><pre>echo $this-&gt;db-&gt;limit(10,20)-&gt;get_compiled_select(&#39;mytable&#39;, FALSE);

// Prints string: SELECT * FROM mytable LIMIT 20, 10
// (in MySQL. Other databases have slightly different syntax)

echo $this-&gt;db-&gt;select(&#39;title, content, date&#39;)-&gt;get_compiled_select();

// Prints string: SELECT title, content, date FROM mytable LIMIT 20, 10
</pre></div>
</div>
The key thing to notice in the above example is that the second query did not
utilize $this-&gt;db-&gt;from() and did not pass a table name into the first
parameter. The reason for this outcome is because the query has not been
executed using $this-&gt;db-&gt;get() which resets values or reset directly
using $this-&gt;db-&gt;reset_query().
$this-&gt;db-&gt;get_where()
Identical to the above function except that it permits you to add a
“where” clause in the second parameter, instead of using the db-&gt;where()
function:
<div class="highlight-ci"><div class="highlight"><pre>$query = $this-&gt;db-&gt;get_where(&#39;mytable&#39;, array(&#39;id&#39; =&gt; $id), $limit, $offset);
</pre></div>
</div>
Please read the about the where function below for more information.
<div class="admonition note">
Note
get_where() was formerly known as getwhere(), which has been removed
</div>
$this-&gt;db-&gt;select()
Permits you to write the SELECT portion of your query:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select(&#39;title, content, date&#39;);
$query = $this-&gt;db-&gt;get(&#39;mytable&#39;);

// Executes: SELECT title, content, date FROM mytable
</pre></div>
</div>
<div class="admonition note">
Note
If you are selecting all (*) from a table you do not need to
use this function. When omitted, CodeIgniter assumes that you wish
to select all fields and automatically adds ‘SELECT *’.
</div>
<code class="docutils literal">$this-&gt;db-&gt;select()</code> accepts an optional second parameter. If you set it
to FALSE, CodeIgniter will not try to protect your field or table names.
This is useful if you need a compound select statement where automatic
escaping of fields may break them.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select(&#39;(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4) AS amount_paid&#39;, FALSE);
$query = $this-&gt;db-&gt;get(&#39;mytable&#39;);
</pre></div>
</div>
$this-&gt;db-&gt;select_max()
Writes a <code class="docutils literal">SELECT MAX(field)</code> portion for your query. You can optionally
include a second parameter to rename the resulting field.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select_max(&#39;age&#39;);
$query = $this-&gt;db-&gt;get(&#39;members&#39;); // Produces: SELECT MAX(age) as age FROM members

$this-&gt;db-&gt;select_max(&#39;age&#39;, &#39;member_age&#39;);
$query = $this-&gt;db-&gt;get(&#39;members&#39;); // Produces: SELECT MAX(age) as member_age FROM members
</pre></div>
</div>
$this-&gt;db-&gt;select_min()
Writes a “SELECT MIN(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select_min(&#39;age&#39;);
$query = $this-&gt;db-&gt;get(&#39;members&#39;); // Produces: SELECT MIN(age) as age FROM members
</pre></div>
</div>
$this-&gt;db-&gt;select_avg()
Writes a “SELECT AVG(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select_avg(&#39;age&#39;);
$query = $this-&gt;db-&gt;get(&#39;members&#39;); // Produces: SELECT AVG(age) as age FROM members
</pre></div>
</div>
$this-&gt;db-&gt;select_sum()
Writes a “SELECT SUM(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select_sum(&#39;age&#39;);
$query = $this-&gt;db-&gt;get(&#39;members&#39;); // Produces: SELECT SUM(age) as age FROM members
</pre></div>
</div>
$this-&gt;db-&gt;from()
Permits you to write the FROM portion of your query:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select(&#39;title, content, date&#39;);
$this-&gt;db-&gt;from(&#39;mytable&#39;);
$query = $this-&gt;db-&gt;get(); // Produces: SELECT title, content, date FROM mytable
</pre></div>
</div>
<div class="admonition note">
Note
As shown earlier, the FROM portion of your query can be specified
in the $this-&gt;db-&gt;get() function, so use whichever method you prefer.
</div>
$this-&gt;db-&gt;join()
Permits you to write the JOIN portion of your query:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select(&#39;*&#39;);
$this-&gt;db-&gt;from(&#39;blogs&#39;);
$this-&gt;db-&gt;join(&#39;comments&#39;, &#39;comments.id = blogs.id&#39;);
$query = $this-&gt;db-&gt;get();

// Produces:
// SELECT * FROM blogs JOIN comments ON comments.id = blogs.id
</pre></div>
</div>
Multiple function calls can be made if you need several joins in one
query.
If you need a specific type of JOIN you can specify it via the third
parameter of the function. Options are: left, right, outer, inner, left
outer, and right outer.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;join(&#39;comments&#39;, &#39;comments.id = blogs.id&#39;, &#39;left&#39;);
// Produces: LEFT JOIN comments ON comments.id = blogs.id
</pre></div>
</div>
</div>
<div class="section" id="looking-for-specific-data">
<h2><a class="toc-backref" href="#id2">Looking for Specific Data</a><a class="headerlink" href="#looking-for-specific-data" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;where()
This function enables you to set WHERE clauses using one of four
methods:
<div class="admonition note">
Note
All values passed to this function are escaped automatically,
producing safer queries.
</div>
<ol class="arabic">
<li>Simple key/value method:
<blockquote>
<div><div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;name&#39;, $name); // Produces: WHERE name = &#39;Joe&#39;
</pre></div>
</div>
Notice that the equal sign is added for you.
If you use multiple function calls they will be chained together with
AND between them:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;name&#39;, $name);
$this-&gt;db-&gt;where(&#39;title&#39;, $title);
$this-&gt;db-&gt;where(&#39;status&#39;, $status);
// WHERE name = &#39;Joe&#39; AND title = &#39;boss&#39; AND status = &#39;active&#39;
</pre></div>
</div>
</div></blockquote>
</li>
<li>Custom key/value method:
<blockquote>
<div>You can include an operator in the first parameter in order to
control the comparison:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;name !=&#39;, $name);
$this-&gt;db-&gt;where(&#39;id &lt;&#39;, $id); // Produces: WHERE name != &#39;Joe&#39; AND id &lt; 45
</pre></div>
</div>
</div></blockquote>
</li>
<li>Associative array method:
<blockquote>
<div><div class="highlight-ci"><div class="highlight"><pre>$array = array(&#39;name&#39; =&gt; $name, &#39;title&#39; =&gt; $title, &#39;status&#39; =&gt; $status);
$this-&gt;db-&gt;where($array);
// Produces: WHERE name = &#39;Joe&#39; AND title = &#39;boss&#39; AND status = &#39;active&#39;
</pre></div>
</div>
You can include your own operators using this method as well:
<div class="highlight-ci"><div class="highlight"><pre>$array = array(&#39;name !=&#39; =&gt; $name, &#39;id &lt;&#39; =&gt; $id, &#39;date &gt;&#39; =&gt; $date);
$this-&gt;db-&gt;where($array);
</pre></div>
</div>
</div></blockquote>
</li>
<li><dl class="first docutils">
<dt>Custom string:</dt>
<dd>You can write your own clauses manually:
<div class="last highlight-ci"><div class="highlight"><pre>$where = &quot;name=&#39;Joe&#39; AND status=&#39;boss&#39; OR status=&#39;active&#39;&quot;;
$this-&gt;db-&gt;where($where);
</pre></div>
</div>
</dd>
</dl>
</li>
</ol>
<code class="docutils literal">$this-&gt;db-&gt;where()</code> accepts an optional third parameter. If you set it to
FALSE, CodeIgniter will not try to protect your field or table names.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;MATCH (field) AGAINST (&quot;value&quot;)&#39;, NULL, FALSE);
</pre></div>
</div>
$this-&gt;db-&gt;or_where()
This function is identical to the one above, except that multiple
instances are joined by OR:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;name !=&#39;, $name);
$this-&gt;db-&gt;or_where(&#39;id &gt;&#39;, $id); // Produces: WHERE name != &#39;Joe&#39; OR id &gt; 50
</pre></div>
</div>
<div class="admonition note">
Note
or_where() was formerly known as orwhere(), which has been
removed.
</div>
$this-&gt;db-&gt;where_in()
Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with AND if
appropriate
<div class="highlight-ci"><div class="highlight"><pre>$names = array(&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;);
$this-&gt;db-&gt;where_in(&#39;username&#39;, $names);
// Produces: WHERE username IN (&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;)
</pre></div>
</div>
$this-&gt;db-&gt;or_where_in()
Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with OR if
appropriate
<div class="highlight-ci"><div class="highlight"><pre>$names = array(&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;);
$this-&gt;db-&gt;or_where_in(&#39;username&#39;, $names);
// Produces: OR username IN (&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;)
</pre></div>
</div>
$this-&gt;db-&gt;where_not_in()
Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with
AND if appropriate
<div class="highlight-ci"><div class="highlight"><pre>$names = array(&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;);
$this-&gt;db-&gt;where_not_in(&#39;username&#39;, $names);
// Produces: WHERE username NOT IN (&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;)
</pre></div>
</div>
$this-&gt;db-&gt;or_where_not_in()
Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with OR
if appropriate
<div class="highlight-ci"><div class="highlight"><pre>$names = array(&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;);
$this-&gt;db-&gt;or_where_not_in(&#39;username&#39;, $names);
// Produces: OR username NOT IN (&#39;Frank&#39;, &#39;Todd&#39;, &#39;James&#39;)
</pre></div>
</div>
</div>
<div class="section" id="looking-for-similar-data">
<h2><a class="toc-backref" href="#id3">Looking for Similar Data</a><a class="headerlink" href="#looking-for-similar-data" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;like()
This method enables you to generate LIKE clauses, useful for doing
searches.
<div class="admonition note">
Note
All values passed to this method are escaped automatically.
</div>
<ol class="arabic">
<li>Simple key/value method:
<blockquote>
<div><div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;);
// Produces: WHERE `title` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39;
</pre></div>
</div>
If you use multiple method calls they will be chained together with
AND between them:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;);
$this-&gt;db-&gt;like(&#39;body&#39;, &#39;match&#39;);
// WHERE `title` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39; AND `body` LIKE &#39;%match% ESCAPE &#39;!&#39;
</pre></div>
</div>
If you want to control where the wildcard (%) is placed, you can use
an optional third argument. Your options are ‘before’, ‘after’ and
‘both’ (which is the default).
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;, &#39;before&#39;); // Produces: WHERE `title` LIKE &#39;%match&#39; ESCAPE &#39;!&#39;
$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;, &#39;after&#39;); // Produces: WHERE `title` LIKE &#39;match%&#39; ESCAPE &#39;!&#39;
$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;, &#39;both&#39;); // Produces: WHERE `title` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39;
</pre></div>
</div>
</div></blockquote>
</li>
<li>Associative array method:
<blockquote>
<div><div class="highlight-ci"><div class="highlight"><pre>$array = array(&#39;title&#39; =&gt; $match, &#39;page1&#39; =&gt; $match, &#39;page2&#39; =&gt; $match);
$this-&gt;db-&gt;like($array);
// WHERE `title` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39; AND `page1` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39; AND `page2` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39;
</pre></div>
</div>
</div></blockquote>
</li>
</ol>
$this-&gt;db-&gt;or_like()
This method is identical to the one above, except that multiple
instances are joined by OR:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;); $this-&gt;db-&gt;or_like(&#39;body&#39;, $match);
// WHERE `title` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39; OR `body` LIKE &#39;%match%&#39; ESCAPE &#39;!&#39;
</pre></div>
</div>
<div class="admonition note">
Note
<code class="docutils literal">or_like()</code> was formerly known as <code class="docutils literal">orlike()</code>, which has been removed.
</div>
$this-&gt;db-&gt;not_like()
This method is identical to <code class="docutils literal">like()</code>, except that it generates
NOT LIKE statements:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;not_like(&#39;title&#39;, &#39;match&#39;); // WHERE `title` NOT LIKE &#39;%match% ESCAPE &#39;!&#39;
</pre></div>
</div>
$this-&gt;db-&gt;or_not_like()
This method is identical to <code class="docutils literal">not_like()</code>, except that multiple
instances are joined by OR:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;);
$this-&gt;db-&gt;or_not_like(&#39;body&#39;, &#39;match&#39;);
// WHERE `title` LIKE &#39;%match% OR `body` NOT LIKE &#39;%match%&#39; ESCAPE &#39;!&#39;
</pre></div>
</div>
$this-&gt;db-&gt;group_by()
Permits you to write the GROUP BY portion of your query:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;group_by(&quot;title&quot;); // Produces: GROUP BY title
</pre></div>
</div>
You can also pass an array of multiple values as well:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;group_by(array(&quot;title&quot;, &quot;date&quot;)); // Produces: GROUP BY title, date
</pre></div>
</div>
<div class="admonition note">
Note
group_by() was formerly known as groupby(), which has been
removed.
</div>
$this-&gt;db-&gt;distinct()
Adds the “DISTINCT” keyword to a query
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;distinct();
$this-&gt;db-&gt;get(&#39;table&#39;); // Produces: SELECT DISTINCT * FROM table
</pre></div>
</div>
$this-&gt;db-&gt;having()
Permits you to write the HAVING portion of your query. There are 2
possible syntaxes, 1 argument or 2:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;having(&#39;user_id = 45&#39;); // Produces: HAVING user_id = 45
$this-&gt;db-&gt;having(&#39;user_id&#39;, 45); // Produces: HAVING user_id = 45
</pre></div>
</div>
You can also pass an array of multiple values as well:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;having(array(&#39;title =&#39; =&gt; &#39;My Title&#39;, &#39;id &lt;&#39; =&gt; $id));
// Produces: HAVING title = &#39;My Title&#39;, id &lt; 45
</pre></div>
</div>
If you are using a database that CodeIgniter escapes queries for, you
can prevent escaping content by passing an optional third argument, and
setting it to FALSE.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;having(&#39;user_id&#39;, 45); // Produces: HAVING `user_id` = 45 in some databases such as MySQL
$this-&gt;db-&gt;having(&#39;user_id&#39;, 45, FALSE); // Produces: HAVING user_id = 45
</pre></div>
</div>
$this-&gt;db-&gt;or_having()
Identical to having(), only separates multiple clauses with “OR”.
</div>
<div class="section" id="ordering-results">
<h2><a class="toc-backref" href="#id4">Ordering results</a><a class="headerlink" href="#ordering-results" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;order_by()
Lets you set an ORDER BY clause.
The first parameter contains the name of the column you would like to order by.
The second parameter lets you set the direction of the result.
Options are ASC, DESC AND RANDOM.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;order_by(&#39;title&#39;, &#39;DESC&#39;);
// Produces: ORDER BY `title` DESC
</pre></div>
</div>
You can also pass your own string in the first parameter:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;order_by(&#39;title DESC, name ASC&#39;);
// Produces: ORDER BY `title` DESC, `name` ASC
</pre></div>
</div>
Or multiple function calls can be made if you need multiple fields.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;order_by(&#39;title&#39;, &#39;DESC&#39;);
$this-&gt;db-&gt;order_by(&#39;name&#39;, &#39;ASC&#39;);
// Produces: ORDER BY `title` DESC, `name` ASC
</pre></div>
</div>
If you choose the RANDOM direction option, then the first parameters will
be ignored, unless you specify a numeric seed value.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;order_by(&#39;title&#39;, &#39;RANDOM&#39;);
// Produces: ORDER BY RAND()

$this-&gt;db-&gt;order_by(42, &#39;RANDOM&#39;);
// Produces: ORDER BY RAND(42)
</pre></div>
</div>
<div class="admonition note">
Note
order_by() was formerly known as orderby(), which has been
removed.
</div>
<div class="admonition note">
Note
Random ordering is not currently supported in Oracle and
will default to ASC instead.
</div>
</div>
<div class="section" id="limiting-or-counting-results">
<h2><a class="toc-backref" href="#id5">Limiting or Counting Results</a><a class="headerlink" href="#limiting-or-counting-results" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;limit()
Lets you limit the number of rows you would like returned by the query:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;limit(10); // Produces: LIMIT 10
</pre></div>
</div>
The second parameter lets you set a result offset.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;limit(10, 20); // Produces: LIMIT 20, 10 (in MySQL. Other databases have slightly different syntax)
</pre></div>
</div>
$this-&gt;db-&gt;count_all_results()
Permits you to determine the number of rows in a particular Active
Record query. Queries will accept Query Builder restrictors such as
<code class="docutils literal">where()</code>, <code class="docutils literal">or_where()</code>, <code class="docutils literal">like()</code>, <code class="docutils literal">or_like()</code>, etc. Example:
<div class="highlight-ci"><div class="highlight"><pre>echo $this-&gt;db-&gt;count_all_results(&#39;my_table&#39;); // Produces an integer, like 25
$this-&gt;db-&gt;like(&#39;title&#39;, &#39;match&#39;);
$this-&gt;db-&gt;from(&#39;my_table&#39;);
echo $this-&gt;db-&gt;count_all_results(); // Produces an integer, like 17
</pre></div>
</div>
However, this method also resets any field values that you may have passed
to <code class="docutils literal">select()</code>. If you need to keep them, you can pass <code class="docutils literal">FALSE</code> as the
second parameter:
<div class="highlight-ci"><div class="highlight"><pre>echo $this-&gt;db-&gt;count_all_results(&#39;my_table&#39;, FALSE);
</pre></div>
</div>
$this-&gt;db-&gt;count_all()
Permits you to determine the number of rows in a particular table.
Submit the table name in the first parameter. Example:
<div class="highlight-ci"><div class="highlight"><pre>echo $this-&gt;db-&gt;count_all(&#39;my_table&#39;); // Produces an integer, like 25
</pre></div>
</div>
</div>
<div class="section" id="query-grouping">
<h2><a class="toc-backref" href="#id6">Query grouping</a><a class="headerlink" href="#query-grouping" title="Permalink to this headline">¶</a></h2>
Query grouping allows you to create groups of WHERE clauses by enclosing them in parentheses. This will allow
you to create queries with complex WHERE clauses. Nested groups are supported. Example:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;select(&#39;*&#39;)-&gt;from(&#39;my_table&#39;)
 -&gt;group_start()
 -&gt;where(&#39;a&#39;, &#39;a&#39;)
 -&gt;or_group_start()
 -&gt;where(&#39;b&#39;, &#39;b&#39;)
 -&gt;where(&#39;c&#39;, &#39;c&#39;)
 -&gt;group_end()
 -&gt;group_end()
 -&gt;where(&#39;d&#39;, &#39;d&#39;)
-&gt;get();

// Generates:
// SELECT * FROM (`my_table`) WHERE ( `a` = &#39;a&#39; OR ( `b` = &#39;b&#39; AND `c` = &#39;c&#39; ) ) AND `d` = &#39;d&#39;
</pre></div>
</div>
<div class="admonition note">
Note
groups need to be balanced, make sure every group_start() is matched by a group_end().
</div>
$this-&gt;db-&gt;group_start()
Starts a new group by adding an opening parenthesis to the WHERE clause of the query.
$this-&gt;db-&gt;or_group_start()
Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR’.
$this-&gt;db-&gt;not_group_start()
Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘NOT’.
$this-&gt;db-&gt;or_not_group_start()
Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR NOT’.
$this-&gt;db-&gt;group_end()
Ends the current group by adding an closing parenthesis to the WHERE clause of the query.
</div>
<div class="section" id="inserting-data">
<h2><a class="toc-backref" href="#id7">Inserting Data</a><a class="headerlink" href="#inserting-data" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;insert()
Generates an insert string based on the data you supply, and runs the
query. You can either pass an array or an object to the
function. Here is an example using an array:
<div class="highlight-ci"><div class="highlight"><pre>$data = array(
 &#39;title&#39; =&gt; &#39;My title&#39;,
 &#39;name&#39; =&gt; &#39;My Name&#39;,
 &#39;date&#39; =&gt; &#39;My date&#39;
);

$this-&gt;db-&gt;insert(&#39;mytable&#39;, $data);
// Produces: INSERT INTO mytable (title, name, date) VALUES (&#39;My title&#39;, &#39;My name&#39;, &#39;My date&#39;)
</pre></div>
</div>
The first parameter will contain the table name, the second is an
associative array of values.
Here is an example using an object:
<div class="highlight-ci"><div class="highlight"><pre>/*
class Myclass {
 public $title = &#39;My Title&#39;;
 public $content = &#39;My Content&#39;;
 public $date = &#39;My Date&#39;;
}
*/

$sql = $this-&gt;db-&gt;set($data)-&gt;get_compiled_insert(&#39;mytable&#39;);
echo $sql;

// Produces string: INSERT INTO mytable (`title`, `name`, `date`) VALUES (&#39;My title&#39;, &#39;My name&#39;, &#39;My date&#39;)
</pre></div>
</div>
The second parameter enables you to set whether or not the query builder query
will be reset (by default it will be–just like $this-&gt;db-&gt;insert()):
<div class="highlight-ci"><div class="highlight"><pre>echo $this-&gt;db-&gt;set(&#39;title&#39;, &#39;My Title&#39;)-&gt;get_compiled_insert(&#39;mytable&#39;, FALSE);

// Produces string: INSERT INTO mytable (`title`) VALUES (&#39;My Title&#39;)

echo $this-&gt;db-&gt;set(&#39;content&#39;, &#39;My Content&#39;)-&gt;get_compiled_insert();

// Produces string: INSERT INTO mytable (`title`, `content`) VALUES (&#39;My Title&#39;, &#39;My Content&#39;)
</pre></div>
</div>
The key thing to notice in the above example is that the second query did not
utlize <cite>$this-&gt;db-&gt;from()</cite> nor did it pass a table name into the first
parameter. The reason this worked is because the query has not been executed
using <cite>$this-&gt;db-&gt;insert()</cite> which resets values or reset directly using
<cite>$this-&gt;db-&gt;reset_query()</cite>.
<div class="admonition note">
Note
This method doesn’t work for batched inserts.
</div>
$this-&gt;db-&gt;insert_batch()
Generates an insert string based on the data you supply, and runs the
query. You can either pass an array or an object to the
function. Here is an example using an array:
<div class="highlight-ci"><div class="highlight"><pre>$data = array(
 array(
 &#39;title&#39; =&gt; &#39;My title&#39;,
 &#39;name&#39; =&gt; &#39;My Name&#39;,
 &#39;date&#39; =&gt; &#39;My date&#39;
 ),
 array(
 &#39;title&#39; =&gt; &#39;Another title&#39;,
 &#39;name&#39; =&gt; &#39;Another Name&#39;,
 &#39;date&#39; =&gt; &#39;Another date&#39;
 )
);

$this-&gt;db-&gt;insert_batch(&#39;mytable&#39;, $data);
// Produces: INSERT INTO mytable (title, name, date) VALUES (&#39;My title&#39;, &#39;My name&#39;, &#39;My date&#39;), (&#39;Another title&#39;, &#39;Another name&#39;, &#39;Another date&#39;)
</pre></div>
</div>
The first parameter will contain the table name, the second is an
associative array of values.
<div class="admonition note">
Note
All values are escaped automatically producing safer queries.
</div>
</div>
<div class="section" id="updating-data">
<h2><a class="toc-backref" href="#id8">Updating Data</a><a class="headerlink" href="#updating-data" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;replace()
This method executes a REPLACE statement, which is basically the SQL
standard for (optional) DELETE + INSERT, using PRIMARY and UNIQUE
keys as the determining factor.
In our case, it will save you from the need to implement complex
logics with different combinations of <code class="docutils literal">select()</code>, <code class="docutils literal">update()</code>,
<code class="docutils literal">delete()</code> and <code class="docutils literal">insert()</code> calls.
Example:
<div class="highlight-ci"><div class="highlight"><pre>$data = array(
 &#39;title&#39; =&gt; &#39;My title&#39;,
 &#39;name&#39; =&gt; &#39;My Name&#39;,
 &#39;date&#39; =&gt; &#39;My date&#39;
);

$this-&gt;db-&gt;replace(&#39;table&#39;, $data);

// Executes: REPLACE INTO mytable (title, name, date) VALUES (&#39;My title&#39;, &#39;My name&#39;, &#39;My date&#39;)
</pre></div>
</div>
In the above example, if we assume that the title field is our primary
key, then if a row containing ‘My title’ as the title value, that row
will be deleted with our new row data replacing it.
Usage of the <code class="docutils literal">set()</code> method is also allowed and all fields are
automatically escaped, just like with <code class="docutils literal">insert()</code>.
$this-&gt;db-&gt;set()
This function enables you to set values for inserts or updates.
It can be used instead of passing a data array directly to the insert
or update functions:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;set(&#39;name&#39;, $name);
$this-&gt;db-&gt;insert(&#39;mytable&#39;); // Produces: INSERT INTO mytable (`name`) VALUES (&#39;{$name}&#39;)
</pre></div>
</div>
If you use multiple function called they will be assembled properly
based on whether you are doing an insert or an update:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;set(&#39;name&#39;, $name);
$this-&gt;db-&gt;set(&#39;title&#39;, $title);
$this-&gt;db-&gt;set(&#39;status&#39;, $status);
$this-&gt;db-&gt;insert(&#39;mytable&#39;);
</pre></div>
</div>
set() will also accept an optional third parameter (<code class="docutils literal">$escape</code>), that
will prevent data from being escaped if set to FALSE. To illustrate the
difference, here is <code class="docutils literal">set()</code> used both with and without the escape
parameter.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;set(&#39;field&#39;, &#39;field+1&#39;, FALSE);
$this-&gt;db-&gt;where(&#39;id&#39;, 2);
$this-&gt;db-&gt;update(&#39;mytable&#39;); // gives UPDATE mytable SET field = field+1 WHERE id = 2

$this-&gt;db-&gt;set(&#39;field&#39;, &#39;field+1&#39;);
$this-&gt;db-&gt;where(&#39;id&#39;, 2);
$this-&gt;db-&gt;update(&#39;mytable&#39;); // gives UPDATE `mytable` SET `field` = &#39;field+1&#39; WHERE `id` = 2
</pre></div>
</div>
You can also pass an associative array to this function:
<div class="highlight-ci"><div class="highlight"><pre>$array = array(
 &#39;name&#39; =&gt; $name,
 &#39;title&#39; =&gt; $title,
 &#39;status&#39; =&gt; $status
);

$this-&gt;db-&gt;where(&#39;id&#39;, $id);
$this-&gt;db-&gt;update(&#39;mytable&#39;, $data);
// Produces:
//
// UPDATE mytable
// SET title = &#39;{$title}&#39;, name = &#39;{$name}&#39;, date = &#39;{$date}&#39;
// WHERE id = $id
</pre></div>
</div>
Or you can supply an object:
<div class="highlight-ci"><div class="highlight"><pre>/*
class Myclass {
 public $title = &#39;My Title&#39;;
 public $content = &#39;My Content&#39;;
 public $date = &#39;My Date&#39;;
}
*/

$object = new Myclass;
$this-&gt;db-&gt;where(&#39;id&#39;, $id);
$this-&gt;db-&gt;update(&#39;mytable&#39;, $object);
// Produces:
//
// UPDATE `mytable`
// SET `title` = &#39;{$title}&#39;, `name` = &#39;{$name}&#39;, `date` = &#39;{$date}&#39;
// WHERE id = `$id`
</pre></div>
</div>
<div class="admonition note">
Note
All values are escaped automatically producing safer queries.
</div>
You’ll notice the use of the $this-&gt;db-&gt;where() function, enabling you
to set the WHERE clause. You can optionally pass this information
directly into the update function as a string:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;update(&#39;mytable&#39;, $data, &quot;id = 4&quot;);
</pre></div>
</div>
Or as an array:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;update(&#39;mytable&#39;, $data, array(&#39;id&#39; =&gt; $id));
</pre></div>
</div>
You may also use the $this-&gt;db-&gt;set() function described above when
performing updates.
$this-&gt;db-&gt;update_batch()
Generates an update string based on the data you supply, and runs the query.
You can either pass an array or an object to the function.
Here is an example using an array:
<div class="highlight-ci"><div class="highlight"><pre>$data = array(
 array(
 &#39;title&#39; =&gt; &#39;My title&#39; ,
 &#39;name&#39; =&gt; &#39;My Name 2&#39; ,
 &#39;date&#39; =&gt; &#39;My date 2&#39;
 ),
 array(
 &#39;title&#39; =&gt; &#39;Another title&#39; ,
 &#39;name&#39; =&gt; &#39;Another Name 2&#39; ,
 &#39;date&#39; =&gt; &#39;Another date 2&#39;
 )
);

$this-&gt;db-&gt;update_batch(&#39;mytable&#39;, $data, &#39;title&#39;);

// Produces:
// UPDATE `mytable` SET `name` = CASE
// WHEN `title` = &#39;My title&#39; THEN &#39;My Name 2&#39;
// WHEN `title` = &#39;Another title&#39; THEN &#39;Another Name 2&#39;
// ELSE `name` END,
// `date` = CASE
// WHEN `title` = &#39;My title&#39; THEN &#39;My date 2&#39;
// WHEN `title` = &#39;Another title&#39; THEN &#39;Another date 2&#39;
// ELSE `date` END
// WHERE `title` IN (&#39;My title&#39;,&#39;Another title&#39;)
</pre></div>
</div>
The first parameter will contain the table name, the second is an associative
array of values, the third parameter is the where key.
<div class="admonition note">
Note
All values are escaped automatically producing safer queries.
</div>
<div class="admonition note">
Note
<code class="docutils literal">affected_rows()</code> won’t give you proper results with this method,
due to the very nature of how it works. Instead, <code class="docutils literal">update_batch()</code>
returns the number of rows affected.
</div>
$this-&gt;db-&gt;get_compiled_update()
This works exactly the same way as <code class="docutils literal">$this-&gt;db-&gt;get_compiled_insert()</code> except
that it produces an UPDATE SQL string instead of an INSERT SQL string.
For more information view documentation for <cite>$this-&gt;db-&gt;get_compiled_insert()</cite>.
<div class="admonition note">
Note
This method doesn’t work for batched updates.
</div>
</div>
<div class="section" id="deleting-data">
<h2><a class="toc-backref" href="#id9">Deleting Data</a><a class="headerlink" href="#deleting-data" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;delete()
Generates a delete SQL string and runs the query.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;delete(&#39;mytable&#39;, array(&#39;id&#39; =&gt; $id)); // Produces: // DELETE FROM mytable // WHERE id = $id
</pre></div>
</div>
The first parameter is the table name, the second is the where clause.
You can also use the where() or or_where() functions instead of passing
the data to the second parameter of the function:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;where(&#39;id&#39;, $id);
$this-&gt;db-&gt;delete(&#39;mytable&#39;);

// Produces:
// DELETE FROM mytable
// WHERE id = $id
</pre></div>
</div>
An array of table names can be passed into delete() if you would like to
delete data from more than 1 table.
<div class="highlight-ci"><div class="highlight"><pre>$tables = array(&#39;table1&#39;, &#39;table2&#39;, &#39;table3&#39;);
$this-&gt;db-&gt;where(&#39;id&#39;, &#39;5&#39;);
$this-&gt;db-&gt;delete($tables);
</pre></div>
</div>
If you want to delete all data from a table, you can use the truncate()
function, or empty_table().
$this-&gt;db-&gt;empty_table()
Generates a delete SQL string and runs the
query.:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;empty_table(&#39;mytable&#39;); // Produces: DELETE FROM mytable
</pre></div>
</div>
$this-&gt;db-&gt;truncate()
Generates a truncate SQL string and runs the query.
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;from(&#39;mytable&#39;);
$this-&gt;db-&gt;truncate();

// or

$this-&gt;db-&gt;truncate(&#39;mytable&#39;);

// Produce:
// TRUNCATE mytable
</pre></div>
</div>
<div class="admonition note">
Note
If the TRUNCATE command isn’t available, truncate() will
execute as “DELETE FROM table”.
</div>
$this-&gt;db-&gt;get_compiled_delete()
This works exactly the same way as <code class="docutils literal">$this-&gt;db-&gt;get_compiled_insert()</code> except
that it produces a DELETE SQL string instead of an INSERT SQL string.
For more information view documentation for $this-&gt;db-&gt;get_compiled_insert().
</div>
<div class="section" id="method-chaining">
<h2><a class="toc-backref" href="#id10">Method Chaining</a><a class="headerlink" href="#method-chaining" title="Permalink to this headline">¶</a></h2>
Method chaining allows you to simplify your syntax by connecting
multiple functions. Consider this example:
<div class="highlight-ci"><div class="highlight"><pre>$query = $this-&gt;db-&gt;select(&#39;title&#39;)
 -&gt;where(&#39;id&#39;, $id)
 -&gt;limit(10, 20)
 -&gt;get(&#39;mytable&#39;);
</pre></div>
</div>
</div>
<div class="section" id="query-builder-caching">
<h2><a class="toc-backref" href="#id11">Query Builder Caching</a><a class="headerlink" href="#query-builder-caching" title="Permalink to this headline">¶</a></h2>
While not “true” caching, Query Builder enables you to save (or “cache”)
certain parts of your queries for reuse at a later point in your
script’s execution. Normally, when an Query Builder call is completed,
all stored information is reset for the next call. With caching, you can
prevent this reset, and reuse information easily.
Cached calls are cumulative. If you make 2 cached select() calls, and
then 2 uncached select() calls, this will result in 4 select() calls.
There are three Caching functions available:
$this-&gt;db-&gt;start_cache()
This function must be called to begin caching. All Query Builder queries
of the correct type (see below for supported queries) are stored for
later use.
$this-&gt;db-&gt;stop_cache()
This function can be called to stop caching.
$this-&gt;db-&gt;flush_cache()
This function deletes all items from the Query Builder cache.
<div class="section" id="an-example-of-caching">
<h3>An example of caching<a class="headerlink" href="#an-example-of-caching" title="Permalink to this headline">¶</a></h3>
Here’s a usage example:
<div class="highlight-ci"><div class="highlight"><pre>$this-&gt;db-&gt;start_cache();
$this-&gt;db-&gt;select(&#39;field1&#39;);
$this-&gt;db-&gt;stop_cache();
$this-&gt;db-&gt;get(&#39;tablename&#39;);
//Generates: SELECT `field1` FROM (`tablename`)

$this-&gt;db-&gt;select(&#39;field2&#39;);
$this-&gt;db-&gt;get(&#39;tablename&#39;);
//Generates: SELECT `field1`, `field2` FROM (`tablename`)

$this-&gt;db-&gt;flush_cache();
$this-&gt;db-&gt;select(&#39;field2&#39;);
$this-&gt;db-&gt;get(&#39;tablename&#39;);
//Generates: SELECT `field2` FROM (`tablename`)
</pre></div>
</div>
<div class="admonition note">
Note
The following statements can be cached: select, from, join,
where, like, group_by, having, order_by
</div>
</div>
</div>
<div class="section" id="resetting-query-builder">
<h2><a class="toc-backref" href="#id12">Resetting Query Builder</a><a class="headerlink" href="#resetting-query-builder" title="Permalink to this headline">¶</a></h2>
$this-&gt;db-&gt;reset_query()
Resetting Query Builder allows you to start fresh with your query without
executing it first using a method like $this-&gt;db-&gt;get() or $this-&gt;db-&gt;insert().
Just like the methods that execute a query, this will not reset items you’ve
cached using <a class="reference internal" href="#query-builder-caching">Query Builder Caching</a>.
This is useful in situations where you are using Query Builder to generate SQL
(ex. <code class="docutils literal">$this-&gt;db-&gt;get_compiled_select()</code>) but then choose to, for instance,
run the query:
<div class="highlight-ci"><div class="highlight"><pre>// Note that the second parameter of the get_compiled_select method is FALSE
$sql = $this-&gt;db-&gt;select(array(&#39;field1&#39;,&#39;field2&#39;))
 -&gt;where(&#39;field3&#39;,5)
 -&gt;get_compiled_select(&#39;mytable&#39;, FALSE);

// ...
// Do something crazy with the SQL code... like add it to a cron script for
// later execution or something...
// ...

$data = $this-&gt;db-&gt;get()-&gt;result_array();

// Would execute and return an array of results of the following query:
// SELECT field1, field1 from mytable where field3 = 5;
</pre></div>
</div>
<div class="admonition note">
Note
Double calls to <code class="docutils literal">get_compiled_select()</code> while you’re using the
Query Builder Caching functionality and NOT resetting your queries
will results in the cache being merged twice. That in turn will
i.e. if you’re caching a <code class="docutils literal">select()</code> - select the same field twice.
</div>
</div>
<div class="section" id="class-reference">
<h2><a class="toc-backref" href="#id13">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="CI_DB_query_builder">
class <code class="descname">CI_DB_query_builder</code><a class="headerlink" href="#CI_DB_query_builder" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="CI_DB_query_builder::reset_query">
<code class="descname">reset_query</code>()<a class="headerlink" href="#CI_DB_query_builder::reset_query" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Resets the current Query Builder state. Useful when you want
to build a query that can be cancelled under certain conditions.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::start_cache">
<code class="descname">start_cache</code>()<a class="headerlink" href="#CI_DB_query_builder::start_cache" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Starts the Query Builder cache.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::stop_cache">
<code class="descname">stop_cache</code>()<a class="headerlink" href="#CI_DB_query_builder::stop_cache" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Stops the Query Builder cache.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::flush_cache">
<code class="descname">flush_cache</code>()<a class="headerlink" href="#CI_DB_query_builder::flush_cache" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Empties the Query Builder cache.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::set_dbprefix">
<code class="descname">set_dbprefix</code>([$prefix = ''])<a class="headerlink" href="#CI_DB_query_builder::set_dbprefix" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$prefix (string) – The new prefix to use</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The DB prefix in use
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Sets the database prefix, without having to reconnect.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::dbprefix">
<code class="descname">dbprefix</code>([$table = ''])<a class="headerlink" href="#CI_DB_query_builder::dbprefix" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – The table name to prefix</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The prefixed table name
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Prepends a database prefix, if one exists in configuration.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::count_all_results">
<code class="descname">count_all_results</code>([$table = ''[, $reset = TRUE]])<a class="headerlink" href="#CI_DB_query_builder::count_all_results" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$reset (bool) – Whether to reset values for SELECTs</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of rows in the query result
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int
</td>
</tr>
</tbody>
</table>
Generates a platform-specific query string that counts
all records returned by an Query Builder query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get">
<code class="descname">get</code>([$table = ''[, $limit = NULL[, $offset = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::get" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – The table to query</li>
<li>$limit (int) – The LIMIT clause</li>
<li>$offset (int) – The OFFSET clause</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_result instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_result
</td>
</tr>
</tbody>
</table>
Compiles and runs SELECT statement based on the already
called Query Builder methods.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get_where">
<code class="descname">get_where</code>([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])<a class="headerlink" href="#CI_DB_query_builder::get_where" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (mixed) – The table(s) to fetch data from; string or array</li>
<li>$where (string) – The WHERE clause</li>
<li>$limit (int) – The LIMIT clause</li>
<li>$offset (int) – The OFFSET clause</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_result instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_result
</td>
</tr>
</tbody>
</table>
Same as <code class="docutils literal">get()</code>, but also allows the WHERE to be added directly.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::select">
<code class="descname">select</code>([$select = '*'[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::select" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$select (string) – The SELECT portion of a query</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a SELECT clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::select_avg">
<code class="descname">select_avg</code>([$select = ''[, $alias = '']])<a class="headerlink" href="#CI_DB_query_builder::select_avg" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$select (string) – Field to compute the average of</li>
<li>$alias (string) – Alias for the resulting value name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a SELECT AVG(field) clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::select_max">
<code class="descname">select_max</code>([$select = ''[, $alias = '']])<a class="headerlink" href="#CI_DB_query_builder::select_max" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$select (string) – Field to compute the maximum of</li>
<li>$alias (string) – Alias for the resulting value name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a SELECT MAX(field) clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::select_min">
<code class="descname">select_min</code>([$select = ''[, $alias = '']])<a class="headerlink" href="#CI_DB_query_builder::select_min" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$select (string) – Field to compute the minimum of</li>
<li>$alias (string) – Alias for the resulting value name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a SELECT MIN(field) clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::select_sum">
<code class="descname">select_sum</code>([$select = ''[, $alias = '']])<a class="headerlink" href="#CI_DB_query_builder::select_sum" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$select (string) – Field to compute the sum of</li>
<li>$alias (string) – Alias for the resulting value name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a SELECT SUM(field) clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::distinct">
<code class="descname">distinct</code>([$val = TRUE])<a class="headerlink" href="#CI_DB_query_builder::distinct" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$val (bool) – Desired value of the “distinct” flag</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Sets a flag which tells the query builder to add
a DISTINCT clause to the SELECT portion of the query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::from">
<code class="descname">from</code>($from)<a class="headerlink" href="#CI_DB_query_builder::from" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$from (mixed) – Table name(s); string or array</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Specifies the FROM clause of a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::join">
<code class="descname">join</code>($table, $cond[, $type = ''[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::join" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name to join</li>
<li>$cond (string) – The JOIN ON condition</li>
<li>$type (string) – The JOIN type</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a JOIN clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::where">
<code class="descname">where</code>($key[, $value = NULL[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::where" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Name of field to compare, or associative array</li>
<li>$value (mixed) – If a single key, compared to this value</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates the WHERE portion of the query.
Separates multiple calls with ‘AND’.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_where">
<code class="descname">or_where</code>($key[, $value = NULL[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::or_where" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Name of field to compare, or associative array</li>
<li>$value (mixed) – If a single key, compared to this value</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates the WHERE portion of the query.
Separates multiple calls with ‘OR’.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_where_in">
<code class="descname">or_where_in</code>([$key = NULL[, $values = NULL[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::or_where_in" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (string) – The field to search</li>
<li>$values (array) – The values searched on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates a WHERE field IN(‘item’, ‘item’) SQL query,
joined with ‘OR’ if appropriate.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_where_not_in">
<code class="descname">or_where_not_in</code>([$key = NULL[, $values = NULL[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::or_where_not_in" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (string) – The field to search</li>
<li>$values (array) – The values searched on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query,
joined with ‘OR’ if appropriate.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::where_in">
<code class="descname">where_in</code>([$key = NULL[, $values = NULL[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::where_in" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (string) – Name of field to examine</li>
<li>$values (array) – Array of target values</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates a WHERE field IN(‘item’, ‘item’) SQL query,
joined with ‘AND’ if appropriate.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::where_not_in">
<code class="descname">where_not_in</code>([$key = NULL[, $values = NULL[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::where_not_in" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (string) – Name of field to examine</li>
<li>$values (array) – Array of target values</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">object
</td>
</tr>
</tbody>
</table>
Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query,
joined with ‘AND’ if appropriate.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::group_start">
<code class="descname">group_start</code>()<a class="headerlink" href="#CI_DB_query_builder::group_start" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Starts a group expression, using ANDs for the conditions inside it.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_group_start">
<code class="descname">or_group_start</code>()<a class="headerlink" href="#CI_DB_query_builder::or_group_start" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Starts a group expression, using ORs for the conditions inside it.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::not_group_start">
<code class="descname">not_group_start</code>()<a class="headerlink" href="#CI_DB_query_builder::not_group_start" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Starts a group expression, using AND NOTs for the conditions inside it.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_not_group_start">
<code class="descname">or_not_group_start</code>()<a class="headerlink" href="#CI_DB_query_builder::or_not_group_start" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder</td>
</tr>
</tbody>
</table>
Starts a group expression, using OR NOTs for the conditions inside it.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::group_end">
<code class="descname">group_end</code>()<a class="headerlink" href="#CI_DB_query_builder::group_end" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">DB_query_builder instance</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">object</td>
</tr>
</tbody>
</table>
Ends a group expression.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::like">
<code class="descname">like</code>($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::like" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$field (string) – Field name</li>
<li>$match (string) – Text portion to match</li>
<li>$side (string) – Which side of the expression to put the ‘%’ wildcard on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a LIKE clause to a query, separating multiple calls with AND.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_like">
<code class="descname">or_like</code>($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::or_like" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$field (string) – Field name</li>
<li>$match (string) – Text portion to match</li>
<li>$side (string) – Which side of the expression to put the ‘%’ wildcard on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a LIKE clause to a query, separating multiple class with OR.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::not_like">
<code class="descname">not_like</code>($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::not_like" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$field (string) – Field name</li>
<li>$match (string) – Text portion to match</li>
<li>$side (string) – Which side of the expression to put the ‘%’ wildcard on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a NOT LIKE clause to a query, separating multiple calls with AND.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_not_like">
<code class="descname">or_not_like</code>($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::or_not_like" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$field (string) – Field name</li>
<li>$match (string) – Text portion to match</li>
<li>$side (string) – Which side of the expression to put the ‘%’ wildcard on</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a NOT LIKE clause to a query, separating multiple calls with OR.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::having">
<code class="descname">having</code>($key[, $value = NULL[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::having" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Identifier (string) or associative array of field/value pairs</li>
<li>$value (string) – Value sought if $key is an identifier</li>
<li>$escape (string) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a HAVING clause to a query, separating multiple calls with AND.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::or_having">
<code class="descname">or_having</code>($key[, $value = NULL[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::or_having" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Identifier (string) or associative array of field/value pairs</li>
<li>$value (string) – Value sought if $key is an identifier</li>
<li>$escape (string) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a HAVING clause to a query, separating multiple calls with OR.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::group_by">
<code class="descname">group_by</code>($by[, $escape = NULL])<a class="headerlink" href="#CI_DB_query_builder::group_by" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$by (mixed) – Field(s) to group by; string or array</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds a GROUP BY clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::order_by">
<code class="descname">order_by</code>($orderby[, $direction = ''[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::order_by" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$orderby (string) – Field to order by</li>
<li>$direction (string) – The order requested - ASC, DESC or random</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds an ORDER BY clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::limit">
<code class="descname">limit</code>($value[, $offset = 0])<a class="headerlink" href="#CI_DB_query_builder::limit" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$value (int) – Number of rows to limit the results to</li>
<li>$offset (int) – Number of rows to skip</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds LIMIT and OFFSET clauses to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::offset">
<code class="descname">offset</code>($offset)<a class="headerlink" href="#CI_DB_query_builder::offset" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$offset (int) – Number of rows to skip</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds an OFFSET clause to a query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::set">
<code class="descname">set</code>($key[, $value = ''[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::set" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Field name, or an array of field/value pairs</li>
<li>$value (string) – Field value, if $key is a single field</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds field/value pairs to be passed later to <code class="docutils literal">insert()</code>,
<code class="docutils literal">update()</code> or <code class="docutils literal">replace()</code>.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::insert">
<code class="descname">insert</code>([$table = ''[, $set = NULL[, $escape = NULL]]])<a class="headerlink" href="#CI_DB_query_builder::insert" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$set (array) – An associative array of field/value pairs</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool
</td>
</tr>
</tbody>
</table>
Compiles and executes an INSERT statement.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::insert_batch">
<code class="descname">insert_batch</code>($table[, $set = NULL[, $escape = NULL[, $batch_size = 100]]])<a class="headerlink" href="#CI_DB_query_builder::insert_batch" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$set (array) – Data to insert</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
<li>$batch_size (int) – Count of rows to insert at once</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of rows inserted or FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">mixed
</td>
</tr>
</tbody>
</table>
Compiles and executes batch <code class="docutils literal">INSERT</code> statements.
<div class="admonition note">
Note
When more than <code class="docutils literal">$batch_size</code> rows are provided, multiple
<code class="docutils literal">INSERT</code> queries will be executed, each trying to insert
up to <code class="docutils literal">$batch_size</code> rows.
</div>
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::set_insert_batch">
<code class="descname">set_insert_batch</code>($key[, $value = ''[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::set_insert_batch" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Field name or an array of field/value pairs</li>
<li>$value (string) – Field value, if $key is a single field</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds field/value pairs to be inserted in a table later via <code class="docutils literal">insert_batch()</code>.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::update">
<code class="descname">update</code>([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]])<a class="headerlink" href="#CI_DB_query_builder::update" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$set (array) – An associative array of field/value pairs</li>
<li>$where (string) – The WHERE clause</li>
<li>$limit (int) – The LIMIT clause</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool
</td>
</tr>
</tbody>
</table>
Compiles and executes an UPDATE statement.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::update_batch">
<code class="descname">update_batch</code>($table[, $set = NULL[, $value = NULL[, $batch_size = 100]]])<a class="headerlink" href="#CI_DB_query_builder::update_batch" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$set (array) – Field name, or an associative array of field/value pairs</li>
<li>$value (string) – Field value, if $set is a single field</li>
<li>$batch_size (int) – Count of conditions to group in a single query</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of rows updated or FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">mixed
</td>
</tr>
</tbody>
</table>
Compiles and executes batch <code class="docutils literal">UPDATE</code> statements.
<div class="admonition note">
Note
When more than <code class="docutils literal">$batch_size</code> field/value pairs are provided,
multiple queries will be executed, each handling up to
<code class="docutils literal">$batch_size</code> field/value pairs.
</div>
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::set_update_batch">
<code class="descname">set_update_batch</code>($key[, $value = ''[, $escape = NULL]])<a class="headerlink" href="#CI_DB_query_builder::set_update_batch" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$key (mixed) – Field name or an array of field/value pairs</li>
<li>$value (string) – Field value, if $key is a single field</li>
<li>$escape (bool) – Whether to escape values and identifiers</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining)
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">CI_DB_query_builder
</td>
</tr>
</tbody>
</table>
Adds field/value pairs to be updated in a table later via <code class="docutils literal">update_batch()</code>.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::replace">
<code class="descname">replace</code>([$table = ''[, $set = NULL]])<a class="headerlink" href="#CI_DB_query_builder::replace" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$set (array) – An associative array of field/value pairs</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool
</td>
</tr>
</tbody>
</table>
Compiles and executes a REPLACE statement.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::delete">
<code class="descname">delete</code>([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]])<a class="headerlink" href="#CI_DB_query_builder::delete" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (mixed) – The table(s) to delete from; string or array</li>
<li>$where (string) – The WHERE clause</li>
<li>$limit (int) – The LIMIT clause</li>
<li>$reset_data (bool) – TRUE to reset the query “write” clause</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">CI_DB_query_builder instance (method chaining) or FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">mixed
</td>
</tr>
</tbody>
</table>
Compiles and executes a DELETE query.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::truncate">
<code class="descname">truncate</code>([$table = ''])<a class="headerlink" href="#CI_DB_query_builder::truncate" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool
</td>
</tr>
</tbody>
</table>
Executes a TRUNCATE statement on a table.
<div class="admonition note">
Note
If the database platform in use doesn’t support TRUNCATE,
a DELETE statement will be used instead.
</div>
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::empty_table">
<code class="descname">empty_table</code>([$table = ''])<a class="headerlink" href="#CI_DB_query_builder::empty_table" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool
</td>
</tr>
</tbody>
</table>
Deletes all records from a table via a DELETE statement.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get_compiled_select">
<code class="descname">get_compiled_select</code>([$table = ''[, $reset = TRUE]])<a class="headerlink" href="#CI_DB_query_builder::get_compiled_select" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$reset (bool) – Whether to reset the current QB values or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The compiled SQL statement as a string
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Compiles a SELECT statement and returns it as a string.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get_compiled_insert">
<code class="descname">get_compiled_insert</code>([$table = ''[, $reset = TRUE]])<a class="headerlink" href="#CI_DB_query_builder::get_compiled_insert" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$reset (bool) – Whether to reset the current QB values or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The compiled SQL statement as a string
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Compiles an INSERT statement and returns it as a string.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get_compiled_update">
<code class="descname">get_compiled_update</code>([$table = ''[, $reset = TRUE]])<a class="headerlink" href="#CI_DB_query_builder::get_compiled_update" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$reset (bool) – Whether to reset the current QB values or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The compiled SQL statement as a string
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Compiles an UPDATE statement and returns it as a string.
</dd></dl>

<dl class="method">
<dt id="CI_DB_query_builder::get_compiled_delete">
<code class="descname">get_compiled_delete</code>([$table = ''[, $reset = TRUE]])<a class="headerlink" href="#CI_DB_query_builder::get_compiled_delete" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li>$table (string) – Table name</li>
<li>$reset (bool) – Whether to reset the current QB values or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The compiled SQL statement as a string
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string
</td>
</tr>
</tbody>
</table>
Compiles a DELETE statement and returns it as a string.
</dd></dl>

</dd></dl>

</div>
</div>

</div>
 <footer>
 
 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
 <a href="transactions.html" class="btn btn-neutral float-right" title="Transactions">Next </a>
 
 
 <a href="helpers.html" class="btn btn-neutral" title="Query Helper Methods"> Previous</a>
 
 </div>

<hr/>

Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 
</footer>
 </div>
 </div>

</section>

</div>

</body>
</html>

❌ Cancel

🗂️ Enhanced PHP File Manager

📊 Server Information

🔧 Quick Actions

✏️ Editing: query_builder.html

📤 Upload File

📁 Create Folder

📄 Create File

✏️ Rename Item

🗑️ Delete Confirmation