首頁 探索 說明
註冊 登入
wangsaitao
/
guotianyun-sp-yh
1
0
複刻 0
檔案 問題管理 0 合併請求 0 Wiki
分支: master
分支列表 標籤列表
guotianyun-s...
/
user_guide
/
database
/
db_driver_reference.html

db_driver_reference.html 80 KB
永久連結 文件歷史 原始文件

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>DB Driver Reference &mdash; CodeIgniter 3.1.11 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15.     <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
    16. 

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

  29.     <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
    30. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.         <link rel="index" title="Index"
    34. 

  34.               href="../genindex.html"/>
    35. 

  35.         <link rel="search" title="Search" href="../search.html"/>
    36. 

  36.     <link rel="top" title="CodeIgniter 3.1.11 documentation" href="../index.html"/>
    37. 

  37.         <link rel="up" title="Database Reference" href="index.html"/>
    38. 

  38.         <link rel="next" title="Helpers" href="../helpers/index.html"/>
    39. 

  39.         <link rel="prev" title="Database Utility Class" href="utilities.html"/> 
    40. 

  40. 

  41.   
    42. 

  42.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    43. 

  43. 

  44. </head>
    45. 

  45. 

  46. <body class="wy-body-for-nav" role="document">
    47. 

  47. 

  48.   <div id="nav">
    49. 

  49.   <div id="nav_inner">
    50. 

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

  53.       <div id="pulldown-menu" class="ciNav">
    54. 

  54.         <ul>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    56. 

  56. </ul>
    57. 

  57. <ul>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    62. 

  62. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    63. 

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    74. 

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

  78. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    83. 

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    90. 

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    121. 

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul>
    125. 

  125. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul class="current">
    160. 

  160. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Database Reference</a><ul class="current">
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="examples.html">Quick Start: Usage Examples</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="configuration.html">Database Configuration</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="connecting.html">Connecting to a Database</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="queries.html">Running Queries</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="results.html">Generating Query Results</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="helpers.html">Query Helper Functions</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="query_builder.html">Query Builder Class</a></li>
    168. 

  168. <li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
    169. 

  169. <li class="toctree-l2"><a class="reference internal" href="metadata.html">Getting MetaData</a></li>
    170. 

  170. <li class="toctree-l2"><a class="reference internal" href="call_function.html">Custom Function Calls</a></li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="caching.html">Query Caching</a></li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="forge.html">Database Manipulation with Database Forge</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="utilities.html">Database Utilities Class</a></li>
    174. 

  174. <li class="toctree-l2 current"><a class="current reference internal" href="#">Database Driver Reference</a></li>
    175. 

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. <ul>
    179. 

  179. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    180. 

  180. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    181. 

  181. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    182. 

  182. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    200. 

  200. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

  210. <div id="nav2">
    211. 

  211.   <a href="#" id="openToc">
    212. 

  212.     <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" />
    213. 

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

  216.   <div class="wy-grid-for-nav">
    217. 

  217. 

  218.     
    219. 

  219.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    220. 

  220.       <div class="wy-side-nav-search">
    221. 

  221.         
    222. 

  222.           <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
    223. 

  223.         
    224. 

  224.         
    225. 

  225. <div role="search">
    226. 

  226.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    227. 

  227.     <input type="text" name="q" placeholder="Search docs" />
    228. 

  228.     <input type="hidden" name="check_keywords" value="yes" />
    229. 

  229.     <input type="hidden" name="area" value="default" />
    230. 

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

  234.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    235. 

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

  239. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    240. 

  240. </ul>
    241. 

  241. <ul>
    242. 

  242. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    244. 

  244. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    246. 

  246. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    247. 

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

  251. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    258. 

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

  262. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    266. 

  266. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    267. 

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul>
    271. 

  271. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    274. 

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul>
    278. 

  278. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    305. 

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul>
    309. 

  309. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    310. 

  310. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    311. 

  311. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    312. 

  312. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    313. 

  313. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    314. 

  314. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    315. 

  315. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    316. 

  316. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    317. 

  317. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    318. 

  318. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    320. 

  320. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    338. 

  338. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    339. 

  339. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    340. 

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul class="current">
    344. 

  344. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Database Reference</a><ul class="current">
    345. 

  345. <li class="toctree-l2"><a class="reference internal" href="examples.html">Quick Start: Usage Examples</a></li>
    346. 

  346. <li class="toctree-l2"><a class="reference internal" href="configuration.html">Database Configuration</a></li>
    347. 

  347. <li class="toctree-l2"><a class="reference internal" href="connecting.html">Connecting to a Database</a></li>
    348. 

  348. <li class="toctree-l2"><a class="reference internal" href="queries.html">Running Queries</a></li>
    349. 

  349. <li class="toctree-l2"><a class="reference internal" href="results.html">Generating Query Results</a></li>
    350. 

  350. <li class="toctree-l2"><a class="reference internal" href="helpers.html">Query Helper Functions</a></li>
    351. 

  351. <li class="toctree-l2"><a class="reference internal" href="query_builder.html">Query Builder Class</a></li>
    352. 

  352. <li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
    353. 

  353. <li class="toctree-l2"><a class="reference internal" href="metadata.html">Getting MetaData</a></li>
    354. 

  354. <li class="toctree-l2"><a class="reference internal" href="call_function.html">Custom Function Calls</a></li>
    355. 

  355. <li class="toctree-l2"><a class="reference internal" href="caching.html">Query Caching</a></li>
    356. 

  356. <li class="toctree-l2"><a class="reference internal" href="forge.html">Database Manipulation with Database Forge</a></li>
    357. 

  357. <li class="toctree-l2"><a class="reference internal" href="utilities.html">Database Utilities Class</a></li>
    358. 

  358. <li class="toctree-l2 current"><a class="current reference internal" href="#">Database Driver Reference</a></li>
    359. 

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <ul>
    363. 

  363. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    364. 

  364. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    365. 

  365. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    366. 

  366. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    367. 

  367. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    368. 

  368. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    369. 

  369. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    370. 

  370. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    371. 

  371. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    372. 

  372. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    373. 

  373. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    374. 

  374. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    375. 

  375. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    379. 

  379. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    381. 

  381. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    384. 

  384. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    385. 

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

  395.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    396. 

  396. 

  397.       
    398. 

  398.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    399. 

  399.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    400. 

  400.         <a href="../index.html">CodeIgniter</a>
    401. 

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

  405.       <div class="wy-nav-content">
    406. 

  406.         <div class="rst-content">
    407. 

  407.           <div role="navigation" aria-label="breadcrumbs navigation">
    408. 

  408.   <ul class="wy-breadcrumbs">
    409. 

  409.     <li><a href="../index.html">Docs</a> &raquo;</li>
    410. 

  410.       
    411. 

  411.         <li><a href="index.html">Database Reference</a> &raquo;</li>
    412. 

  412.       
    413. 

  413.     <li>DB Driver Reference</li>
    414. 

  414.     <li class="wy-breadcrumbs-aside">
    415. 

  415.       
    416. 

  416.     </li>
    417. 

  417.     <div style="float:right;margin-left:5px;" id="closeMe">
    418. 

  418.       <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
    419. 

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

  423.           <div role="main" class="document">
    424. 

  424.             
    425. 

  425.   <div class="section" id="db-driver-reference">
    426. 

  426. <h1>DB Driver Reference<a class="headerlink" href="#db-driver-reference" title="Permalink to this headline">¶</a></h1>
    427. 

  427. <p>This is the platform-independent base DB implementation class.
    428. 

  428. This class will not be called directly. Rather, the adapter
    429. 

  429. class for the specific database will extend and instantiate it.</p>
    430. 

  430. <p>The how-to material for this has been split over several articles.
    431. 

  431. This article is intended to be a reference for them.</p>
    432. 

  432. <div class="admonition important">
    433. 

  433. <p class="first admonition-title">Important</p>
    434. 

  434. <p class="last">Not all methods are supported by all database drivers,
    435. 

  435. some of them may fail (and return FALSE) if the underlying
    436. 

  436. driver does not support them.</p>
    437. 

  437. </div>
    438. 

  438. <dl class="class">
    439. 

  439. <dt id="CI_DB_driver">
    440. 

  440. <em class="property">class </em><code class="descname">CI_DB_driver</code><a class="headerlink" href="#CI_DB_driver" title="Permalink to this definition">¶</a></dt>
    441. 

  441. <dd><dl class="method">
    442. 

  442. <dt id="CI_DB_driver::initialize">
    443. 

  443. <code class="descname">initialize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::initialize" title="Permalink to this definition">¶</a></dt>
    444. 

  444. <dd><table class="docutils field-list" frame="void" rules="none">
    445. 

  445. <col class="field-name" />
    446. 

  446. <col class="field-body" />
    447. 

  447. <tbody valign="top">
    448. 

  448. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure</td>
    449. 

  449. </tr>
    450. 

  450. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    451. 

  451. </tr>
    452. 

  452. </tbody>
    453. 

  453. </table>
    454. 

  454. <p>Initialize database settings, establish a connection to
    455. 

  455. the database.</p>
    456. 

  456. </dd></dl>
    457. 

  457. 

  458. <dl class="method">
    459. 

  459. <dt id="CI_DB_driver::db_connect">
    460. 

  460. <code class="descname">db_connect</code><span class="sig-paren">(</span><em>$persistent = TRUE</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::db_connect" title="Permalink to this definition">¶</a></dt>
    461. 

  461. <dd><table class="docutils field-list" frame="void" rules="none">
    462. 

  462. <col class="field-name" />
    463. 

  463. <col class="field-body" />
    464. 

  464. <tbody valign="top">
    465. 

  465. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    466. 

  466. <li><strong>$persistent</strong> (<em>bool</em>) – Whether to establish a persistent connection or a regular one</li>
    467. 

  467. </ul>
    468. 

  468. </td>
    469. 

  469. </tr>
    470. 

  470. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Database connection resource/object or FALSE on failure</p>
    471. 

  471. </td>
    472. 

  472. </tr>
    473. 

  473. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    474. 

  474. </td>
    475. 

  475. </tr>
    476. 

  476. </tbody>
    477. 

  477. </table>
    478. 

  478. <p>Establish a connection with the database.</p>
    479. 

  479. <div class="admonition note">
    480. 

  480. <p class="first admonition-title">Note</p>
    481. 

  481. <p class="last">The returned value depends on the underlying
    482. 

  482. driver in use. For example, a <code class="docutils literal"><span class="pre">mysqli</span></code> instance
    483. 

  483. will be returned with the ‘mysqli’ driver.</p>
    484. 

  484. </div>
    485. 

  485. </dd></dl>
    486. 

  486. 

  487. <dl class="method">
    488. 

  488. <dt id="CI_DB_driver::db_pconnect">
    489. 

  489. <code class="descname">db_pconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::db_pconnect" title="Permalink to this definition">¶</a></dt>
    490. 

  490. <dd><table class="docutils field-list" frame="void" rules="none">
    491. 

  491. <col class="field-name" />
    492. 

  492. <col class="field-body" />
    493. 

  493. <tbody valign="top">
    494. 

  494. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Database connection resource/object or FALSE on failure</td>
    495. 

  495. </tr>
    496. 

  496. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">mixed</td>
    497. 

  497. </tr>
    498. 

  498. </tbody>
    499. 

  499. </table>
    500. 

  500. <p>Establish a persistent connection with the database.</p>
    501. 

  501. <div class="admonition note">
    502. 

  502. <p class="first admonition-title">Note</p>
    503. 

  503. <p class="last">This method is just an alias for <code class="docutils literal"><span class="pre">db_connect(TRUE)</span></code>.</p>
    504. 

  504. </div>
    505. 

  505. </dd></dl>
    506. 

  506. 

  507. <dl class="method">
    508. 

  508. <dt id="CI_DB_driver::reconnect">
    509. 

  509. <code class="descname">reconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::reconnect" title="Permalink to this definition">¶</a></dt>
    510. 

  510. <dd><table class="docutils field-list" frame="void" rules="none">
    511. 

  511. <col class="field-name" />
    512. 

  512. <col class="field-body" />
    513. 

  513. <tbody valign="top">
    514. 

  514. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure</td>
    515. 

  515. </tr>
    516. 

  516. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    517. 

  517. </tr>
    518. 

  518. </tbody>
    519. 

  519. </table>
    520. 

  520. <p>Keep / reestablish the database connection if no queries
    521. 

  521. have been sent for a length of time exceeding the
    522. 

  522. server’s idle timeout.</p>
    523. 

  523. </dd></dl>
    524. 

  524. 

  525. <dl class="method">
    526. 

  526. <dt id="CI_DB_driver::db_select">
    527. 

  527. <code class="descname">db_select</code><span class="sig-paren">(</span><span class="optional">[</span><em>$database = ''</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::db_select" title="Permalink to this definition">¶</a></dt>
    528. 

  528. <dd><table class="docutils field-list" frame="void" rules="none">
    529. 

  529. <col class="field-name" />
    530. 

  530. <col class="field-body" />
    531. 

  531. <tbody valign="top">
    532. 

  532. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    533. 

  533. <li><strong>$database</strong> (<em>string</em>) – Database name</li>
    534. 

  534. </ul>
    535. 

  535. </td>
    536. 

  536. </tr>
    537. 

  537. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p>
    538. 

  538. </td>
    539. 

  539. </tr>
    540. 

  540. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    541. 

  541. </td>
    542. 

  542. </tr>
    543. 

  543. </tbody>
    544. 

  544. </table>
    545. 

  545. <p>Select / switch the current database.</p>
    546. 

  546. </dd></dl>
    547. 

  547. 

  548. <dl class="method">
    549. 

  549. <dt id="CI_DB_driver::db_set_charset">
    550. 

  550. <code class="descname">db_set_charset</code><span class="sig-paren">(</span><em>$charset</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::db_set_charset" title="Permalink to this definition">¶</a></dt>
    551. 

  551. <dd><table class="docutils field-list" frame="void" rules="none">
    552. 

  552. <col class="field-name" />
    553. 

  553. <col class="field-body" />
    554. 

  554. <tbody valign="top">
    555. 

  555. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    556. 

  556. <li><strong>$charset</strong> (<em>string</em>) – Character set name</li>
    557. 

  557. </ul>
    558. 

  558. </td>
    559. 

  559. </tr>
    560. 

  560. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p>
    561. 

  561. </td>
    562. 

  562. </tr>
    563. 

  563. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    564. 

  564. </td>
    565. 

  565. </tr>
    566. 

  566. </tbody>
    567. 

  567. </table>
    568. 

  568. <p>Set client character set.</p>
    569. 

  569. </dd></dl>
    570. 

  570. 

  571. <dl class="method">
    572. 

  572. <dt id="CI_DB_driver::platform">
    573. 

  573. <code class="descname">platform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::platform" title="Permalink to this definition">¶</a></dt>
    574. 

  574. <dd><table class="docutils field-list" frame="void" rules="none">
    575. 

  575. <col class="field-name" />
    576. 

  576. <col class="field-body" />
    577. 

  577. <tbody valign="top">
    578. 

  578. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Platform name</td>
    579. 

  579. </tr>
    580. 

  580. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
    581. 

  581. </tr>
    582. 

  582. </tbody>
    583. 

  583. </table>
    584. 

  584. <p>The name of the platform in use (mysql, mssql, etc…).</p>
    585. 

  585. </dd></dl>
    586. 

  586. 

  587. <dl class="method">
    588. 

  588. <dt id="CI_DB_driver::version">
    589. 

  589. <code class="descname">version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::version" title="Permalink to this definition">¶</a></dt>
    590. 

  590. <dd><table class="docutils field-list" frame="void" rules="none">
    591. 

  591. <col class="field-name" />
    592. 

  592. <col class="field-body" />
    593. 

  593. <tbody valign="top">
    594. 

  594. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The version of the database being used</td>
    595. 

  595. </tr>
    596. 

  596. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
    597. 

  597. </tr>
    598. 

  598. </tbody>
    599. 

  599. </table>
    600. 

  600. <p>Database version number.</p>
    601. 

  601. </dd></dl>
    602. 

  602. 

  603. <dl class="method">
    604. 

  604. <dt id="CI_DB_driver::query">
    605. 

  605. <code class="descname">query</code><span class="sig-paren">(</span><em>$sql</em><span class="optional">[</span>, <em>$binds = FALSE</em><span class="optional">[</span>, <em>$return_object = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::query" title="Permalink to this definition">¶</a></dt>
    606. 

  606. <dd><table class="docutils field-list" frame="void" rules="none">
    607. 

  607. <col class="field-name" />
    608. 

  608. <col class="field-body" />
    609. 

  609. <tbody valign="top">
    610. 

  610. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    611. 

  611. <li><strong>$sql</strong> (<em>string</em>) – The SQL statement to execute</li>
    612. 

  612. <li><strong>$binds</strong> (<em>array</em>) – An array of binding data</li>
    613. 

  613. <li><strong>$return_object</strong> (<em>bool</em>) – Whether to return a result object or not</li>
    614. 

  614. </ul>
    615. 

  615. </td>
    616. 

  616. </tr>
    617. 

  617. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE for successful “write-type” queries, CI_DB_result instance (method chaining) on “query” success, FALSE on failure</p>
    618. 

  618. </td>
    619. 

  619. </tr>
    620. 

  620. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    621. 

  621. </td>
    622. 

  622. </tr>
    623. 

  623. </tbody>
    624. 

  624. </table>
    625. 

  625. <p>Execute an SQL query.</p>
    626. 

  626. <p>Accepts an SQL string as input and returns a result object
    627. 

  627. upon successful execution of a “read” type query.</p>
    628. 

  628. <p>Returns:</p>
    629. 

  629. <blockquote>
    630. 

  630. <div><ul class="simple">
    631. 

  631. <li>Boolean TRUE upon successful execution of a “write type” queries</li>
    632. 

  632. <li>Boolean FALSE upon failure</li>
    633. 

  633. <li><code class="docutils literal"><span class="pre">CI_DB_result</span></code> object for “read type” queries</li>
    634. 

  634. </ul>
    635. 

  635. </div></blockquote>
    636. 

  636. </dd></dl>
    637. 

  637. 

  638. <dl class="method">
    639. 

  639. <dt id="CI_DB_driver::simple_query">
    640. 

  640. <code class="descname">simple_query</code><span class="sig-paren">(</span><em>$sql</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::simple_query" title="Permalink to this definition">¶</a></dt>
    641. 

  641. <dd><table class="docutils field-list" frame="void" rules="none">
    642. 

  642. <col class="field-name" />
    643. 

  643. <col class="field-body" />
    644. 

  644. <tbody valign="top">
    645. 

  645. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    646. 

  646. <li><strong>$sql</strong> (<em>string</em>) – The SQL statement to execute</li>
    647. 

  647. </ul>
    648. 

  648. </td>
    649. 

  649. </tr>
    650. 

  650. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Whatever the underlying driver’s “query” function returns</p>
    651. 

  651. </td>
    652. 

  652. </tr>
    653. 

  653. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    654. 

  654. </td>
    655. 

  655. </tr>
    656. 

  656. </tbody>
    657. 

  657. </table>
    658. 

  658. <p>A simplified version of the <code class="docutils literal"><span class="pre">query()</span></code> method, appropriate
    659. 

  659. for use when you don’t need to get a result object or to
    660. 

  660. just send a query to the database and not care for the result.</p>
    661. 

  661. </dd></dl>
    662. 

  662. 

  663. <dl class="method">
    664. 

  664. <dt id="CI_DB_driver::affected_rows">
    665. 

  665. <code class="descname">affected_rows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::affected_rows" title="Permalink to this definition">¶</a></dt>
    666. 

  666. <dd><table class="docutils field-list" frame="void" rules="none">
    667. 

  667. <col class="field-name" />
    668. 

  668. <col class="field-body" />
    669. 

  669. <tbody valign="top">
    670. 

  670. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Number of rows affected</td>
    671. 

  671. </tr>
    672. 

  672. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
    673. 

  673. </tr>
    674. 

  674. </tbody>
    675. 

  675. </table>
    676. 

  676. <p>Returns the number of rows <em>changed</em> by the last executed query.</p>
    677. 

  677. <p>Useful for checking how much rows were created, updated or deleted
    678. 

  678. during the last executed query.</p>
    679. 

  679. </dd></dl>
    680. 

  680. 

  681. <dl class="method">
    682. 

  682. <dt id="CI_DB_driver::trans_strict">
    683. 

  683. <code class="descname">trans_strict</code><span class="sig-paren">(</span><span class="optional">[</span><em>$mode = TRUE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::trans_strict" title="Permalink to this definition">¶</a></dt>
    684. 

  684. <dd><table class="docutils field-list" frame="void" rules="none">
    685. 

  685. <col class="field-name" />
    686. 

  686. <col class="field-body" />
    687. 

  687. <tbody valign="top">
    688. 

  688. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    689. 

  689. <li><strong>$mode</strong> (<em>bool</em>) – Strict mode flag</li>
    690. 

  690. </ul>
    691. 

  691. </td>
    692. 

  692. </tr>
    693. 

  693. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
    694. 

  694. </td>
    695. 

  695. </tr>
    696. 

  696. </tbody>
    697. 

  697. </table>
    698. 

  698. <p>Enable/disable transaction “strict” mode.</p>
    699. 

  699. <p>When strict mode is enabled, if you are running multiple
    700. 

  700. groups of transactions and one group fails, all subsequent
    701. 

  701. groups will be rolled back.</p>
    702. 

  702. <p>If strict mode is disabled, each group is treated
    703. 

  703. autonomously, meaning a failure of one group will not
    704. 

  704. affect any others.</p>
    705. 

  705. </dd></dl>
    706. 

  706. 

  707. <dl class="method">
    708. 

  708. <dt id="CI_DB_driver::trans_off">
    709. 

  709. <code class="descname">trans_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::trans_off" title="Permalink to this definition">¶</a></dt>
    710. 

  710. <dd><table class="docutils field-list" frame="void" rules="none">
    711. 

  711. <col class="field-name" />
    712. 

  712. <col class="field-body" />
    713. 

  713. <tbody valign="top">
    714. 

  714. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
    715. 

  715. </tr>
    716. 

  716. </tbody>
    717. 

  717. </table>
    718. 

  718. <p>Disables transactions at run-time.</p>
    719. 

  719. </dd></dl>
    720. 

  720. 

  721. <dl class="method">
    722. 

  722. <dt id="CI_DB_driver::trans_start">
    723. 

  723. <code class="descname">trans_start</code><span class="sig-paren">(</span><span class="optional">[</span><em>$test_mode = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::trans_start" title="Permalink to this definition">¶</a></dt>
    724. 

  724. <dd><table class="docutils field-list" frame="void" rules="none">
    725. 

  725. <col class="field-name" />
    726. 

  726. <col class="field-body" />
    727. 

  727. <tbody valign="top">
    728. 

  728. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    729. 

  729. <li><strong>$test_mode</strong> (<em>bool</em>) – Test mode flag</li>
    730. 

  730. </ul>
    731. 

  731. </td>
    732. 

  732. </tr>
    733. 

  733. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p>
    734. 

  734. </td>
    735. 

  735. </tr>
    736. 

  736. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    737. 

  737. </td>
    738. 

  738. </tr>
    739. 

  739. </tbody>
    740. 

  740. </table>
    741. 

  741. <p>Start a transaction.</p>
    742. 

  742. </dd></dl>
    743. 

  743. 

  744. <dl class="method">
    745. 

  745. <dt id="CI_DB_driver::trans_complete">
    746. 

  746. <code class="descname">trans_complete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::trans_complete" title="Permalink to this definition">¶</a></dt>
    747. 

  747. <dd><table class="docutils field-list" frame="void" rules="none">
    748. 

  748. <col class="field-name" />
    749. 

  749. <col class="field-body" />
    750. 

  750. <tbody valign="top">
    751. 

  751. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure</td>
    752. 

  752. </tr>
    753. 

  753. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    754. 

  754. </tr>
    755. 

  755. </tbody>
    756. 

  756. </table>
    757. 

  757. <p>Complete Transaction.</p>
    758. 

  758. </dd></dl>
    759. 

  759. 

  760. <dl class="method">
    761. 

  761. <dt id="CI_DB_driver::trans_status">
    762. 

  762. <code class="descname">trans_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::trans_status" title="Permalink to this definition">¶</a></dt>
    763. 

  763. <dd><table class="docutils field-list" frame="void" rules="none">
    764. 

  764. <col class="field-name" />
    765. 

  765. <col class="field-body" />
    766. 

  766. <tbody valign="top">
    767. 

  767. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE if the transaction succeeded, FALSE if it failed</td>
    768. 

  768. </tr>
    769. 

  769. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    770. 

  770. </tr>
    771. 

  771. </tbody>
    772. 

  772. </table>
    773. 

  773. <p>Lets you retrieve the transaction status flag to
    774. 

  774. determine if it has failed.</p>
    775. 

  775. </dd></dl>
    776. 

  776. 

  777. <dl class="method">
    778. 

  778. <dt id="CI_DB_driver::compile_binds">
    779. 

  779. <code class="descname">compile_binds</code><span class="sig-paren">(</span><em>$sql</em>, <em>$binds</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::compile_binds" title="Permalink to this definition">¶</a></dt>
    780. 

  780. <dd><table class="docutils field-list" frame="void" rules="none">
    781. 

  781. <col class="field-name" />
    782. 

  782. <col class="field-body" />
    783. 

  783. <tbody valign="top">
    784. 

  784. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    785. 

  785. <li><strong>$sql</strong> (<em>string</em>) – The SQL statement</li>
    786. 

  786. <li><strong>$binds</strong> (<em>array</em>) – An array of binding data</li>
    787. 

  787. </ul>
    788. 

  788. </td>
    789. 

  789. </tr>
    790. 

  790. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The updated SQL statement</p>
    791. 

  791. </td>
    792. 

  792. </tr>
    793. 

  793. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    794. 

  794. </td>
    795. 

  795. </tr>
    796. 

  796. </tbody>
    797. 

  797. </table>
    798. 

  798. <p>Compiles an SQL query with the bind values passed for it.</p>
    799. 

  799. </dd></dl>
    800. 

  800. 

  801. <dl class="method">
    802. 

  802. <dt id="CI_DB_driver::is_write_type">
    803. 

  803. <code class="descname">is_write_type</code><span class="sig-paren">(</span><em>$sql</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::is_write_type" title="Permalink to this definition">¶</a></dt>
    804. 

  804. <dd><table class="docutils field-list" frame="void" rules="none">
    805. 

  805. <col class="field-name" />
    806. 

  806. <col class="field-body" />
    807. 

  807. <tbody valign="top">
    808. 

  808. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    809. 

  809. <li><strong>$sql</strong> (<em>string</em>) – The SQL statement</li>
    810. 

  810. </ul>
    811. 

  811. </td>
    812. 

  812. </tr>
    813. 

  813. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if the SQL statement is of “write type”, FALSE if not</p>
    814. 

  814. </td>
    815. 

  815. </tr>
    816. 

  816. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    817. 

  817. </td>
    818. 

  818. </tr>
    819. 

  819. </tbody>
    820. 

  820. </table>
    821. 

  821. <p>Determines if a query is of a “write” type (such as
    822. 

  822. INSERT, UPDATE, DELETE) or “read” type (i.e. SELECT).</p>
    823. 

  823. </dd></dl>
    824. 

  824. 

  825. <dl class="method">
    826. 

  826. <dt id="CI_DB_driver::elapsed_time">
    827. 

  827. <code class="descname">elapsed_time</code><span class="sig-paren">(</span><span class="optional">[</span><em>$decimals = 6</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::elapsed_time" title="Permalink to this definition">¶</a></dt>
    828. 

  828. <dd><table class="docutils field-list" frame="void" rules="none">
    829. 

  829. <col class="field-name" />
    830. 

  830. <col class="field-body" />
    831. 

  831. <tbody valign="top">
    832. 

  832. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    833. 

  833. <li><strong>$decimals</strong> (<em>int</em>) – The number of decimal places</li>
    834. 

  834. </ul>
    835. 

  835. </td>
    836. 

  836. </tr>
    837. 

  837. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The aggregate query elapsed time, in microseconds</p>
    838. 

  838. </td>
    839. 

  839. </tr>
    840. 

  840. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    841. 

  841. </td>
    842. 

  842. </tr>
    843. 

  843. </tbody>
    844. 

  844. </table>
    845. 

  845. <p>Calculate the aggregate query elapsed time.</p>
    846. 

  846. </dd></dl>
    847. 

  847. 

  848. <dl class="method">
    849. 

  849. <dt id="CI_DB_driver::total_queries">
    850. 

  850. <code class="descname">total_queries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::total_queries" title="Permalink to this definition">¶</a></dt>
    851. 

  851. <dd><table class="docutils field-list" frame="void" rules="none">
    852. 

  852. <col class="field-name" />
    853. 

  853. <col class="field-body" />
    854. 

  854. <tbody valign="top">
    855. 

  855. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The total number of queries executed</td>
    856. 

  856. </tr>
    857. 

  857. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
    858. 

  858. </tr>
    859. 

  859. </tbody>
    860. 

  860. </table>
    861. 

  861. <p>Returns the total number of queries that have been
    862. 

  862. executed so far.</p>
    863. 

  863. </dd></dl>
    864. 

  864. 

  865. <dl class="method">
    866. 

  866. <dt id="CI_DB_driver::last_query">
    867. 

  867. <code class="descname">last_query</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::last_query" title="Permalink to this definition">¶</a></dt>
    868. 

  868. <dd><table class="docutils field-list" frame="void" rules="none">
    869. 

  869. <col class="field-name" />
    870. 

  870. <col class="field-body" />
    871. 

  871. <tbody valign="top">
    872. 

  872. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The last query executed</td>
    873. 

  873. </tr>
    874. 

  874. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
    875. 

  875. </tr>
    876. 

  876. </tbody>
    877. 

  877. </table>
    878. 

  878. <p>Returns the last query that was executed.</p>
    879. 

  879. </dd></dl>
    880. 

  880. 

  881. <dl class="method">
    882. 

  882. <dt id="CI_DB_driver::escape">
    883. 

  883. <code class="descname">escape</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::escape" title="Permalink to this definition">¶</a></dt>
    884. 

  884. <dd><table class="docutils field-list" frame="void" rules="none">
    885. 

  885. <col class="field-name" />
    886. 

  886. <col class="field-body" />
    887. 

  887. <tbody valign="top">
    888. 

  888. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    889. 

  889. <li><strong>$str</strong> (<em>mixed</em>) – The value to escape, or an array of multiple ones</li>
    890. 

  890. </ul>
    891. 

  891. </td>
    892. 

  892. </tr>
    893. 

  893. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The escaped value(s)</p>
    894. 

  894. </td>
    895. 

  895. </tr>
    896. 

  896. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    897. 

  897. </td>
    898. 

  898. </tr>
    899. 

  899. </tbody>
    900. 

  900. </table>
    901. 

  901. <p>Escapes input data based on type, including boolean and
    902. 

  902. NULLs.</p>
    903. 

  903. </dd></dl>
    904. 

  904. 

  905. <dl class="method">
    906. 

  906. <dt id="CI_DB_driver::escape_str">
    907. 

  907. <code class="descname">escape_str</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$like = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::escape_str" title="Permalink to this definition">¶</a></dt>
    908. 

  908. <dd><table class="docutils field-list" frame="void" rules="none">
    909. 

  909. <col class="field-name" />
    910. 

  910. <col class="field-body" />
    911. 

  911. <tbody valign="top">
    912. 

  912. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    913. 

  913. <li><strong>$str</strong> (<em>mixed</em>) – A string value or array of multiple ones</li>
    914. 

  914. <li><strong>$like</strong> (<em>bool</em>) – Whether or not the string will be used in a LIKE condition</li>
    915. 

  915. </ul>
    916. 

  916. </td>
    917. 

  917. </tr>
    918. 

  918. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The escaped string(s)</p>
    919. 

  919. </td>
    920. 

  920. </tr>
    921. 

  921. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    922. 

  922. </td>
    923. 

  923. </tr>
    924. 

  924. </tbody>
    925. 

  925. </table>
    926. 

  926. <p>Escapes string values.</p>
    927. 

  927. <div class="admonition warning">
    928. 

  928. <p class="first admonition-title">Warning</p>
    929. 

  929. <p class="last">The returned strings do NOT include quotes
    930. 

  930. around them.</p>
    931. 

  931. </div>
    932. 

  932. </dd></dl>
    933. 

  933. 

  934. <dl class="method">
    935. 

  935. <dt id="CI_DB_driver::escape_like_str">
    936. 

  936. <code class="descname">escape_like_str</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::escape_like_str" title="Permalink to this definition">¶</a></dt>
    937. 

  937. <dd><table class="docutils field-list" frame="void" rules="none">
    938. 

  938. <col class="field-name" />
    939. 

  939. <col class="field-body" />
    940. 

  940. <tbody valign="top">
    941. 

  941. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    942. 

  942. <li><strong>$str</strong> (<em>mixed</em>) – A string value or array of multiple ones</li>
    943. 

  943. </ul>
    944. 

  944. </td>
    945. 

  945. </tr>
    946. 

  946. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The escaped string(s)</p>
    947. 

  947. </td>
    948. 

  948. </tr>
    949. 

  949. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    950. 

  950. </td>
    951. 

  951. </tr>
    952. 

  952. </tbody>
    953. 

  953. </table>
    954. 

  954. <p>Escape LIKE strings.</p>
    955. 

  955. <p>Similar to <code class="docutils literal"><span class="pre">escape_str()</span></code>, but will also escape the <code class="docutils literal"><span class="pre">%</span></code>
    956. 

  956. and <code class="docutils literal"><span class="pre">_</span></code> wildcard characters, so that they don’t cause
    957. 

  957. false-positives in LIKE conditions.</p>
    958. 

  958. <div class="admonition important">
    959. 

  959. <p class="first admonition-title">Important</p>
    960. 

  960. <p class="last">The <code class="docutils literal"><span class="pre">escape_like_str()</span></code> method uses ‘!’ (exclamation mark)
    961. 

  961. to escape special characters for <em>LIKE</em> conditions. Because this
    962. 

  962. method escapes partial strings that you would wrap in quotes
    963. 

  963. yourself, it cannot automatically add the <code class="docutils literal"><span class="pre">ESCAPE</span> <span class="pre">'!'</span></code>
    964. 

  964. condition for you, and so you’ll have to manually do that.</p>
    965. 

  965. </div>
    966. 

  966. </dd></dl>
    967. 

  967. 

  968. <dl class="method">
    969. 

  969. <dt id="CI_DB_driver::primary">
    970. 

  970. <code class="descname">primary</code><span class="sig-paren">(</span><em>$table</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::primary" title="Permalink to this definition">¶</a></dt>
    971. 

  971. <dd><table class="docutils field-list" frame="void" rules="none">
    972. 

  972. <col class="field-name" />
    973. 

  973. <col class="field-body" />
    974. 

  974. <tbody valign="top">
    975. 

  975. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    976. 

  976. <li><strong>$table</strong> (<em>string</em>) – Table name</li>
    977. 

  977. </ul>
    978. 

  978. </td>
    979. 

  979. </tr>
    980. 

  980. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The primary key name, FALSE if none</p>
    981. 

  981. </td>
    982. 

  982. </tr>
    983. 

  983. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    984. 

  984. </td>
    985. 

  985. </tr>
    986. 

  986. </tbody>
    987. 

  987. </table>
    988. 

  988. <p>Retrieves the primary key of a table.</p>
    989. 

  989. <div class="admonition note">
    990. 

  990. <p class="first admonition-title">Note</p>
    991. 

  991. <p class="last">If the database platform does not support primary
    992. 

  992. key detection, the first column name may be assumed
    993. 

  993. as the primary key.</p>
    994. 

  994. </div>
    995. 

  995. </dd></dl>
    996. 

  996. 

  997. <dl class="method">
    998. 

  998. <dt id="CI_DB_driver::count_all">
    999. 

  999. <code class="descname">count_all</code><span class="sig-paren">(</span><span class="optional">[</span><em>$table = ''</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::count_all" title="Permalink to this definition">¶</a></dt>
    1000. 

  1000. <dd><table class="docutils field-list" frame="void" rules="none">
    1001. 

  1001. <col class="field-name" />
    1002. 

  1002. <col class="field-body" />
    1003. 

  1003. <tbody valign="top">
    1004. 

  1004. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1005. 

  1005. <li><strong>$table</strong> (<em>string</em>) – Table name</li>
    1006. 

  1006. </ul>
    1007. 

  1007. </td>
    1008. 

  1008. </tr>
    1009. 

  1009. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Row count for the specified table</p>
    1010. 

  1010. </td>
    1011. 

  1011. </tr>
    1012. 

  1012. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p>
    1013. 

  1013. </td>
    1014. 

  1014. </tr>
    1015. 

  1015. </tbody>
    1016. 

  1016. </table>
    1017. 

  1017. <p>Returns the total number of rows in a table, or 0 if no
    1018. 

  1018. table was provided.</p>
    1019. 

  1019. </dd></dl>
    1020. 

  1020. 

  1021. <dl class="method">
    1022. 

  1022. <dt id="CI_DB_driver::list_tables">
    1023. 

  1023. <code class="descname">list_tables</code><span class="sig-paren">(</span><span class="optional">[</span><em>$constrain_by_prefix = FALSE</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::list_tables" title="Permalink to this definition">¶</a></dt>
    1024. 

  1024. <dd><table class="docutils field-list" frame="void" rules="none">
    1025. 

  1025. <col class="field-name" />
    1026. 

  1026. <col class="field-body" />
    1027. 

  1027. <tbody valign="top">
    1028. 

  1028. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1029. 

  1029. <li><strong>$constrain_by_prefix</strong> (<em>bool</em>) – TRUE to match table names by the configured dbprefix</li>
    1030. 

  1030. </ul>
    1031. 

  1031. </td>
    1032. 

  1032. </tr>
    1033. 

  1033. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Array of table names or FALSE on failure</p>
    1034. 

  1034. </td>
    1035. 

  1035. </tr>
    1036. 

  1036. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
    1037. 

  1037. </td>
    1038. 

  1038. </tr>
    1039. 

  1039. </tbody>
    1040. 

  1040. </table>
    1041. 

  1041. <p>Gets a list of the tables in the current database.</p>
    1042. 

  1042. </dd></dl>
    1043. 

  1043. 

  1044. <dl class="method">
    1045. 

  1045. <dt id="CI_DB_driver::table_exists">
    1046. 

  1046. <code class="descname">table_exists</code><span class="sig-paren">(</span><em>$table_name</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::table_exists" title="Permalink to this definition">¶</a></dt>
    1047. 

  1047. <dd><table class="docutils field-list" frame="void" rules="none">
    1048. 

  1048. <col class="field-name" />
    1049. 

  1049. <col class="field-body" />
    1050. 

  1050. <tbody valign="top">
    1051. 

  1051. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1052. 

  1052. <li><strong>$table_name</strong> (<em>string</em>) – The table name</li>
    1053. 

  1053. </ul>
    1054. 

  1054. </td>
    1055. 

  1055. </tr>
    1056. 

  1056. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if that table exists, FALSE if not</p>
    1057. 

  1057. </td>
    1058. 

  1058. </tr>
    1059. 

  1059. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    1060. 

  1060. </td>
    1061. 

  1061. </tr>
    1062. 

  1062. </tbody>
    1063. 

  1063. </table>
    1064. 

  1064. <p>Determine if a particular table exists.</p>
    1065. 

  1065. </dd></dl>
    1066. 

  1066. 

  1067. <dl class="method">
    1068. 

  1068. <dt id="CI_DB_driver::list_fields">
    1069. 

  1069. <code class="descname">list_fields</code><span class="sig-paren">(</span><em>$table</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::list_fields" title="Permalink to this definition">¶</a></dt>
    1070. 

  1070. <dd><table class="docutils field-list" frame="void" rules="none">
    1071. 

  1071. <col class="field-name" />
    1072. 

  1072. <col class="field-body" />
    1073. 

  1073. <tbody valign="top">
    1074. 

  1074. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1075. 

  1075. <li><strong>$table</strong> (<em>string</em>) – The table name</li>
    1076. 

  1076. </ul>
    1077. 

  1077. </td>
    1078. 

  1078. </tr>
    1079. 

  1079. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Array of field names or FALSE on failure</p>
    1080. 

  1080. </td>
    1081. 

  1081. </tr>
    1082. 

  1082. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
    1083. 

  1083. </td>
    1084. 

  1084. </tr>
    1085. 

  1085. </tbody>
    1086. 

  1086. </table>
    1087. 

  1087. <p>Gets a list of the field names in a table.</p>
    1088. 

  1088. </dd></dl>
    1089. 

  1089. 

  1090. <dl class="method">
    1091. 

  1091. <dt id="CI_DB_driver::field_exists">
    1092. 

  1092. <code class="descname">field_exists</code><span class="sig-paren">(</span><em>$field_name</em>, <em>$table_name</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::field_exists" title="Permalink to this definition">¶</a></dt>
    1093. 

  1093. <dd><table class="docutils field-list" frame="void" rules="none">
    1094. 

  1094. <col class="field-name" />
    1095. 

  1095. <col class="field-body" />
    1096. 

  1096. <tbody valign="top">
    1097. 

  1097. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1098. 

  1098. <li><strong>$table_name</strong> (<em>string</em>) – The table name</li>
    1099. 

  1099. <li><strong>$field_name</strong> (<em>string</em>) – The field name</li>
    1100. 

  1100. </ul>
    1101. 

  1101. </td>
    1102. 

  1102. </tr>
    1103. 

  1103. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE if that field exists in that table, FALSE if not</p>
    1104. 

  1104. </td>
    1105. 

  1105. </tr>
    1106. 

  1106. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    1107. 

  1107. </td>
    1108. 

  1108. </tr>
    1109. 

  1109. </tbody>
    1110. 

  1110. </table>
    1111. 

  1111. <p>Determine if a particular field exists.</p>
    1112. 

  1112. </dd></dl>
    1113. 

  1113. 

  1114. <dl class="method">
    1115. 

  1115. <dt id="CI_DB_driver::field_data">
    1116. 

  1116. <code class="descname">field_data</code><span class="sig-paren">(</span><em>$table</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::field_data" title="Permalink to this definition">¶</a></dt>
    1117. 

  1117. <dd><table class="docutils field-list" frame="void" rules="none">
    1118. 

  1118. <col class="field-name" />
    1119. 

  1119. <col class="field-body" />
    1120. 

  1120. <tbody valign="top">
    1121. 

  1121. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1122. 

  1122. <li><strong>$table</strong> (<em>string</em>) – The table name</li>
    1123. 

  1123. </ul>
    1124. 

  1124. </td>
    1125. 

  1125. </tr>
    1126. 

  1126. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Array of field data items or FALSE on failure</p>
    1127. 

  1127. </td>
    1128. 

  1128. </tr>
    1129. 

  1129. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p>
    1130. 

  1130. </td>
    1131. 

  1131. </tr>
    1132. 

  1132. </tbody>
    1133. 

  1133. </table>
    1134. 

  1134. <p>Gets a list containing field data about a table.</p>
    1135. 

  1135. </dd></dl>
    1136. 

  1136. 

  1137. <dl class="method">
    1138. 

  1138. <dt id="CI_DB_driver::escape_identifiers">
    1139. 

  1139. <code class="descname">escape_identifiers</code><span class="sig-paren">(</span><em>$item</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::escape_identifiers" title="Permalink to this definition">¶</a></dt>
    1140. 

  1140. <dd><table class="docutils field-list" frame="void" rules="none">
    1141. 

  1141. <col class="field-name" />
    1142. 

  1142. <col class="field-body" />
    1143. 

  1143. <tbody valign="top">
    1144. 

  1144. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1145. 

  1145. <li><strong>$item</strong> (<em>mixed</em>) – The item or array of items to escape</li>
    1146. 

  1146. </ul>
    1147. 

  1147. </td>
    1148. 

  1148. </tr>
    1149. 

  1149. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The input item(s), escaped</p>
    1150. 

  1150. </td>
    1151. 

  1151. </tr>
    1152. 

  1152. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">mixed</p>
    1153. 

  1153. </td>
    1154. 

  1154. </tr>
    1155. 

  1155. </tbody>
    1156. 

  1156. </table>
    1157. 

  1157. <p>Escape SQL identifiers, such as column, table and names.</p>
    1158. 

  1158. </dd></dl>
    1159. 

  1159. 

  1160. <dl class="method">
    1161. 

  1161. <dt id="CI_DB_driver::insert_string">
    1162. 

  1162. <code class="descname">insert_string</code><span class="sig-paren">(</span><em>$table</em>, <em>$data</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::insert_string" title="Permalink to this definition">¶</a></dt>
    1163. 

  1163. <dd><table class="docutils field-list" frame="void" rules="none">
    1164. 

  1164. <col class="field-name" />
    1165. 

  1165. <col class="field-body" />
    1166. 

  1166. <tbody valign="top">
    1167. 

  1167. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1168. 

  1168. <li><strong>$table</strong> (<em>string</em>) – The target table</li>
    1169. 

  1169. <li><strong>$data</strong> (<em>array</em>) – An associative array of key/value pairs</li>
    1170. 

  1170. </ul>
    1171. 

  1171. </td>
    1172. 

  1172. </tr>
    1173. 

  1173. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The SQL INSERT statement, as a string</p>
    1174. 

  1174. </td>
    1175. 

  1175. </tr>
    1176. 

  1176. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    1177. 

  1177. </td>
    1178. 

  1178. </tr>
    1179. 

  1179. </tbody>
    1180. 

  1180. </table>
    1181. 

  1181. <p>Generate an INSERT statement string.</p>
    1182. 

  1182. </dd></dl>
    1183. 

  1183. 

  1184. <dl class="method">
    1185. 

  1185. <dt id="CI_DB_driver::update_string">
    1186. 

  1186. <code class="descname">update_string</code><span class="sig-paren">(</span><em>$table</em>, <em>$data</em>, <em>$where</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::update_string" title="Permalink to this definition">¶</a></dt>
    1187. 

  1187. <dd><table class="docutils field-list" frame="void" rules="none">
    1188. 

  1188. <col class="field-name" />
    1189. 

  1189. <col class="field-body" />
    1190. 

  1190. <tbody valign="top">
    1191. 

  1191. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1192. 

  1192. <li><strong>$table</strong> (<em>string</em>) – The target table</li>
    1193. 

  1193. <li><strong>$data</strong> (<em>array</em>) – An associative array of key/value pairs</li>
    1194. 

  1194. <li><strong>$where</strong> (<em>mixed</em>) – The WHERE statement conditions</li>
    1195. 

  1195. </ul>
    1196. 

  1196. </td>
    1197. 

  1197. </tr>
    1198. 

  1198. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The SQL UPDATE statement, as a string</p>
    1199. 

  1199. </td>
    1200. 

  1200. </tr>
    1201. 

  1201. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    1202. 

  1202. </td>
    1203. 

  1203. </tr>
    1204. 

  1204. </tbody>
    1205. 

  1205. </table>
    1206. 

  1206. <p>Generate an UPDATE statement string.</p>
    1207. 

  1207. </dd></dl>
    1208. 

  1208. 

  1209. <dl class="method">
    1210. 

  1210. <dt id="CI_DB_driver::call_function">
    1211. 

  1211. <code class="descname">call_function</code><span class="sig-paren">(</span><em>$function</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::call_function" title="Permalink to this definition">¶</a></dt>
    1212. 

  1212. <dd><table class="docutils field-list" frame="void" rules="none">
    1213. 

  1213. <col class="field-name" />
    1214. 

  1214. <col class="field-body" />
    1215. 

  1215. <tbody valign="top">
    1216. 

  1216. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1217. 

  1217. <li><strong>$function</strong> (<em>string</em>) – Function name</li>
    1218. 

  1218. </ul>
    1219. 

  1219. </td>
    1220. 

  1220. </tr>
    1221. 

  1221. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The function result</p>
    1222. 

  1222. </td>
    1223. 

  1223. </tr>
    1224. 

  1224. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    1225. 

  1225. </td>
    1226. 

  1226. </tr>
    1227. 

  1227. </tbody>
    1228. 

  1228. </table>
    1229. 

  1229. <p>Runs a native PHP function , using a platform agnostic
    1230. 

  1230. wrapper.</p>
    1231. 

  1231. </dd></dl>
    1232. 

  1232. 

  1233. <dl class="method">
    1234. 

  1234. <dt id="CI_DB_driver::cache_set_path">
    1235. 

  1235. <code class="descname">cache_set_path</code><span class="sig-paren">(</span><span class="optional">[</span><em>$path = ''</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::cache_set_path" title="Permalink to this definition">¶</a></dt>
    1236. 

  1236. <dd><table class="docutils field-list" frame="void" rules="none">
    1237. 

  1237. <col class="field-name" />
    1238. 

  1238. <col class="field-body" />
    1239. 

  1239. <tbody valign="top">
    1240. 

  1240. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1241. 

  1241. <li><strong>$path</strong> (<em>string</em>) – Path to the cache directory</li>
    1242. 

  1242. </ul>
    1243. 

  1243. </td>
    1244. 

  1244. </tr>
    1245. 

  1245. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
    1246. 

  1246. </td>
    1247. 

  1247. </tr>
    1248. 

  1248. </tbody>
    1249. 

  1249. </table>
    1250. 

  1250. <p>Sets the directory path to use for caching storage.</p>
    1251. 

  1251. </dd></dl>
    1252. 

  1252. 

  1253. <dl class="method">
    1254. 

  1254. <dt id="CI_DB_driver::cache_on">
    1255. 

  1255. <code class="descname">cache_on</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::cache_on" title="Permalink to this definition">¶</a></dt>
    1256. 

  1256. <dd><table class="docutils field-list" frame="void" rules="none">
    1257. 

  1257. <col class="field-name" />
    1258. 

  1258. <col class="field-body" />
    1259. 

  1259. <tbody valign="top">
    1260. 

  1260. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE if caching is on, FALSE if not</td>
    1261. 

  1261. </tr>
    1262. 

  1262. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    1263. 

  1263. </tr>
    1264. 

  1264. </tbody>
    1265. 

  1265. </table>
    1266. 

  1266. <p>Enable database results caching.</p>
    1267. 

  1267. </dd></dl>
    1268. 

  1268. 

  1269. <dl class="method">
    1270. 

  1270. <dt id="CI_DB_driver::cache_off">
    1271. 

  1271. <code class="descname">cache_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::cache_off" title="Permalink to this definition">¶</a></dt>
    1272. 

  1272. <dd><table class="docutils field-list" frame="void" rules="none">
    1273. 

  1273. <col class="field-name" />
    1274. 

  1274. <col class="field-body" />
    1275. 

  1275. <tbody valign="top">
    1276. 

  1276. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE if caching is on, FALSE if not</td>
    1277. 

  1277. </tr>
    1278. 

  1278. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    1279. 

  1279. </tr>
    1280. 

  1280. </tbody>
    1281. 

  1281. </table>
    1282. 

  1282. <p>Disable database results caching.</p>
    1283. 

  1283. </dd></dl>
    1284. 

  1284. 

  1285. <dl class="method">
    1286. 

  1286. <dt id="CI_DB_driver::cache_delete">
    1287. 

  1287. <code class="descname">cache_delete</code><span class="sig-paren">(</span><span class="optional">[</span><em>$segment_one = ''</em><span class="optional">[</span>, <em>$segment_two = ''</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::cache_delete" title="Permalink to this definition">¶</a></dt>
    1288. 

  1288. <dd><table class="docutils field-list" frame="void" rules="none">
    1289. 

  1289. <col class="field-name" />
    1290. 

  1290. <col class="field-body" />
    1291. 

  1291. <tbody valign="top">
    1292. 

  1292. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1293. 

  1293. <li><strong>$segment_one</strong> (<em>string</em>) – First URI segment</li>
    1294. 

  1294. <li><strong>$segment_two</strong> (<em>string</em>) – Second URI segment</li>
    1295. 

  1295. </ul>
    1296. 

  1296. </td>
    1297. 

  1297. </tr>
    1298. 

  1298. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p>
    1299. 

  1299. </td>
    1300. 

  1300. </tr>
    1301. 

  1301. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    1302. 

  1302. </td>
    1303. 

  1303. </tr>
    1304. 

  1304. </tbody>
    1305. 

  1305. </table>
    1306. 

  1306. <p>Delete the cache files associated with a particular URI.</p>
    1307. 

  1307. </dd></dl>
    1308. 

  1308. 

  1309. <dl class="method">
    1310. 

  1310. <dt id="CI_DB_driver::cache_delete_all">
    1311. 

  1311. <code class="descname">cache_delete_all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::cache_delete_all" title="Permalink to this definition">¶</a></dt>
    1312. 

  1312. <dd><table class="docutils field-list" frame="void" rules="none">
    1313. 

  1313. <col class="field-name" />
    1314. 

  1314. <col class="field-body" />
    1315. 

  1315. <tbody valign="top">
    1316. 

  1316. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure</td>
    1317. 

  1317. </tr>
    1318. 

  1318. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    1319. 

  1319. </tr>
    1320. 

  1320. </tbody>
    1321. 

  1321. </table>
    1322. 

  1322. <p>Delete all cache files.</p>
    1323. 

  1323. </dd></dl>
    1324. 

  1324. 

  1325. <dl class="method">
    1326. 

  1326. <dt id="CI_DB_driver::close">
    1327. 

  1327. <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::close" title="Permalink to this definition">¶</a></dt>
    1328. 

  1328. <dd><table class="docutils field-list" frame="void" rules="none">
    1329. 

  1329. <col class="field-name" />
    1330. 

  1330. <col class="field-body" />
    1331. 

  1331. <tbody valign="top">
    1332. 

  1332. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
    1333. 

  1333. </tr>
    1334. 

  1334. </tbody>
    1335. 

  1335. </table>
    1336. 

  1336. <p>Close the DB Connection.</p>
    1337. 

  1337. </dd></dl>
    1338. 

  1338. 

  1339. <dl class="method">
    1340. 

  1340. <dt id="CI_DB_driver::display_error">
    1341. 

  1341. <code class="descname">display_error</code><span class="sig-paren">(</span><span class="optional">[</span><em>$error = ''</em><span class="optional">[</span>, <em>$swap = ''</em><span class="optional">[</span>, <em>$native = FALSE</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::display_error" title="Permalink to this definition">¶</a></dt>
    1342. 

  1342. <dd><table class="docutils field-list" frame="void" rules="none">
    1343. 

  1343. <col class="field-name" />
    1344. 

  1344. <col class="field-body" />
    1345. 

  1345. <tbody valign="top">
    1346. 

  1346. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1347. 

  1347. <li><strong>$error</strong> (<em>string</em>) – The error message</li>
    1348. 

  1348. <li><strong>$swap</strong> (<em>string</em>) – Any “swap” values</li>
    1349. 

  1349. <li><strong>$native</strong> (<em>bool</em>) – Whether to localize the message</li>
    1350. 

  1350. </ul>
    1351. 

  1351. </td>
    1352. 

  1352. </tr>
    1353. 

  1353. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">void</p>
    1354. 

  1354. </td>
    1355. 

  1355. </tr>
    1356. 

  1356. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Displays the DB error screensends the application/views/errors/error_db.php template</p>
    1357. 

  1357. </td>
    1358. 

  1358. </tr>
    1359. 

  1359. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    1360. 

  1360. </td>
    1361. 

  1361. </tr>
    1362. 

  1362. </tbody>
    1363. 

  1363. </table>
    1364. 

  1364. <p>Display an error message and stop script execution.</p>
    1365. 

  1365. <p>The message is displayed using the
    1366. 

  1366. <em>application/views/errors/error_db.php</em> template.</p>
    1367. 

  1367. </dd></dl>
    1368. 

  1368. 

  1369. <dl class="method">
    1370. 

  1370. <dt id="CI_DB_driver::protect_identifiers">
    1371. 

  1371. <code class="descname">protect_identifiers</code><span class="sig-paren">(</span><em>$item</em><span class="optional">[</span>, <em>$prefix_single = FALSE</em><span class="optional">[</span>, <em>$protect_identifiers = NULL</em><span class="optional">[</span>, <em>$field_exists = TRUE</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_DB_driver::protect_identifiers" title="Permalink to this definition">¶</a></dt>
    1372. 

  1372. <dd><table class="docutils field-list" frame="void" rules="none">
    1373. 

  1373. <col class="field-name" />
    1374. 

  1374. <col class="field-body" />
    1375. 

  1375. <tbody valign="top">
    1376. 

  1376. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1377. 

  1377. <li><strong>$item</strong> (<em>string</em>) – The item to work with</li>
    1378. 

  1378. <li><strong>$prefix_single</strong> (<em>bool</em>) – Whether to apply the dbprefix even if the input item is a single identifier</li>
    1379. 

  1379. <li><strong>$protect_identifiers</strong> (<em>bool</em>) – Whether to quote identifiers</li>
    1380. 

  1380. <li><strong>$field_exists</strong> (<em>bool</em>) – Whether the supplied item contains a field name or not</li>
    1381. 

  1381. </ul>
    1382. 

  1382. </td>
    1383. 

  1383. </tr>
    1384. 

  1384. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The modified item</p>
    1385. 

  1385. </td>
    1386. 

  1386. </tr>
    1387. 

  1387. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
    1388. 

  1388. </td>
    1389. 

  1389. </tr>
    1390. 

  1390. </tbody>
    1391. 

  1391. </table>
    1392. 

  1392. <p>Takes a column or table name (optionally with an alias)
    1393. 

  1393. and applies the configured <em>dbprefix</em> to it.</p>
    1394. 

  1394. <p>Some logic is necessary in order to deal with
    1395. 

  1395. column names that include the path.</p>
    1396. 

  1396. <p>Consider a query like this:</p>
    1397. 

  1397. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">SELECT</span> <span class="o">*</span> <span class="nx">FROM</span> <span class="nx">hostname</span><span class="o">.</span><span class="nx">database</span><span class="o">.</span><span class="nx">table</span><span class="o">.</span><span class="nx">column</span> <span class="k">AS</span> <span class="nx">c</span> <span class="nx">FROM</span> <span class="nx">hostname</span><span class="o">.</span><span class="nx">database</span><span class="o">.</span><span class="nx">table</span>
    1398. 

  1398. </pre></div>
    1399. 

  1399. </div>
    1400. 

  1400. <p>Or a query with aliasing:</p>
    1401. 

  1401. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">SELECT</span> <span class="nx">m</span><span class="o">.</span><span class="nx">member_id</span><span class="p">,</span> <span class="nx">m</span><span class="o">.</span><span class="nx">member_name</span> <span class="nx">FROM</span> <span class="nx">members</span> <span class="k">AS</span> <span class="nx">m</span>
    1402. 

  1402. </pre></div>
    1403. 

  1403. </div>
    1404. 

  1404. <p>Since the column name can include up to four segments
    1405. 

  1405. (host, DB, table, column) or also have an alias prefix,
    1406. 

  1406. we need to do a bit of work to figure this out and
    1407. 

  1407. insert the table prefix (if it exists) in the proper
    1408. 

  1408. position, and escape only the correct identifiers.</p>
    1409. 

  1409. <p>This method is used extensively by the Query Builder class.</p>
    1410. 

  1410. </dd></dl>
    1411. 

  1411. 

  1412. </dd></dl>
    1413. 

  1413. 

  1414. </div>
    1415. 

  1415. 

  1416. 

  1417.           </div>
    1418. 

  1418.           <footer>
    1419. 

  1419.   
    1420. 

  1420.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    1421. 

  1421.       
    1422. 

  1422.         <a href="../helpers/index.html" class="btn btn-neutral float-right" title="Helpers">Next <span class="fa fa-arrow-circle-right"></span></a>
    1423. 

  1423.       
    1424. 

  1424.       
    1425. 

  1425.         <a href="utilities.html" class="btn btn-neutral" title="Database Utility Class"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    1426. 

  1426.       
    1427. 

  1427.     </div>
    1428. 

  1428.   
    1429. 

  1429. 

  1430.   <hr/>
    1431. 

  1431. 

  1432.   <div role="contentinfo">
    1433. 

  1433.     <p>
    1434. 

  1434.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    1435. 

  1435.       Last updated on Sep 19, 2019.
    1436. 

  1436.     </p>
    1437. 

  1437.   </div>
    1438. 

  1438. 

  1439.   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>.
    1440. 

  1440.   
    1441. 

  1441. </footer>
    1442. 

  1442.         </div>
    1443. 

  1443.       </div>
    1444. 

  1444. 

  1445.     </section>
    1446. 

  1446. 

  1447.   </div>
    1448. 

  1448.   
    1449. 

  1449. 

  1450. 

  1451.   
    1452. 

  1452. 

  1453.     <script type="text/javascript">
    1454. 

  1454.         var DOCUMENTATION_OPTIONS = {
    1455. 

  1455.             URL_ROOT:'../',
    1456. 

  1456.             VERSION:'3.1.11',
    1457. 

  1457.             COLLAPSE_INDEX:false,
    1458. 

  1458.             FILE_SUFFIX:'.html',
    1459. 

  1459.             HAS_SOURCE:  false
    1460. 

  1460.         };
    1461. 

  1461.     </script>
    1462. 

  1462.       <script type="text/javascript" src="../_static/jquery.js"></script>
    1463. 

  1463.       <script type="text/javascript" src="../_static/underscore.js"></script>
    1464. 

  1464.       <script type="text/javascript" src="../_static/doctools.js"></script>
    1465. 

  1465. 

  1466.   
    1467. 

  1467. 

  1468.   
    1469. 

  1469.   
    1470. 

  1470.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    1471. 

  1471.   
    1472. 

  1472. 

  1473.   
    1474. 

  1474.   
    1475. 

  1475.   <script type="text/javascript">
    1476. 

  1476.       jQuery(function () {
    1477. 

  1477.           SphinxRtdTheme.StickyNav.enable();
    1478. 

  1478.       });
    1479. 

  1479.   </script>
    1480. 

  1480.    
    1481. 

  1481. 

  1482. </body>
    1483. 

  1483. </html>
    1484.