Learn more
 

Connect to AlloyDB Data in Ruby


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

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

Create an ODBC Connection to AlloyDB 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 following connection properties are usually required in order to connect to AlloyDB.

  • Server: The host name or IP of the server hosting the AlloyDB database.
  • User: The user which will be used to authenticate with the AlloyDB server.
  • Password: The password which will be used to authenticate with the AlloyDB server.

You can also optionally set the following:

  • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
  • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

Authenticating with Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

Authenticating with pg_hba.conf Auth Schemes

There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

Find instructions about authentication setup on the AlloyDB Server here.

Authenticating with MD5 Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

Authenticating with SASL Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

Authenticating with Kerberos

The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

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 AlloyDB Data

Create a new Ruby file (for example: AlloyDBSelect.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 AlloyDB Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'") #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 AlloyDB data with Ruby. To do so, simply run your file from the command line:

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

Ready to get started?

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

 Download Now

Learn more:

AlloyDB Icon AlloyDB ODBC Driver

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

Access AlloyDB data like you would a database - read, write, and update AlloyDB 0, etc. through a standard ODBC Driver interface.

In this article

Related articles