|
| 1 | +<!DOCTYPE html> |
| 2 | +<html itemscope="itemscope" itemtype="http://schema.org/WebPage" lang="en"> |
| 3 | + |
| 4 | +<!-- |
| 5 | +
|
| 6 | +Copyright (c) 2022, Oracle and/or its affiliates. |
| 7 | +
|
| 8 | +This software is dual-licensed to you under the Universal Permissive License |
| 9 | +(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License |
| 10 | +2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose |
| 11 | +either license. |
| 12 | +
|
| 13 | +If you elect to accept the software under the Apache License, Version 2.0, |
| 14 | +the following applies: |
| 15 | +
|
| 16 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 17 | +you may not use this file except in compliance with the License. |
| 18 | +You may obtain a copy of the License at |
| 19 | +
|
| 20 | + https://www.apache.org/licenses/LICENSE-2.0 |
| 21 | +
|
| 22 | +Unless required by applicable law or agreed to in writing, software |
| 23 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 24 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 25 | +See the License for the specific language governing permissions and |
| 26 | +limitations under the License. |
| 27 | +
|
| 28 | +--> |
| 29 | + |
| 30 | +<head> |
| 31 | + <meta charset="utf-8" /> |
| 32 | + <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| 33 | + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| 34 | + <title>python-oracledb - Python Driver for Oracle Database</title> |
| 35 | + <link rel="stylesheet" href="base.css" type="text/css" /> |
| 36 | + <link rel="shortcut icon" type="image/ico" href="favicon.ico" /> |
| 37 | +</head> |
| 38 | + |
| 39 | +<body> |
| 40 | + <div class="oracleHeader"> |
| 41 | + <div class="container"> |
| 42 | + <a class="oracleLogo" href="https://www.oracle.com/">Oracle</a> |
| 43 | + </div> |
| 44 | + </div> |
| 45 | + <header class="header" role="banner"> |
| 46 | + <div class="container"> |
| 47 | + <div class="headerLogoContainer"> |
| 48 | + <img class="headerLogo" alt="python-oracledb logo" src="logo.png" /> |
| 49 | + </div> |
| 50 | + <div class="headerContent"> |
| 51 | + <h1 class="headerTitle">Python python-oracledb version 1.0</h1> |
| 52 | + <nav class="headerNav" role="navigation"> |
| 53 | + <ul> |
| 54 | + <li><a href="https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html" >Installation</a></li> |
| 55 | + <li><a href="https://python-oracledb.readthedocs.io/en/latest/index.html">Documentation</a></li> |
| 56 | + <li><a href="https://python-oracledb.readthedocs.io/en/latest/release_notes.html#releasenotes">Release Notes</a></li> |
| 57 | + <li><a href="https://github.com/oracle/python-oracledb">Source code</a></li> |
| 58 | + <li><a href="https://github.com/oracle/python-oracledb/discussions">Help</a></li> |
| 59 | + </ul> |
| 60 | + </nav> |
| 61 | + </div> |
| 62 | + </div> |
| 63 | + |
| 64 | + </header> |
| 65 | + |
| 66 | + <main class="mainContent" role="main"> |
| 67 | + <div class="container"> |
| 68 | + |
| 69 | + <div id="about"> |
| 70 | + <h2>The python-oracledb driver for Oracle Database</h2> |
| 71 | + |
| 72 | + <p> |
| 73 | + |
| 74 | + The <strong>python-oracledb</strong> driver is a <a |
| 75 | + href="https://www.python.org/" >Python programming language</a> |
| 76 | + extension module allowing Python programs to connect to <a |
| 77 | + href="https://www.oracle.com/database/" >Oracle Database</a>. |
| 78 | + Python-oracledb is the new name for Oracle's popular cx_Oracle |
| 79 | + driver. |
| 80 | + |
| 81 | + </p> |
| 82 | + |
| 83 | + <p> |
| 84 | + <img src="./python-oracledb-arch.png"> |
| 85 | + </p> |
| 86 | + |
| 87 | + <p> |
| 88 | + |
| 89 | + The module conforms to the <a |
| 90 | + href="https://peps.python.org/pep-0249/" >Python Database API 2.0 |
| 91 | + specification</a> with a considerable number of additions and a |
| 92 | + couple of minor exclusions, see the <a href="#features" >feature |
| 93 | + list</a>. |
| 94 | + |
| 95 | + </p> |
| 96 | + |
| 97 | + </div> <!-- /about --> |
| 98 | + |
| 99 | + <div id="quickstart"> |
| 100 | + <h2>Getting Started</h2> |
| 101 | + |
| 102 | + <ul> |
| 103 | + |
| 104 | + <li> |
| 105 | + |
| 106 | + <p><a |
| 107 | + href="https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart" |
| 108 | + >Quick Start: Developing Python Applications for Oracle |
| 109 | + Database</a></p> |
| 110 | + |
| 111 | + </li> |
| 112 | + |
| 113 | + <li> |
| 114 | + |
| 115 | + <p><a href=" |
| 116 | + https://oracle.github.io/python-oracledb/samples/tutorial/Python-and-Oracle-Database-The-New-Wave-of-Scripting.html">Python |
| 117 | + and Oracle Database Tutorial: The New Wave of Scripting</a></p> |
| 118 | + |
| 119 | + </li> |
| 120 | + |
| 121 | + <li><p><a |
| 122 | + href="https://github.com/oracle/python-python-oracledb/tree/main/samples" |
| 123 | + >Samples</a></p></li> |
| 124 | + |
| 125 | + </ul> |
| 126 | + |
| 127 | + </div> <!-- /quickstart --> |
| 128 | + |
| 129 | + <div id="installation"> |
| 130 | + <h2>Installation</h2> |
| 131 | + |
| 132 | + <p>See <a |
| 133 | + href="https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html" |
| 134 | + >python-oracledb Installation</a> for detailed instructions.</p> |
| 135 | + |
| 136 | + </div> <!-- /installation --> |
| 137 | + |
| 138 | + <div id="dependencies"> |
| 139 | + |
| 140 | + <h2>Dependencies</h2> |
| 141 | + |
| 142 | + <ul> |
| 143 | + |
| 144 | + <li> |
| 145 | + |
| 146 | + <p><strong>Python versions 3.6 through 3.10</strong>.</p> |
| 147 | + |
| 148 | + <p> Pre-built packages on <a |
| 149 | + href="https://pypi.org/project/oracledb" >PyPI</a> vary with |
| 150 | + Python version support on each operating system.</p> |
| 151 | + |
| 152 | + </li> |
| 153 | + |
| 154 | + <li> |
| 155 | + |
| 156 | + <p><strong>Oracle Client libraries are optional</strong>.</p> |
| 157 | + |
| 158 | + <p><strong>Thin mode</strong>: By default, python-oracledb is a |
| 159 | + 'Thin' driver which connects directly to Oracle Database. This |
| 160 | + mode does not need Oracle Client libraries.</p> |
| 161 | + |
| 162 | + <p><strong>Thick mode</strong>: Some advanced Oracle Database |
| 163 | + functionality is currently only available via Oracle Client |
| 164 | + libraries. You can install these libraries using the free <a |
| 165 | + href="https://www.oracle.com/database/technologies/instant-client.html" |
| 166 | + >Oracle Instant Client</a> packages. Python-oracledb works with |
| 167 | + Oracle Client libraries 11.2 through 21c. See <a |
| 168 | + href="https://python-oracledb.readthedocs.io/en/latest/user_guide/initialization.html#enablingthick" |
| 169 | + >Enabling python-oracledb Thick mode</a>.</p> |
| 170 | + |
| 171 | + </li> |
| 172 | + |
| 173 | + <li> |
| 174 | + |
| 175 | + <p><strong>Oracle Database</strong></p> |
| 176 | + |
| 177 | + <p><strong>Thin mode</strong>: Connects to Oracle Database 12c, |
| 178 | + 18c, 19c and 21c.</p> |
| 179 | + |
| 180 | + <p><strong>Thick mode</strong>: Connects to Oracle Database 11.2, |
| 181 | + 12c, 18c, and 21c, depending on the Oracle Client library |
| 182 | + version. Oracle Database's standard client-server version |
| 183 | + interoperability allows connection to both older and newer |
| 184 | + databases. For example, when python-oracledb uses Oracle Client |
| 185 | + 19c libraries, it can connect to Oracle Database 11.2 or later. |
| 186 | + </p> |
| 187 | + |
| 188 | + </li> |
| 189 | + |
| 190 | + </ul> |
| 191 | + |
| 192 | + </div> <!-- /dependencies --> |
| 193 | + |
| 194 | + <div id="documentation"> |
| 195 | + <h2>Documentation</h2> |
| 196 | + |
| 197 | + <p>See the <a href="https://python-oracledb.readthedocs.io/en/latest/index.html" |
| 198 | + >python-oracledb Documentation</a> and <a |
| 199 | + href="https://python-oracledb.readthedocs.io/en/latest/release_notes.html#releasenotes" |
| 200 | + >Release Notes</a>.</p> |
| 201 | + |
| 202 | + <p>You can use assistive technology products, such as screen readers, |
| 203 | + while you work with the documentation. You can also use the keyboard |
| 204 | + instead of the mouse.</p> |
| 205 | + |
| 206 | + </div> <!-- /documentation --> |
| 207 | + |
| 208 | + <div id="help"> |
| 209 | + <h2>Help</h2> |
| 210 | + |
| 211 | + <p>Questions can be asked on <a |
| 212 | + href="https://github.com/oracle/python-oracledb/discussions" >GitHub |
| 213 | + Discussions</a>. Identified issues can be raised as <a |
| 214 | + href="https://github.com/oracle/python-oracledb/issues" >GitHub |
| 215 | + Issues</a>.</p> |
| 216 | + |
| 217 | + </div> <!-- /help --> |
| 218 | + |
| 219 | + <div id="tests"> |
| 220 | + <h2>Tests</h2> |
| 221 | + |
| 222 | + <p>See the <a href="https://github.com/oracle/python-oracledb/tree/main/test" >test suite</a>.</p> |
| 223 | + |
| 224 | + </div> <!-- /tests --> |
| 225 | + |
| 226 | + <div id="contribuing"> |
| 227 | + <h2>Contributing</h2> |
| 228 | + |
| 229 | + <p>See <a href="https://github.com/oracle/python-oracledb/blob/main/CONTRIBUTING.md" >CONTRIBUTING</a>.</p> |
| 230 | + |
| 231 | + </div> <!-- /contributing --> |
| 232 | + |
| 233 | + <div id="features"> |
| 234 | + |
| 235 | + <h2>Features</h2> |
| 236 | + |
| 237 | + <ul> |
| 238 | + |
| 239 | + <li><p>Easily installed from <a href="https://pypi.org/project/oracledb" |
| 240 | + >PyPI</a>. No additional install is required - you just need an |
| 241 | + available Oracle Database.</p></li> |
| 242 | + |
| 243 | + <li><p>Support for Python 3.6 and higher.</p></li> |
| 244 | + |
| 245 | + <li><p>Optional use of Oracle Client 11.2, 12, 18, 19 or 21 libraries for |
| 246 | + advanced Oracle Database functionality. Oracle's standard cross-version |
| 247 | + interoperability, allows easy upgrades and connectivity to different |
| 248 | + Oracle Database versions.</p></li> |
| 249 | + |
| 250 | + <li><p>Connects to Oracle Database 11.2, 12, 18, 19 or 21 on-premises or |
| 251 | + in the Cloud.</p></li> |
| 252 | + |
| 253 | + <li><p>SQL and PL/SQL Execution with significant optimizations including |
| 254 | + compressed fetch, pre-fetching, client and server result set caching, and |
| 255 | + statement caching with auto-tuning.</p></li> |
| 256 | + |
| 257 | + <li><p>Full use of Oracle Network Service infrastructure, including |
| 258 | + encrypted network traffic and security features.</p></li> |
| 259 | + |
| 260 | + <li><p>Extensive Oracle data type support, including large object |
| 261 | + support (CLOB and BLOB).</p></li> |
| 262 | + |
| 263 | + <li><p>Direct binding to SQL objects. One great use case is binding |
| 264 | + Python objects to Oracle Spatial SDO objects.</p></li> |
| 265 | + |
| 266 | + <li><p>JSON datatype support.</p></li> |
| 267 | + |
| 268 | + <li><p>SODA (Simple Oracle Document Access).</p></li> |
| 269 | + |
| 270 | + <li><p>Array operations for efficient INSERT, UPDATE and MERGE |
| 271 | + execution.</p></li> |
| 272 | + |
| 273 | + <li><p>Array row counts and batch error handling for array operations.</p></li> |
| 274 | + |
| 275 | + <li><p>Fetching of large result sets with easy tuning.</p></li> |
| 276 | + |
| 277 | + <li><p>REF CURSOR support.</p></li> |
| 278 | + |
| 279 | + <li><p>Support for scrollable cursors. Go back and forth through your |
| 280 | + query results.</p></li> |
| 281 | + |
| 282 | + <li><p>Fetch PL/SQL Implicit Results. Easily return query results from |
| 283 | + PL/SQL.</p></li> |
| 284 | + |
| 285 | + <li><p>Row Prefetching. Efficient use of the network.</p></li> |
| 286 | + |
| 287 | + <li><p>Client Result Caching. Improve performance of frequently |
| 288 | + executed look-up statements.</p></li> |
| 289 | + |
| 290 | + <li><p>Support for Advanced Queuing. Use database notifications to |
| 291 | + build micro-service applications.</p></li> |
| 292 | + |
| 293 | + <li><p>Continuous Query Notification (CQN). Get notified when data |
| 294 | + changes.</p></li> |
| 295 | + |
| 296 | + <li><p>Support for Edition Based Redefinition. Easily switch |
| 297 | + applications to use updated PL/SQL logic.</p></li> |
| 298 | + |
| 299 | + <li><p>Support for setting application context during the creation of |
| 300 | + a connection, making application metadata more accessible to the |
| 301 | + database, including in LOGON triggers.</p></li> |
| 302 | + |
| 303 | + <li><p>End-to-end monitoring and tracing.</p></li> |
| 304 | + |
| 305 | + <li><p>Transaction Management.</p></li> |
| 306 | + |
| 307 | + <li><p>Session Pooling, with tagging and session state fix-up callback.</p></li> |
| 308 | + |
| 309 | + <li><p>Database Resident Connection Pooling (DRCP).</p></li> |
| 310 | + |
| 311 | + <li><p>Privileged Connections.</p></li> |
| 312 | + |
| 313 | + <li><p>External Authentication.</p></li> |
| 314 | + |
| 315 | + <li><p>Database startup and shutdown.</p></li> |
| 316 | + |
| 317 | + <li><p>Sharded Database connectivity.</p></li> |
| 318 | + |
| 319 | + <li><p>Oracle Database High Availability Features, such as FAN |
| 320 | + notifications, Application Continuity, and Transaction Guard support.</p></li> |
| 321 | + |
| 322 | + </ul> |
| 323 | + |
| 324 | + <p>Some features above are only available in Thick mode.</p> |
| 325 | + |
| 326 | + <p>Python DB API specification exclusions:</p> |
| 327 | + <ul> |
| 328 | + |
| 329 | + <li><p>The TIME data type is not supported by Oracle Database and is |
| 330 | + therefore not implemented.</p></li> |
| 331 | + |
| 332 | + <li><p>The method <code>cursor.nextset()</code> is not implemented |
| 333 | + because the specification assumes an implementation of cursors that |
| 334 | + does not fit well with Oracle Database's implementation of cursors and |
| 335 | + implicit results. See the method <a |
| 336 | + href="https://python-oracledb.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.getimplicitresults">Cursor.getimplicitresults()</a> |
| 337 | + for the Oracle replacement.</p> |
| 338 | + |
| 339 | + </li> |
| 340 | + |
| 341 | + </ul> |
| 342 | + |
| 343 | + </div> <!-- /features --> |
| 344 | + |
| 345 | + <div id="license"> |
| 346 | + <h2>License</h2> |
| 347 | + |
| 348 | + <p>Python-oracledb license information is in <a |
| 349 | + href="https://github.com/oracle/python-oracledb/blob/main/LICENSE.txt" |
| 350 | + >LICENSE</a>, <a |
| 351 | + href="https://github.com/oracle/python-oracledb/blob/main/THIRD_PARTY_LICENSES.txt" |
| 352 | + >THIRD_PARTY_LICENSES</a> and <a |
| 353 | + href="https://github.com/oracle/python-oracledb/blob/main/NOTICE.txt" |
| 354 | + >NOTICE</a>.</p> |
| 355 | + |
| 356 | + </div> <!-- /license --> |
| 357 | + |
| 358 | + </div> |
| 359 | + </main> |
| 360 | +</body> |
| 361 | + |
| 362 | +</html> |
0 commit comments