skip to main content
Parameters for all supported Data Store types : Oracle connection parameters : Oracle connection parameters (cloud)
 

Try DataDirect Cloud Now

Oracle connection parameters (cloud)

Watch a video to see how to create and test a connection to Oracle.
The following tables describe parameters available on the tabs of an Oracle cloud Data Source dialog:
*General tab
*OData tab
*Security tab
*Advanced tab

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the Oracle data source setup dialog (cloud)General tab of the Oracle data source setup dialog (cloud)
Table 82. General tab connection parameters for Oracle
Field
Description
Data Source Name
A unique name for this Data Source definition.
Note: Names can contain only alphanumeric characters and underscore.
Description
A description of this set of connection parameters.
Edition Name
The name of the Oracle edition the DataDirect Cloud connectivity service uses when establishing a connection. Oracle 11gR2 and higher allows your database administrator to create multiple editions of schema objects so that your application can still use those objects while the database is being upgraded. This parameter is only valid for Oracle 11g R2 and higher databases and tells the DataDirect Cloud connectivity service which edition of the schema objects to use.
The DataDirect Cloud connectivity service uses the default edition in the following cases:
*When the specified edition is not a valid edition. The DataDirect Cloud connectivity service generates a warning indicating that it was unable to set the current edition to the specified edition.
*When the value for this parameter is not specified or is set to an empty string.
Valid Values:

string
where:
string
is the name of a valid Oracle edition.
Default: empty string
Password
A password for the Oracle account that is used to establish the connection to your Oracle server.
Note: By default, the password is encrypted.
By default, the characters in the Password field you type are not shown. If you want the password to be displayed in clear text, click the eye Watchful eye password button button. Click the button again to conceal the password.
Port Number
The port number on which the Oracle database instance is listening for connections.
Server Name
Specifies either the IP address in IPv4 or IPv6 format, or the server name (if your network supports named servers) of the primary database server, for example, 122.23.15.12 or OracleAppServer.
If using a tnsnames.ora file to provide connection information, do not specify this parameter.
Valid Values: string
where:
string
is a valid IP address or server name.
The IP address can be specified in either IPv4 or IPv6 format, or a combination of the two.
Service Name
The Oracle Service Name that identifies the database on the Oracle server to connect to.
SID
The Oracle SID that identifies the database on the Oracle server to connect to.
Note: Oracle recommends using Oracle Server Name instead of SID.
SysLoginRole
Specifies whether the user is logged on the database with the Oracle system privilege SYSDBA or the Oracle system privilege SYSOPER. For example, you may want the user to be granted the SYSDBA privilege to allow the user to create or drop a database.
Refer to your Oracle documentation for information about which operations are authorized for the SYSDBA and SYSOPER system privileges.
Valid Values:
sysdba | sysoper
If set to sysdba, the user is logged on the database with the Oracle system privilege SYSDBA. The user must be granted SYSDBA system privileges before the connection is attempted by the DataDirect Cloud connectivity service. If not, the DataDirect Cloud connectivity service returns an error and the connection attempt fails.
If set to sysoper, the user is logged on the database with the Oracle system privilege SYSOPER. The user must be granted SYSOPER system privileges before the connection is attempted by the DataDirect Cloud connectivity service. If not, the DataDirect Cloud connectivity service throws an exception and the connection attempt fails.
If this parameter is set to an empty string or is unspecified, the user is logged in without SYSDBA or SYSOPER privileges.
Default: empty string
User Id
The User Id for the Oracle account used to establish the connection to the Oracle server.

Security tab

Click the thumbnail to view the screen.
Security tab of the Oracle data source setup dialog (cloud)Security tab of the Oracle data source setup dialog (cloud)
Table 83. Security tab connection parameters for Oracle
Field
Description
Crypto Protocol Version
Specifies a comma-separated list of the protocol versions that can be used in creating an SSL connection to the Data Source. If the specified protocol is not supported by the database server, the connection fails and the connectivity service returns an error.
Valid Values:
cryptographic_protocol [[, cryptographic_protocol ]...]
where:
cryptographic_protocol
is one of the following cryptographic protocols:
TLSv1 | TLSv1.1 | TLSv1.2
The client must send the highest version that it supports in the client hello.
Note: Good security practices recommend using TLSv1.2 if your data source supports that protocol version, due to known vulnerabilities in the earlier protocols.
Example
Your security environment specifies that you can use TLSv1.1 and TLSv1.2. When you enter the following values, the connectivity service sends TLSv1.2 to the server first:
TLSv1.1,TLSv1.2
Default: TLSv1, TLSv1.1, TLSv1.2
Host Name In Certificate
Specifies a host name for certificate validation. This optional parameter provides additional security against man-in-the-middle (MITM) attacks by ensuring that the server that the DataDirect Cloud connectivity service is connecting to is the server that was requested.
Valid Values:
host_name | #SERVERNAME#
where host_name is a valid host name.
If host_name is specified, the DataDirect Cloud connectivity service compares the specified host name to the DNSName value of the SubjectAlternativeName in the certificate. If a DNSName value does not exist in the SubjectAlternativeName or if the certificate does not have a SubjectAlternativeName, the DataDirect Cloud connectivity service compares the host name with the Common Name (CN) part of the certificate’s Subject name. If the values do not match, the connection fails and the DataDirect Cloud connectivity service throws an exception.
If #SERVERNAME# is specified, the DataDirect Cloud connectivity service compares the server name that is specified in the connection URL or data source of the connection to the DNSName value of the SubjectAlternativeName in the certificate. If a DNSName value does not exist in the SubjectAlternativeName or if the certificate does not have a SubjectAlternativeName, the DataDirect Cloud connectivity service compares the host name to the CN part of the certificate’s Subject name. If the values do not match, the connection fails and the DataDirect Cloud connectivity service throws an exception. If multiple CN parts are present, the DataDirect Cloud connectivity service validates the host name against each CN part. If any one validation succeeds, a connection is established.
Default: Empty string

OData tab

The following table describes the controls on the OData tab. For information on using the Configure Schema editor, see Enabling OData and working with Data Source groups. For information on formulating OData requests, see "Formulating queries" under Querying with OData.
Click the thumbnail to view the screen. Required fields are marked with an asterisk.
OData tabOData tab
Table 84. OData tab connection parameters for Oracle
Field
Description
Access URI
Specifies the base URI for the OData feed to access your DataDirect Cloud data source, for example, https://service.datadirectcloud.com/api/odata. You can copy the URI and paste it into your application's OData configuration.
The URI contains the case-insensitive name of the data source to connect to, and the query that you want to execute. This URI is the OData Service Root URI for the OData feed. The Service Document for the data source is returned by issuing a GET request to the data source's service root.
The OData Service Document returns the names of the entities exposed by the Data Source OData service. To get details such as the properties of the entities exposed, the data types for those properties and the relationships between entities, the Service Metadata Document can be fetched by adding /$metadata to the service root URI.
Schema Map
Enables OData support. If a schema map is not defined, the OData API cannot be used to access the data store using this Data Source definition. Use the Configure Schema editor to select the tables to expose through OData.
See Using the Configure Schema editor for more information.
Data Source Caching
Specifies whether the connection to the backend data source is cached in a session associated with the data source. Caching the back end connection improves performance when multiple OData queries are submitted to the same data source because the connection does not need to be created on every query.
Caching of the back end connection can get in the way when trying to configure a data source for OData. If a change is made to any of the DataDirect Cloud data source connection parameters, those changes will not be seen because the connection was established using the old data source definition, and was cached. The session that caches the backend connection is discarded if there is no activity to the data source for approximately 5 minutes.
When you configure a data source for OData, it is recommended that the OData session caching be disabled. Once you are satisfied with the OData configuration for the data source, enable the parameter to get the performance improvement provided by caching the connection to the backend data source.
Valid Values:
When set to 1, session caching is enabled. This provides better performance for production.
When set to 0, session caching is disabled. Use this value when you are configuring the data source.
Default: 1
Page Size
Determines the number of entities returned on each page for paging controlled on the server side. On the client side, requests can use the $top and $skip parameters to control paging. In most cases, server side paging works well for large data sets. Client side pagination works best with a smaller data sets where it is not as expensive to fetch subsequent pages.
Valid Values: 0 | n
where n is an integer from 1 to 10000.
When set to 0, the server default of 2000 is used.
Default: 0
Refresh Result
Controls what happens when you fetch the first page of a cached result when using Client Side Paging. Skip must be omitted or set to 0. You can use the cached copy of that first page, or you can re-execute the query to get a new result, discarding the previously cached result. Re-executing the query is useful when the data being fetched may change between two requests for the first page. Using the cached result is useful if you are paging back and forth through results that are not expected to change.
Valid Values:
When set to 0, the OData service caches the first page of results.
When set to 1, the OData service re-executes the query.
Default: 1
Inline Count Mode
Specifies how the connectivity service satisfies requests that include the $inlinecount parameter when it is set to allpages. These requests require the connectivity service to include the total number of entities that are defined by the OData query request. The count must be included in the first page in server-driven paging and must be included in every page when using client-driven paging.
The optimal setting depends on the data store and the size of results. The OData service can run a separate query using the count(*) aggregate to get the count, before running the query used to generate the entities. In very large results, this approach can often lead to the first page being returned faster. Alternatively, the OData service can fetch the entire result before returning the first page. This approach works well for small results and for data stores that cannot optimize the count(*) aggregate; however, it may have a longer initial response time for the first page if the result is large.
Valid Values:
When set to 1, the connectivity service runs a separate count(*) aggregate query to get the count of entities before executing the query to return results. In very large results, this approach can often lead to the first page being returned faster.
When set to 2, the connectivity service fetches all entities before returning the first page. For small results, this approach is always faster. However, the initial response time for the first page may be longer if the result is large.
Default: 1
Top Mode
Indicates how requests typically use $top and $skip for client side pagination, allowing the service to better anticipate how to process queries.
Valid Values:
Set to 0 when the application generally uses $top to limit the size of the result and rarely attempts to get additional entities by combining $top and $skip.
Set to 1 when the application uses $top as part of client-driven paging and generally combines $top and $skip to page through the result.
Default: 0
OData Read Only
Controls whether write operations can be performed on the OData service. Write operations generate a 405 Method Not Allowed response if this option is enabled.
Existing OData-enabled data sources are read only (write operations are disabled). To enable write operations for an existing OData enabled data source, clear the OData Read Only option on the OData tab. Then, on the Data Sources tab, regenerate the OData model for the data source by clicking on the OData model icon Synch completed successfully.
Valid Values:
true | false
When the check box is selected (set to true), OData access is restricted to read-only mode.
When the check box is not selected (set to false), write operations can be performed on the OData service.
Default: false

Advanced Tab

Click the thumbnail to view the screen.
Advanced tab of the Oracle data source setup dialog (cloud)Advanced tab of the Oracle data source setup dialog (cloud)
Table 85. Advanced tab connection parameters for Oracle
Field
Description
Bulk Load Options
Enables bulk load protocol options for batch inserts that the DataDirect Cloud connectivity service can take advantage of when EnableBulkLoad is set to a value of true.
This option only applies to connections to Oracle 11g R2 and higher database servers.
Valid Values:
0 | 128
If set to 0 or unspecified, the bulk load operation continues even if a value that can cause an index to be invalidated is loaded.
If set to 128, the NoIndexErrors option stops a bulk load operation when a value that would cause an index to be invalidated is loaded. For example, if a value is loaded that violates a unique or non-null constraint, the DataDirect Cloud connectivity service stops the bulk load operation and discards all data being loaded, including any data that was loaded prior to the problem value.
Default: 0
Catalog Options
Determines which type of metadata information is included in result sets when a JDBC application calls DatabaseMetaData methods.
Valid Values:
0 | 1 | 2 | 3 | 4 | 6 | 8 | 10
If set to 0, result sets do not contain remarks or synonyms.
If set to 1, result sets contain remarks information that is returned from the following DatabaseMetaData methods: getColumns() and getTables().
If set to 2, result sets contain synonyms that are returned from the following DatabaseMetaData methods: getColumns(), getExportedKeys(), getFunctionColumns(), getFunctions(), getImportedKeys(), getIndexInfo(), getPrimaryKeys(), getProcedureColumns(), and getProcedures().
If set to 3, result sets contain both remarks and synonyms (as described for values 1 and 2).
If set to 4 or 6, a hint is provided to the DataDirect Cloud connectivity service to emulate getColumns() calls using the ResultSetMetaData object instead of querying database catalogs for column information. Result sets contain synonyms, but no remarks. If set to 4, synonyms are not returned for getColumns() calls and getTables() or getProcedure() calls. Using emulation can improve performance because the SQL statement that is formulated by the emulation is less complex than the SQL statement that is formulated using getColumns(). The argument to getColumns() must evaluate to a single table. If it does not, because of a wildcard or null value, for example, the DataDirect Cloud connectivity service reverts to the default behavior for getColumns() calls.
If set to 8, result sets contain accurate metadata information for VARRAY, TABLE, and OBJECT data when the following DatabaseMetaData methods are called: getColumns(), getProcedureColumns(), and getFunctionColumns(). Setting this value can negatively impact performance.
If set to 10, results sets contain accurate metadata information for VARRAY, TABLE, and OBJECT data (as described for value 8) and synonyms for other data types (as described for value 2).
Default: 2
Code Page Override
The code page to be used by the DataDirect Cloud connectivity service to convert Character data. The specified code page overrides the default database code page or column collation. All Character data that is returned from or written to the database is converted using the specified code page. This option has no effect on how the DataDirect Cloud connectivity service converts character data to the national character set.
By default, the DataDirect Cloud connectivity service automatically determines which code page to use to convert Character data. Use this parameter only if you need to change the DataDirect Cloud connectivity service’s default behavior.
Valid Values:
utf8 | sjis | enhanced_sjis | enhanced_sjis_oracle | ms932 | euc_jp_solaris
where string is the name of a valid code page that is supported by your JVM. For example, CP950.
If set to utf8, the DataDirect Cloud connectivity service uses the UTF-8 code page to send data to the Oracle server as Unicode. The UTF-8 code page converts data from the Java String format UTF-16 to UTF-8. If you specify this value, the DataDirect Cloud connectivity service forces the value of the WireProtocolMode parameter to 2.
If set to sjis, the DataDirect Cloud connectivity service uses the SHIFT-JIS code page to convert character data to the JA16SJIS character set.
If set to enhanced_sjis, the DataDirect Cloud connectivity service uses the ENHANCED_SJIS code page to convert character data from the Java String format UTF-16 to SJIS as defined by the ICU character conversion library. In addition, it maps the following MS-932 characters to the corresponding SJIS encoding for those characters:
\UFF5E
Wave dash
\U2225
Double vertical line
\UFFE0
Cent sign
\UFF0D
Minus sign
\UFFE1
Pound sign
\UFFE2
Not sign
This value is provided for backward compatibility. Only use this value when the Oracle database character set is SHIFT_JIS.
If set to enhanced_sjis_oracle, the DataDirect Cloud connectivity service uses the ENHANCED_SJIS_ORACLE code page to convert Character data from the Java String format UTF-16 to Oracle’s definition of SJIS. When the DataDirect Cloud connectivity service connects to an Oracle database with a JA16SJIS character set, the DataDirect Cloud connectivity service uses this code page by default. The ENHANCED_SJIS_ORACLE code page is a super set of the MS932 code page. Only use this value when the Oracle database character set is SHIFT_JIS.
If set to ms932, the DataDirect Cloud connectivity service uses the Microsoft MS932 code page to convert Character data from the Java String format UTF-16 to SJIS. This value is provided for backward compatibility because earlier versions of the DataDirect Cloud connectivity service used the MS932 code page when converting Character data to JA16SJIS. Only use this value when the Oracle database character set is SHIFT_JIS.
If set to euc_jp_solaris, the DataDirect Cloud connectivity service uses the EUC_JP_Solaris code page to convert Character data to the EUC_JP character set.
Default: empty string
Enable Bulk Load
Specifies whether to use the bulk load protocol for insert, update, delete, and batch operations. This increases the number of rows that the DataDirect Cloud connectivity service loads to send to the data store. Bulk load reduces the number of network trips.
Valid Values:
true | false
If the check box is selected (true), the DataDirect Cloud connectivity service uses the native bulk load protocols for batch inserts. If the check box is not selected (false), the DataDirect Cloud connectivity service uses the batch mechanism for batch inserts.
Default: false
Extended Options
Specifies a semi-colon separated list of connection options and their values. Use this configuration option to set the value of undocumented connection options that are provided by Progress DataDirect technical support. You can include any valid connection option in the Extended Options string, for example:
Database=Server1;UndocumentedOption1=value[;UndocumentedOption2=value;]
If the Extended Options string contains option values that are also set in the setup dialog, the values of the options specified in the Extended Options string take precedence.
Valid Values: string
Default: empty string
Fetch TSWTZ AsTimestamp
Determines whether column values with the TIMESTAMP WITH TIME ZONE data type are returned as a JDBC CHAR or TIMESTAMP data type.
Valid on Oracle 10g R2 or higher.
Valid Values:
true | false
If the check box is selected (true), column values with the TIMESTAMP WITH TIME ZONE data type are returned as a JDBC TIMESTAMP data type.
If the check box is not selected (false), column values with the TIMESTAMP WITH TIME ZONE data type are returned as a JDBC VARCHAR data type.
Default: false
Initialization String
A semicolon delimited set of commands to be executed on the cloud data store after DataDirect Cloud has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and DataDirect Cloud returns an error indicating which SQL commands failed.
Syntax:
SQLcommand[[; SQLcommand]...]
where:
SQLcommand is a SQL command. Multiple commands must be separated by semicolons.
Default: empty string
Login Timeout
The amount of time, in seconds, that the DataDirect Cloud connectivity service waits for a connection to be established before timing out the connection request.
Valid Values:
0 | x
where x is a positive integer that represents a number of seconds.
If set to 0, the DataDirect Cloud connectivity service does not time out a connection request.
If set to x, the DataDirect Cloud connectivity service waits for the specified number of seconds before returning control to the application and throwing a timeout exception.
Default: 30
Max Pooled Statements
The maximum number of prepared statements to cache for this connection. If the value of this property is set to 20, the connectivity service caches the last 20 prepared statements that are created by the application.
The default value is 0.
Query Timeout
Sets the default query timeout (in seconds) for all statements created by a connection.
Valid Values:
-1 | 0 | x
If set to -1, the query timeout functionality is disabled. The DataDirect Cloud connectivity service silently ignores calls to the Statement.setQueryTimeout() method.
If set to 0, the default query timeout is infinite (the query does not time out).
If set to x, the DataDirect Cloud connectivity service uses the value as the default timeout for any statement that is created by the connection. To override the default timeout value that is set by this parameter, call the Statement.setQueryTimeout() method to set a timeout value for a particular statement.
Default: 0
Report Recycle Bin
Determines whether the DataDirect Cloud connectivity service returns items that are in the Oracle Recycle Bin for the getTables(), getColumns(), and getTablePrivileges() methods. For Oracle 10g R1 and higher, when a table is dropped, it is not actually removed from the database, but is placed in the recycle bin. By default, the DataDirect Cloud connectivity service returns items in the Oracle Recycle Bin.
Valid Values:
true | false
If the check box is selected (true), the DataDirect Cloud connectivity service fetches items contained in the Oracle Recycle Bin.
If the check box is not selected (false), the DataDirect Cloud connectivity service does not return items contained in the Oracle Recycle Bin. Functionally, this means that the DataDirect Cloud connectivity service filters out results whose table name begins with BIN$.
Default: true
Resultset Meta Data Options
Determines whether the DataDirect Cloud connectivity service returns table name information in the ResultSet metadata for Select statements.
Valid Values:
0 | 1
If set to 0 and the ResultSetMetaData.getTableName() method is called, the DataDirect Cloud connectivity service does not perform additional processing to determine the correct table name for each column in the result set. The getTableName() method may return an empty string for each column in the result set.
If set to 1 and the ResultSetMetaData.getTableName() method is called, the DataDirect Cloud connectivity service performs additional processing to determine the correct table name for each column in the result set. The DataDirect Cloud connectivity service returns schema name and catalog name information when the ResultSetMetaData.getSchemaName() and ResultSetMetaData.getCatalogName() methods are called if the DataDirect Cloud connectivity service can determine that information.
Default: 0
Send Float Parameters As String
Determines whether FLOAT, BINARY_FLOAT, and BINARY_DOUBLE parameters are sent to the database server as a string or as a floating point number.
Valid Values:
true | false
If the check box is selected (true), the DataDirect Cloud connectivity service sends FLOAT, BINARY_FLOAT, and BINARY_DOUBLE parameters to the database server as string values.
If the check box is not selected (false), the DataDirect Cloud connectivity service sends FLOAT, BINARY_FLOAT, and BINARY_DOUBLE parameters to the database server as floating point numbers. When Oracle overloaded stored procedures are used, this value ensures that the database server can determine the correct stored procedure to call based on the parameter’s data type.
*Numbers larger than 1.0E127 or smaller than 1.0E-130 cannot be converted to Oracle’s number format for Oracle8i and Oracle9i databases using floating point numbers. When a number larger than 1.0E127 or smaller than 1.0E-130 is encountered, the DataDirect Cloud connectivity service throws an exception. If your application uses numbers in this range against an Oracle8i or Oracle9i database, set this parameter to true.
Default: false
String Params Must Match Char Columns
Determines whether the DataDirect Cloud connectivity service uses ORA_CHAR or ORA_VARCHAR bindings for string parameters in a Where clause. Using ORA_VARCHAR bindings can improve performance, but may cause matching problems for CHAR columns.
Valid Values:
true | false
If the check box is selected (true), the DataDirect Cloud connectivity service uses ORA_CHAR bindings.
If the check box is not selected (false), the DataDirect Cloud connectivity service uses ORA_VARCHAR bindings, which can improve performance. For example, in the following code, if col1 is defined as CHAR(10) and the column name has the string 'abc' in it, the match will fail.

ps = con.prepareStatement("SELECT * FROM employees WHERE col1=?");
ps.setString(1, "abc");
rs = ps.executeQuery();
Default: true
Support Links
Determines whether the DataDirect Cloud connectivity service supports Oracle linked servers, which means a mapping has been defined in one Oracle server to another Oracle server. When Oracle linked servers are supported, the DataDirect Cloud connectivity service does not support distributed transactions.
Valid Values:
true | false
If the check box is selected (true), the DataDirect Cloud connectivity service supports Oracle linked servers but does not support distributed transactions.
If the check box is not selected (false), the DataDirect Cloud connectivity service supports distributed transactions but does not support Oracle linked servers. In most cases, setting this parameter to false provides the best performance.
Default: false
See the steps for:
Creating a Data Source definition