How can I access Oracle from Python?
Asked Answered
G

10

40

How can I access Oracle from Python? I have downloaded a cx_Oracle msi installer, but Python can't import the library.

I get the following error:

import cx_Oracle

Traceback (most recent call last):
  File "<pyshell#1>", line 1, in <module>
    import cx_Oracle
ImportError: DLL load failed: The specified module could not be found.

I will be grateful for any help.

Galateah answered 19/8, 2010 at 12:24 Comment(4)
Which cx_Oracle did you download? There are many. Also, which version of Python, which version of Oracle, and which operating system are you using?Furbish
cx_Oracle-5.0.2-10g.win32-py26Galateah
Sounds like it may not be extracted into the PATH python is using to look for modules. Have you tried installing it using easy_install rather than explicitly (it could be missing another dependency).Courier
this specific error means that Oracle client OCI DDLs are compiled for different platform. 32bit vs 64 or Intel vs AMD.Ginoginsberg
T
38

Here's what worked for me. My Python and Oracle versions are slightly different from yours, but the same approach should apply. Just make sure the cx_Oracle binary installer version matches your Oracle client and Python versions.

My versions:

  • Python 2.7
  • Oracle Instant Client 11G R2
  • cx_Oracle 5.0.4 (Unicode, Python 2.7, Oracle 11G)
  • Windows XP SP3

Steps:

  1. Download the Oracle Instant Client package. I used instantclient-basic-win32-11.2.0.1.0.zip. Unzip it to C:\your\path\to\instantclient_11_2
  2. Download and run the cx_Oracle binary installer. I used cx_Oracle-5.0.4-11g-unicode.win32-py2.7.msi. I installed it for all users and pointed it to the Python 2.7 location it found in the registry.
  3. Set the ORACLE_HOME and PATH environment variables via a batch script or whatever mechanism makes sense in your app context, so that they point to the Oracle Instant Client directory. See oracle_python.bat source below. I'm sure there must be a more elegant solution for this, but I wanted to limit my system-wide changes as much as possible. Make sure you put the targeted Oracle Instant Client directory at the beginning of the PATH (or at least ahead of any other Oracle client directories). Right now, I'm only doing command-line stuff so I just run oracle_python.bat in the shell before running any programs that require cx_Oracle.
  4. Run regedit and check to see if there's an NLS_LANG key set at \HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE. If so, rename the key (I changed it to NLS_LANG_OLD) or unset it. This key should only be used as the default NLS_LANG value for Oracle 7 client, so it's safe to remove it unless you happen to be using Oracle 7 client somewhere else. As always, be sure to backup your registry before making changes.
  5. Now, you should be able to import cx_Oracle in your Python program. See the oracle_test.py source below. Note that I had to set the connection and SQL strings to Unicode for my version of cx_Oracle.

Source: oracle_python.bat

@echo off
set ORACLE_HOME=C:\your\path\to\instantclient_11_2
set PATH=%ORACLE_HOME%;%PATH%

Source: oracle_test.py

import cx_Oracle

conn_str = u'user/password@host:port/service'
conn = cx_Oracle.connect(conn_str)
c = conn.cursor()
c.execute(u'select your_col_1, your_col_2 from your_table')
for row in c:
    print row[0], "-", row[1]
conn.close()

Possible Issues:

  • "ORA-12705: Cannot access NLS data files or invalid environment specified" - I ran into this before I made the NLS_LANG registry change.
  • "TypeError: argument 1 must be unicode, not str" - if you need to set the connection string to Unicode.
  • "TypeError: expecting None or a string" - if you need to set the SQL string to Unicode.
  • "ImportError: DLL load failed: The specified procedure could not be found." - may indicate that cx_Oracle can't find the appropriate Oracle client DLL.
Tabriz answered 24/1, 2011 at 16:33 Comment(5)
Does anyone know if this works with other versions (i.e. 3.4? and 64 bit) as long as all the version numbers and platforms are aligned?Terminate
@TheRedPea This has worked for me for version 3.5 and 64 bit.Cubit
I am still struggling with the ImportError: DLL load failed: The specified procedure could not be found. while I am trying to import the cx_Oracle library.Spawn
Thanks for detailed notes. Very helpful!! My understanding is that I need to install Oracle client before I install cx_oracle and connect to database. I am trying to connect to Oracle db in our corporate cluster from my machine, but could not install cx_oracle, shows up this error message: distutils.errors.DistutilsSetupError: cannot locate an Oracle software installation.Dux
Do I really need the Oracle client to have this working? Isn't as simple as a direct JDBC connection? Ty.Dimmer
F
15

Here is how my code looks like. It also shows an example of how to use query parameters using a dictionary. It works on using Python 3.6:

import cx_Oracle

CONN_INFO = {
    'host': 'xxx.xx.xxx.x',
    'port': 12345,
    'user': 'SOME_SCHEMA',
    'psw': 'SECRETE',
    'service': 'service.server.com'
}

CONN_STR = '{user}/{psw}@{host}:{port}/{service}'.format(**CONN_INFO)

QUERY = '''
    SELECT
        *
    FROM
        USER
    WHERE
        NAME = :name
'''


class DB:
    def __init__(self):
        self.conn = cx_Oracle.connect(CONN_STR)

    def query(self, query, params=None):
        cursor = self.conn.cursor()
        result = cursor.execute(query, params).fetchall()
        cursor.close()
        return result


db = DB()
result = db.query(QUERY, {'name': 'happy'})
Francoise answered 23/3, 2018 at 10:44 Comment(0)
A
14

You can use any of the following way based on Service Name or SID whatever you have.

With SID:

import cx_Oracle
dsn_tns = cx_Oracle.makedsn('server', 'port', 'sid')
conn = cx_Oracle.connect(user='username', password='password', dsn=dsn_tns)
c = conn.cursor()
c.execute('select count(*) from TABLE_NAME')
for row in c:
   print(row)
conn.close()

OR

With Service Name:

import cx_Oracle
dsn_tns = cx_Oracle.makedsn('server', 'port', service_name='service_name')
conn = cx_Oracle.connect(user='username', password='password', dsn=dsn_tns)
c = conn.cursor()
c.execute('select count(*) from TABLE_NAME')
for row in c:
   print(row)
conn.close()
Aric answered 10/11, 2018 at 11:44 Comment(0)
A
5
import cx_Oracle
   dsn_tns = cx_Oracle.makedsn('host', 'port', service_name='give service name') 
   conn = cx_Oracle.connect(user='username', password='password', dsn=dsn_tns) 
   c = conn.cursor()
   c.execute('select count(*) from schema.table_name')
for row in c:
   print row
conn.close()

Note :

  1. In (dsn_tns) if needed, place an 'r' before any parameter in order to address any special character such as '\'.

  2. In (conn) if needed, place an 'r' before any parameter in order to address any special character such as '\'. For example, if your user name contains '\', you'll need to place 'r' before the user name: user=r'User Name' or password=r'password'

  3. use triple quotes if you want to spread your query across multiple lines.

Astrophotography answered 5/11, 2018 at 20:34 Comment(0)
M
4

Note if you are using pandas you can access it in following way:

import pandas as pd
import cx_Oracle
conn= cx_Oracle.connect('username/pwd@host:port/service_name')
try:
    query = '''
         SELECT * from dual
             '''
    df = pd.read_sql(con = conn, sql = query)
finally:
    conn.close()
df.head()
Metamorphism answered 15/8, 2018 at 2:48 Comment(0)
L
3

In addition to the Oracle instant client, you may also need to install the Oracle ODAC components and put the path to them into your system path. cx_Oracle seems to need access to the oci.dll file that is installed with them.

Also check that you get the correct version (32bit or 64bit) of them that matches your: python, cx_Oracle, and instant client versions.

Loggins answered 16/3, 2012 at 10:48 Comment(0)
C
2

In addition to cx_Oracle, you need to have the Oracle client library installed and the paths set correctly in order for cx_Oracle to find it - try opening the cx_Oracle DLL in "Dependency Walker" (http://www.dependencywalker.com/) to see what the missing DLL is.

Cask answered 19/8, 2010 at 18:54 Comment(0)
N
2

Ensure these two and it should work:-

  1. Python, Oracle instantclient and cx_Oracle are 32 bit.
  2. Set the environment variables.

Fixes this issue on windows like a charm.

Nanny answered 26/4, 2013 at 11:53 Comment(1)
that was not intentional, not sure how that came in though.Nanny
M
2

If you are using virtualenv, it is not as trivial to get the driver using the installer. What you can do then: install it as described by Devon. Then copy over cx_Oracle.pyd and the cx_Oracle-XXX.egg-info folder from Python\Lib\site-packages into the Lib\site-packages from your virtual env. Of course, also here, architecture and version are important.

Misdemeanor answered 2/4, 2015 at 8:43 Comment(0)
L
2
import cx_Oracle 
from sshtunnel import SSHTunnelForwarder

# remote server variables
remote_ip_address = "<PUBLIC_IP_ADDRESS_OF_DB_SERVER>"
remote_os_username = "<OS_USERNAME>"
ssh_private_key = "<PATH_TO_PRIVATE_KEY>"

# Oracle database variables
database_username = "<DATABASE_USER>"
database_password = "<DATABASE_USER_PASSWORD>"
database_server_sid = "<ORACLE_SID>"

def server_connection():

    server = SSHTunnelForwarder(
             remote_ip_address,
             ssh_username=remote_os_username,
             ssh_password=ssh_private_key,
             remote_bind_address=('localhost', 1521) # default Oracle DB port
    )
    return server

def database_connection():

    data_source_name = cx_Oracle.makedsn("localhost",
                                         server.local_bind_port,
                                         service_name=database_server_sid)

    connection = cx_Oracle.connect(database_username,
                                   database_password,
                                   data_source_name, 
                                   mode=cx_Oracle.SYSDBA) # If logging in with SYSDBA privs,
                                                          # leave out if not.
    return connection

def database_execute():

    connection = database_connection()

    cursor = connection.cursor()
    
    for row in cursor.execute("SELECT * FROM HELLO_WORLD_TABLE"):
        print(row)
    
if __name__ == '__main__':

    server = server_connection()
    server.start()                      # start remote server connection

    connection = database_connection()  # create Oracle database connection

    database_execute()                  # execute query

    connection.close()                  # close Oracle database connection
    server.stop()                       # close remote server connection

If you're accessing the Oracle database via a bastion tunnel, you just need to modify this piece of code:

def server_connection():

server = SSHTunnelForwarder(
         remote_ip_address, # public IP of bastion server
         ssh_username=remote_os_username,
         ssh_password=ssh_private_key,
         remote_bind_address=('localhost', 1521),
         local_bind_address=('0.0.0.0', 3333) # Suppose local bind is '3333'
)
return server
Lasky answered 25/8, 2021 at 21:42 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.