Oracle parameters

Data Source Name

A unique name for the data source. Data source names can contain only alphanumeric characters, underscores, and dashes.

Description

A general description of the data source.

User Id

The User Id for the Oracle account used to establish the connection to the Oracle server.

Password

A password for the Oracle account that is used to establish the connection to your Oracle server.

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:

The IP address can be specified in either IPv4 or IPv6 format, or a combination of the two.

Port Number

The port number on which the Oracle database instance is listening for connections.

Connector ID

The unique identifier of the On-Premise Connector that is to be used to access the on-premise data source. Select the Connector that you want to use from the dropdown. The identifier can be a descriptive name, the name of the machine where the Connector is installed, or the Connector ID for the Connector.

If you have not installed an On-Premise Connector, and no Connectors have been shared with you, this field and drop-down list are empty.

If you own multiple Connectors that have the same name, for example, Production, an identifier is appended to each Connector, for example, Production_dup0 and Production_dup1. If the Connectors in the dropdown were shared with you, the owner's name is appended, for example, Production(owner1) and Production(owner2).

Edition Name

The name of the Oracle edition the Hybrid Data Pipeline 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 connectivity service which edition of the schema objects to use.

The Hybrid Data Pipeline connectivity service uses the default edition in the following cases:

Valid values:

where:

Default: empty string

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.

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:

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 Hybrid Data Pipeline connectivity service. If not, the 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 Hybrid Data Pipeline connectivity service. If not, the 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

TNS Names File

Specifies the name of the TNSNAMES.ORA file. In a TNSNAMES.ORA file, connection information for Oracle services is associated with an Oracle net service name. The entry in the TNSNAMES.ORA file specifies Host, Port Number, and Service Name or SID.

TNSNames File is ignored if no value is specified in the Server Name option. If the Oracle Server Name option is specified but the TNSNames File option is left blank, the TNS_ADMIN environment setting is used for the TNSNAMES.ORA file path. If there is no TNS_ADMIN setting, the ORACLE_HOME environment setting is used. On Windows, if ORACLE_HOME is not set, the path is taken from the Oracle section of the Registry.

Using an Oracle TNSNAMES.ORA file to centralize connection information in your Oracle environment simplifies maintenance when changes occur. If, however, the TNSNAMES.ORA file is unavailable, then it is useful to be able to open a backup version of the TNSNAMES.ORA file (TNSNames file failover). You can specify one or more backup, or alternate, TNSNAMES.ORA files.

Valid values:

path_filename

where:

To specify multiple TNSNAMES.ORA file locations, separate the names with a comma and enclose the locations in parentheses (you do not need parentheses for a single entry). For example:

The Hybrid Data Pipeline connectivity service tries to open the first file in the list. If that file is not available, then it tries to open the second file in the list, and so on.

TNS Server Name

Specifies the name of the set of connection information in the tnsnames.ora file to use to establish the connection.

Data Integrity Level

Determines the level of Oracle Advanced Security data integrity used for data sent between the Hybrid Data Pipeline connectivity service and database server. The connection fails if the database server does not have a compatible integrity algorithm.

Valid values:

If set to rejected, the Hybrid Data Pipeline connectivity service does not enable a data integrity check for data sent between the connectivity service and database server. The connection fails if the database server specifies REQUIRED.

If set to accepted, the Hybrid Data Pipeline connectivity service enables a data integrity check for data sent between the connectivity service and database server if the database server requests or requires it.

If set to requested, the Hybrid Data Pipeline connectivity service enables a data integrity check for data sent between the connectivity service and database server if the database server permits it.

If set to required, the Hybrid Data Pipeline connectivity service performs a data integrity check for data sent between the connectivity service and database server. The database server must have data integrity check enabled. The connection fails if the database server specifies REJECTED.

Default: accepted

Data Integrity Types

Determines the method the Hybrid Data Pipeline connectivity service uses to protect against attacks that intercept and modify data being transmitted between the client and server. You can enable data integrity protection without enabling encryption.

Valid values:

where:

Default: SHA1,MD5 (a list of all possible values)

Encryption Level

Determines whether data is encrypted and decrypted when transmitted over the network between the Hybrid Data Pipeline connectivity service and database server using Oracle Advanced Security encryption.

Valid values:

If set to rejected, data sent between the Hybrid Data Pipeline connectivity service and the database server is not encrypted or decrypted. The connection fails if the database server specifies REQUIRED.

If set to accepted, data sent between the Hybrid Data Pipeline connectivity service and the database server is encrypted and decrypted if the database server requests or requires it.

If set to requested, data sent between the Hybrid Data Pipeline connectivity service and the database server is encrypted and decrypted if the database server permits it.

If set to required, data sent between the Hybrid Data Pipeline connectivity service and the database server must be encrypted and decrypted. The connection fails if the database server specifies REJECTED.

Default: accepted

Encryption Method

Determines whether data is encrypted and decrypted when transmitted over the network between the Hybrid Data Pipeline connectivity service and the on-premise database server.

Valid values:

If set to noEncryption, data is not encrypted or decrypted.

If set to SSL, data is encrypted using SSL. If the database server does not support SSL, the connection fails and the Hybrid Data Pipeline connectivity service throws an exception.

The default value is noEncryption.

Encryption Types

Specifies a comma-separated list of the encryption algorithms to use if Oracle Advanced Security encryption is enabled using the Encryption Level parameter.

Valid values:

Example

Your security environments specifies that you can use AES with a 192-bit key size or two-key Triple-DES with an effective key size of 112-bit. Use the following values:

The default value is an empty string.

Host Name In Certificate

Specifies a host name for certificate validation when SSL encryption is enabled (Encryption Method=SSL) and validation is enabled (Validate Server Certificate=ON). This optional parameter provides additional security against man-in-the-middle (MITM) attacks by ensuring that the server that the Hybrid Data Pipeline connectivity service is connecting to is the server that was requested.

Valid values:

where host_name is a valid host name.

If host_name is specified, the Hybrid Data Pipeline 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 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 connectivity service throws an exception.

If #SERVERNAME# is specified, the Hybrid Data Pipeline 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 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 connectivity service throws an exception. If multiple CN parts are present, the connectivity service validates the host name against each CN part. If any one validation succeeds, a connection is established.

Default: Empty string

Validate Server Certificate

Determines whether the Hybrid Data Pipeline connectivity service validates the certificate that is sent by the database server when SSL encryption is enabled (Encryption Method=SSL). When using SSL server authentication, any certificate that is sent by the server must be issued by a trusted Certificate Authority (CA). Allowing the connectivity service to trust any certificate that is returned from the server even if the issuer is not a trusted CA is useful in test environments because it eliminates the need to specify truststore information on each client in the test environment.

Valid values:

If set to ON, the Hybrid Data Pipeline connectivity service validates the certificate that is sent by the database server. Any certificate from the server must be issued by a trusted CA in the truststore file. If the Host Name In Certificate parameter is specified, the connectivity service also validates the certificate using a host name. The Host Name In Certificate parameter is optional and provides additional security against man-in-the-middle (MITM) attacks by ensuring that the server the connectivity service is connecting to is the server that was requested.

If set to OFF, the Hybrid Data Pipeline connectivity service does not validate the certificate that is sent by the database server. The connectivity service ignores any truststore information that is specified by the Java system properties.

Default: ON

OData Version

Enables you to choose from the supported OData versions. OData configuration made with one OData version will not work if you switch to a different OData version. If you want to maintain the data source with different OData versions, you must create different data sources for each of them.

OData Access URI

Specifies the base URI for the OData feed to access your data source, for example, https://hybridpipe.operations.com/api/odata/<DataSourceName>. 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/columns and/or functions to expose through OData.

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 $count parameter when it is set to true (for OData version 4) or the $inlinecount parameter when it is set to allpages (for OData version 2). 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.

Valid Values:

ON | OFF

When ON is selected, OData access is restricted to read-only mode.

When OFF is selected, write operations can be performed on the OData service.

Default: OFF

Bulk Load Options

Enables bulk load protocol options for batch inserts that the Hybrid Data Pipeline connectivity service can take advantage of when EnableBulkLoad is set to a value of ON.

This option only applies to connections to Oracle 11g R2 and higher database servers.

Valid values:

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 Hybrid Data Pipeline 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:

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 Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 Hybrid Data Pipeline connectivity service converts character data to the national character set.

By default, the Hybrid Data Pipeline connectivity service automatically determines which code page to use to convert Character data. Use this parameter only if you need to change the connectivity service’s default behavior.

Valid values:

where string is the name of a valid code page that is supported by your JVM. For example, CP950.

If set to utf8, the Hybrid Data Pipeline 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 Hybrid Data Pipeline connectivity service forces the value of the WireProtocolMode parameter to 2.

If set to sjis, the Hybrid Data Pipeline connectivity service uses the SHIFT-JIS code page to convert character data to the JA16SJIS character set.

If set to enhanced_sjis, the Hybrid Data Pipeline 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:

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 Hybrid Data Pipeline 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 connectivity service connects to an Oracle database with a JA16SJIS character set, the Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 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 Hybrid Data Pipeline 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 Hybrid Data Pipeline connectivity service loads to send to the data store. Bulk load reduces the number of network trips.

Valid values:

If set to ON, the Hybrid Data Pipeline connectivity service uses the native bulk load protocols for batch inserts.

If set to OFF, the connectivity service uses the batch mechanism for batch inserts.

Default: OFF

Extended Options

Specifies a semi-colon delimited 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 as Timestamp

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:

If set to ON, column values with the TIMESTAMP WITH TIME ZONE data type are returned as a JDBC TIMESTAMP data type.

If set to OFF, column values with the TIMESTAMP WITH TIME ZONE data type are returned as a JDBC VARCHAR data type.

Default: OFF

Initialization String

A semicolon delimited set of commands to be executed on the data store after Hybrid Data Pipeline has established and performed all initialization for the connection. If the execution of a SQL command fails, the connection attempt also fails and Hybrid Data Pipeline 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

LOB Prefetch Size

Specifies the size of prefetch data the server returns for BLOBs and CLOBs during a fetch operation.

Valid Values: -1 | 0 | x

where x is a positive integer that represents the size of a BLOB in bytes or a CLOB in characters.

If set to -1, the property is disabled.

If set to 0, the server returns only LOB meta-data such as length and chunk size with the LOB locator.

If set to x, the server returns LOB meta-data and the beginning of LOB data with the LOB locator.

Default: 4000

Login Timeout

The amount of time, in seconds, that the Hybrid Data Pipeline connectivity service waits for a connection to be established before timing out the connection request.

Valid values:

where x is a positive integer that represents a number of seconds.

If set to 0, the Hybrid Data Pipeline connectivity service does not time out a connection request.

If set to x, the Hybrid Data Pipeline 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 Hybrid Data Pipeline 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:

where x is a positive integer that represents a number of seconds.

If set to -1, the query timeout functionality is disabled. The Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 Hybrid Data Pipeline 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 connectivity service returns items in the Oracle Recycle Bin.

Valid values:

If set to ON, the Hybrid Data Pipeline connectivity service fetches items contained in the Oracle Recycle Bin.

If set to OFF, the Hybrid Data Pipeline connectivity service does not return items contained in the Oracle Recycle Bin. Functionally, this means that the Hybrid Data Pipeline connectivity service filters out results whose table name begins with BIN$.

Default: ON

Result Set Meta Data Options

Determines whether the Hybrid Data Pipeline connectivity service returns table name information in the ResultSet metadata for Select statements.

Valid values:

If set to 0 and the ResultSetMetaData.getTableName() method is called, the Hybrid Data Pipeline 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 Hybrid Data Pipeline connectivity service performs additional processing to determine the correct table name for each column in the result set. The connectivity service returns schema name and catalog name information when the ResultSetMetaData.getSchemaName() and ResultSetMetaData.getCatalogName() methods are called if the 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:

If set to ON, the Hybrid Data Pipeline connectivity service sends FLOAT, BINARY_FLOAT, and BINARY_DOUBLE parameters to the database server as string values.

If set to OFF), the Hybrid Data Pipeline 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.

Default: OFF

String Params Must Match Char Columns

Determines whether the Hybrid Data Pipeline 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:

If set to ON, the Hybrid Data Pipeline connectivity service uses ORA_CHAR bindings.

If set to OFF, the Hybrid Data Pipeline 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.

Default: ON

Support Links

Determines whether the Hybrid Data Pipeline 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 connectivity service does not support distributed transactions.

Valid values:

If set to ON, the Hybrid Data Pipeline connectivity service supports Oracle linked servers but does not support distributed transactions.

If set to OFF, the Hybrid Data Pipeline connectivity service supports distributed transactions but does not support Oracle linked servers. In most cases, setting this parameter to OFF provides the best performance.

Default: OFF

Metadata Exposed Schemas

Restricts the metadata exposed by Hybrid Data Pipeline to a single schema. The metadata exposed in the SQL Editor, the Configure Schema Editor, and third party applications will be limited to the specified schema. JDBC, OData, and ODBC metadata calls will also be restricted. In addition, calls made with the Schema API will be limited to the specified schema.

Valid Values

Where:

is the name of a valid schema on the backend data store.

Default: No schema is specified. Therefore, all schemas are exposed.