Connect to NetSuite Data in Ruby



Connect to NetSuite data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for NetSuite makes it easy to integrate connectivity to live NetSuite data in Ruby. This article shows how to create a simple Ruby app that connects to NetSuite data, executes a query, and displays the results.

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


Create an ODBC Connection to NetSuite Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby App with Connectivity to NetSuite Data

Create a new Ruby file (for example: NetSuiteSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN require 'dbi' cnxn = DBI.connect('DBI:ODBC:CData NetSuite Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Customer.FirstName AS CustomerName, SalesOrder.Total AS SalesOrderTotal FROM SalesOrder, Customer") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

With the file completed, you are ready to display your NetSuite data with Ruby. To do so, simply run your file from the command line:

ruby NetSuiteSelect.rb Writing SQL-92 queries to NetSuite allows you to quickly and easily incorporate NetSuite data into your own Ruby applications. Download a free trial today!

Ready to get started?

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

 Download Now

Learn more:

NetSuite Icon NetSuite ODBC Driver

The NetSuite ODBC Driver is a powerful tool that allows you to connect with live NetSuite data, directly from any applications that support ODBC connectivity.

Access NetSuite like you would a database - read, write, and update Leads, Contacts, Opportunities, Accounts, etc. through a standard ODBC Driver interface.