Access Google Cloud Storage Data as a Remote Oracle Database

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for Google Cloud Storage to create a database link from Google Cloud Storage to Oracle and to query Google Cloud Storage data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to Google Cloud Storage as an ODBC Data Source

Information for connecting to Google Cloud Storage follows, along with different instructions for configuring a DSN in Windows and Linux environments.

Authenticate with a User Account

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to "PFXFILE".
• OAuthJWTCert: Set this to the path to the .p12 file you generated.
• OAuthJWTCertPassword: Set this to the password of the .p12 file.
• OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
• OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
• OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
• ProjectId: Set this to the Id of the project you want to connect to.

The OAuth flow for a service account then completes.

Windows

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.

Note: If you need to modify the DSN or create other Google Cloud Storage DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for Google Cloud Storage in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData GoogleCloudStorage Source]
Driver = CData ODBC Driver for Google Cloud Storage
Description = My Description
ProjectId = 'project1'
InitiateOAuth = GETANDREFRESH

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing Google Cloud Storage data just as you would an Oracle database. Set the following properties when working with Google Cloud Storage data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

• MapToWVarchar=False

  Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

• MaximumColumnSize=4000

  Set this property to restrict the maximum column size to 4000 characters.

• IncludeDualTable=True

  Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-googlecloudstorage/lib/cdata.odbc.googlecloudstorage.ini in a text editor and set the encoding.

cdata.odbc.googlecloudstorage.ini

[Driver]
DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to Google Cloud Storage data that enables you to query live Google Cloud Storage data as an Oracle database.

1. Create the file initmygooglecloudstoragedb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

   initmygooglecloudstoragedb.ora

   HS_FDS_CONNECT_INFO = "CData GoogleCloudStorage Sys"

2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

   If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   SID_LIST_LISTENER =
    (SID_LIST =
    (SID_DESC =
    (SID_NAME = mygooglecloudstoragedb)
    (ORACLE_HOME = your-oracle-home)
    (PROGRAM = dg4odbc)
    )
    )
   

   If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   SID_LIST_LISTENER =
    (SID_LIST =
    (SID_DESC =
    (SID_NAME = mygooglecloudstoragedb)
    (ORACLE_HOME = your-oracle-home)
    (PROGRAM = hsodbc)
    )
    )
   

3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

   tnsnames.ora

   mygooglecloudstoragedb =
    (DESCRIPTION=
    (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))
    (CONNECT_DATA=(SID=mygooglecloudstoragedb))
    (HS=OK)
    ) 
   

4. Restart the listener.

5. Test the configuration with the following command:

   tnsping mygooglecloudstoragedb

6. Open SQL*Plus and create the database link with the command below:

   CREATE DATABASE LINK mygooglecloudstoragedb CONNECT TO "user" IDENTIFIED BY "password" USING 'mygooglecloudstoragedb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "Buckets"@mygooglecloudstoragedb WHERE Name = 'TestBucket';