Learn more
 

Use JayDeBeApi to access NetSuite Data in Python


Use standard Python scripting and the development environment of your choice to access live NetSuite data.

Access NetSuite data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for NetSuite and the JayDeBeApi module to work with remote NetSuite data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to NetSuite and visualize NetSuite data with standard Python.

About NetSuite Data Integration

CData provides the easiest way to access and integrate live data from Oracle NetSuite. Customers use CData connectivity to:

  • Access all editions of NetSuite, including Standard, CRM, and OneWorld.
  • Connect with all versions of the SuiteTalk API (SOAP-based) and SuiteQL, which functions like SQL, enabling easier data querying and manipulation.
  • Access predefined and custom reports through support for Saved Searches.
  • Securely authenticate with Token-based and OAuth 2.0, ensuring compatibility and security for all use cases.
  • Use SQL stored procedures to perform functional actions like uploading or downloading files, attaching or detaching records or relationships, retrieving roles, getting extra table or column info, getting job results, and more.

Customers use CData solutions to access live NetSuite data from their preferred analytics tools, Power BI and Excel. They also use CData's solutions to integrate their NetSuite data into comprehensive databases and data warehouse using CData Sync directly or leveraging CData's compatibility with other applications like Azure Data Factory. CData also helps Oracle NetSuite customers easily write apps that can pull data from and push data to NetSuite, allowing organizations to integrate data from other sources with NetSuite.

For more information about our Oracle NetSuite solutions, read our blog: Drivers in Focus Part 2: Replicating and Consolidating ... NetSuite Accounting Data.


Getting Started


Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with NetSuite data in Python using SQL.

The User and Password properties, under the Authentication section, must be set to valid NetSuite user credentials. In addition, the AccountId must be set to the ID of a company account that can be used by the specified User. The RoleId can be optionally specified to log in the user with limited permissions.

See the "Getting Started" chapter of the help documentation for more information on connecting to NetSuite.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the NetSuite JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.netsuite.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:netsuite:Account Id=XABC123456;Password=password;User=user;Role Id=3;Version=2013_1;"

Access NetSuite data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.netsuite.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from NetSuite:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:netsuite:Account Id=XABC123456;Password=password;User=user;Role Id=3;Version=2013_1;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.netsuite.jar" conn = jaydebeapi.connect( "cdata.jdbc.netsuite.NetSuiteDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM SalesOrder;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for NetSuite and start working with your live NetSuite data in Python. Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the NetSuite Driver to get started:

 Download Now

Learn more:

NetSuite Icon NetSuite JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with NetSuite account data including Leads, Contacts, Opportunities, Accounts, and more!

In this article

Related articles