Location Properties

Name of the Azure Data Lake Storage Gen2 storage account.

Authentication method for connecting HVR to Azure Data Lake Storage (ADLS) Gen2 server.

Available options for method are:

• SHARED_KEY
• CLIENT_CREDS
• USER_PASS
• MSI
• REFRESH_TOKEN
  

Authentication method for connecting HVR to Azure Data Lake Storage Gen1 server.

Available options for method are:

• CLIENT_CREDS
• MSI
• REFRESH_TOKEN

Service name of the Oracle RAC database available on the remote server.

TCP/IP port number of the HVR Agent. This is used for connecting HVR Hub to the HVR Agent.

The SSL public certificate file for the HVR Agent.

Describes the filename format (template) of the transaction log archive files stored in the directory specified by the Archive_Log_Path property.

The list of supported format variables and the default format string are database-specific.

HVR will search for the transaction log archives in the specified directory (path) dir.

The behavior of this property is database-specific.

Access key ID of IAM user for connecting HVR to Amazon S3.

This property is used together with AWS_Secret_Access_Key when connecting HVR to Amazon S3 using IAM User Access Keys.

AWS IAM role name for connecting HVR to Amazon S3.

Secret access key of IAM user for connecting HVR to Amazon S3.

• HTTP

Client ID (or application ID) used to obtain Microsoft Entra ID (formerly Azure Active Directory) access token.

Secret key of the Azure_OAuth2_Client_Id.

URL used for obtaining the bearer token with credential token.

Ensure that you are using the OAuth 2.0 endpoint. The URL path should include v2.0. The format for the endpoint URL is https://login.microsoftonline.com/tenant/oauth2/v2.0/token

This property is required only if the authentication method (ABFS_Authentication_Method or ADL_Authentication_Method or SqlServer_Authentication_Method) is set to CLIENT_CREDS.

Port number for the REST endpoint of the token service exposed to localhost by the identity extension in the Azure VM. The default value for this property is 50342.

URL for the REST endpoint of the token service exposed to localhost by the identity extension in the Azure VM.

Directory path to the text file containing the refresh token.

Username for the OAuth 2.0 authentication.

Access key of the Azure storage account.

For Azure Data Lake Storage, this property is required only if the authentication method (ABFS_Authentication_Method) is set to SHARED_KEY.

Geographic location of the dataset. For more information about dataset locations, refer to Dataset Locations in BigQuery Documentation.

Checkpointing frequency in seconds for long running transactions, so the capture job can recover quickly when it restarts. Value secs is the interval (in seconds) at which the capture job creates checkpoints.

Thedefaultcheckpoint frequency is 300 seconds (5 minutes). If value 0 is set, checkpoints are not written.

Without checkpoints, capture jobs must rewind back to the start of the oldest open transaction, which can take a long time and may require access too many old DBMS log files (e.g. archive files).

The checkpoints are written into the HVR_CONFIG/hubs/hub/channels/channel/locs/location/capckp directory. If a transaction continues to make changes for a long period then successive checkpoints will not rewrite its same changes each time; instead the checkpoint will only write new changes for that transaction; for older changes it will reuse files written by earlier checkpoints.

Checkpoints are written only for long-running transactions. For example, if the checkpoint frequency is each 5 minutes but users always do an SQL commit within 4 minutes then checkpoints will never be written. However, if users keep transactions open for 10 minutes, then those transactions will be saved but shorter-lived ones in the same period will not.

The frequency with which capture checkpoints are written is relative to the capture jobs own clock, but it decides whether a transaction has been running long enough to be checkpointed by comparing the timestamps in its DBMS logging records. As a consequence, the maximum (worst-case) time that an interrupted capture job would need to recover (rewind back over all its open transactions) is its checkpoint frequency plus the amount of time it takes to reread the amount of changes that the DBMS can write in that period of time.

When a capture job is recovering it will only use checkpoints which were written before the 'capture cycle' was completed. This means that very frequent capture checkpointing (say every 10 seconds) is wasteful and will not speed up capture job recovery time.

Retains capture checkpoint files up to the specified period secs (in seconds).

The retained checkpoint files are saved in the HVR_CONFIG/hubs/hub/channels/channel/locs/location/capckpretain directory.

Storage location of capture checkpoint files for quick capture recovery.

Available options for storare:

• LOCATIONdefault: Checkpoint files are saved in a directory on capture location.
• HUB: Checkpoint files are saved in a directory on hub server.
  Writing checkpoints on the hub is more expensive because extra data must be sent across the network. When capturing changes from an Oracle RAC, the checkpoint files should be stored on the hub server because the directory on the remote location where the capture job would otherwise write checkpoints may not be shared inside the RAC cluster, so it may not be available when the capture job restarts.

For both the storage locations, the checkpoint files are saved in the HVR_CONFIG/hubs/hub/channels/channel/locs/location/capckp directory.

When the capture job is restarted and if it cannot find the most recent checkpoint files (perhaps the contents of that directory have been lost during a failover) then it will write a warning and rewind back to the start of the oldest open transaction..

On busy systems, it is recommended to change this parameter only when there are no existing capture checkpoints, otherwise, there can be performance costs and superfluous warnings when the capture job starts for the first time with new settings.

Method of reading/capturing changes from the DBMS log file.

This property is supported only for location types from which HVR can capture changes. For the list of supported location types, see Capture changes from location in Capabilities.

Valid values for method are:

• DIRECTdefault: Reads transaction log records directly from the DBMS log file using file I/O. This method is generally faster and more efficient than the SQL mode. The DIRECT log read method requires that HVR Agent is installed on the source database server.
  
  For SQL Server, this capture method requires Windows Administrator privileges, and reduced permission models are not supported.

  This capture method is supported only for certain location types. For the list of supported location types, see Direct access to logs on a file system in Capabilities.

• SQL: Reads transaction log records using a special SQL function. The advantage of this method is that it reads change data over an SQL connection and does not require an HVR Agent to be installed on the source database server. The disadvantages of the SQL method is that it is slower than the DIRECT method and exposes additional load on the source database.
  
  For SQL Server, this capture method supports reduced permission models but it may require incomplete row augmenting.

  This capture method is supported only for certain location types. For the list of supported location types, see Access to logs using SQL interface in Capabilities. For Oracle, the corresponding method is called LOGMINER.

• LOGMINER: Reads data using Oracle's LogMiner. The advantage of this method is that it reads change data over an SQL connection and does not require an HVR Agent to be installed on the source database server. The disadvantages of the LOGMINER method is that it is slower than the DIRECT method and exposes additional load on the source database.

  This capture method is supported only for Oracle.

  Capture from Oracle using the LOGMINER method will be deprecated in one of the future HVR 6 releases. We encourage you to consider migrating to BFILE or DIRECT capture methods.

• BFILESince v6.1.0/2: reads Oracle's redo and archive log files through directory objects. HVR first tries to access the redo or archive log files through the existing directory objects or creates a new directory object if it do not exist. This method is comparable in speed with the DIRECT and SQL capture methods. The BFILE method does not require the HVR Agent to be installed on the source database machine.

  This capture method is supported only for Oracle.

• ARCHIVE_ONLY: Reads data from the archived redo files in directory defined using Archive_Log_Path property and do not read anything from online redo files or the 'primary' archive destination. This allows the HVR process to reside on a different server than the Oracle DBMS or SQL Server and read changes from files that are sent to it by some remote file copy mechanism (e.g. FTP). The capture job still needs an SQL connection to the database for accessing dictionary tables, but this can be a regular connection.

  Replication in this capture method can have longer delays in comparison with the 'online' mode.

  For Oracle, to control the delays it is possible to force Oracle to issue an archive once per predefined period of time.

  For Oracle RAC systems, delays are defined by the slowest or the least busy node. This is because archives from all threads have to be merged by SCNs in order to generate replicated data flow.

  This capture method is supported only for certain location types. For the list of supported location types, see Capture from Archive log files only in Capabilities.

• DB_TRIGGER: Capture changes through DBMS triggers generated by HVR, instead of using log-based capture.

  In HVR UI, when creating a location, the option Database Triggers is displayed only if HVR detects database triggers in the connected database. This option can also be manually enabled by executing the following command:

  hvruserconfig user_name Show_Deprecated_Features=true

  This capture method is supported only for certain location types. For the list of supported location types, see Trigger-based capture in Capabilities.

  The trigger-based capture method has been deprecated since 6.2.0/0.

Normally, HVR converts the DBMS table names to lowercase and treats table and column names as case insensitive.

If set to true, DBMS table names and column names are treated case sensitive by HVR.

Defining this property allows the replication of tables with mixed case names or tables whose names do not match the DBMS case convention. For example, normally an Oracle table name is held in uppercase internally (e.g. MYTAB), so this property is needed to replicate a table named mytab or MyTab.

This property is supported only for certain location types. For the list of supported location types, see Treat DBMS table names and columns case sensitive in Capabilities.

This is a discovered property that stores the flavor of the specific database Class. The combination of Class and Class_Flavor forms the location type.

Time zone for the Databricks location. Specifying value in this property ensures that the time zone of the HVR Agent and the Databricks database match. It is not required to define this property if the time zone is UTC.
This parameter is applicable only for Databricks target locations.

Example: America/Los_Angeles

Directory path where the .pem file containing the client's SSL private key is located.

This property is required for enabling two way SSL.

Password of the client's SSL private key specified in Database_Client_Private_Key.

This property is required for enabling two way SSL.

Directory path where the .pem file containing the client's SSL public certificate is located.

This property is required for enabling two way SSL.

This is a discovered property that stores the default case used in the database.

Available values:

• upper: Indicates uppercase.
• lower: Indicates lowercase.
• preserve: Indicates mixed case (both lower and upper cases).

Hostname or IP-address of the server on which the database is running.

Name of the database.

For Db2 for i, this is the named database in Db2 for i. It could be on another (independent) auxiliary storage pool (IASP). The user profile's default setting will be used when no value is specified. Specifying *SYSBAS will connect a user to the SYSBAS database.

For Db2 for LUW and Db2 for z/OS, the following formats are supported for this property:

• alias for the database in Db2 for LUW or Db2 for z/OS
• database:server:port
  • database is the name of the database in Db2 for LUW or Db2 for z/OS
  • server can either be a hostname or an IP-address of the database server
  • port is the TCP/IP port used for connecting to the database server

For BigQuery, this is the name of the dataset in Google BigQuery.

For HANA, this is the name of the specific database in a multiple-container environment.

Port number on which the database (defined in Database_Host) server is expecting connections.

Directory path where the .pem file containing the server's public SSL certificate signed by a trusted CA is located.

Defining this property will enable (one way) SSL, which means, HVR will authenticate the Hive server by validating the SSL certificate shared by the Hive server.

This property is also required for enabling two way SSL.

Name of the default schema to be used for this connection.

Username for connecting HVR to the database (defined in Database_Name).

For Azure SQL Database, this is the user name and host name of the Azure SQL Database server. The format to be used is username@hostname.

For Sybase ASE, this property can be used only if the Sybase_Authentication_Method is set to USER_PASS.

For Teradata, this is the username for connecting HVR to the Teradata Node.

Catalog name in a Unity Catalog metastore. If the target database is implemented in the Unity Catalog, and if this property is not defined, Databricks will use the default catalog hive_metastore.

Client ID of your service principal, used to obtain the OAuth access token.

Secret key associated with the Databricks_Client_Id of your service principal. The key is used in combination with the Databricks_Client_Id to authenticate and obtain the OAuth access token.

Path for the external tables in Databricks.

For staging on AWS S3, this can be a mount path /mnt/... (optionally prefixed with dbfs:) or an s3:// URL.

For staging on ADLS, this can be a mount path /mnt/... (optionally prefixed with dbfs:) or an abfss:// URL.

For staging on GCS, this can be a mount path /mnt/... (optionally prefixed with dbfs:) or an gs:// URL.

URL (abfss://) for the external tables in Databricks.

URL (gs://) for the external tables in Databricks.

URL (s3s://) for the external tables in Databricks.

Databricks personal access token for your workspace.

Since HVR versions 6.2.0/2 and 6.1.0/64, it is not required to define this location property for capturing changes from journal.

When using "Db2 client or Db2 server or Db2 Connect", the name of the Db2 instance must be specified.

When using "IBM Data Server Driver for ODBC and CLI" this property should not be defined.

When using "Db2 client or Db2 server or Db2 Connect" the directory path of the Db2 installation must be specified.

When using "IBM Data Server Driver for ODBC and CLI" the directory path of the IBM Data Server Driver for ODBC and CLI installation on an HVR machine (e.g. /distr/db2/driver/odbc_cli/clidriver) must be specified.

Enable/disable (one way) SSL. If set to true, HVR authenticates the location connection by validating the SSL certificate shared by the database server.

For SSL connection configuration requirements on Linux, see Configuration for SSL connection on Linux.

Directory path where the files are replicated to or captured from.

For Amazon S3, this is the directory path in the S3 BUCKET where the files are replicated to or captured from.

For Azure Blob Storage, this is the directory path in the container (defined in WASB_Container) where the files are replicated to or captured from.

For Azure Data Lake Storage Gen1, this is the directory path where the files are replicated to or captured from.

For Azure Data Lake Storage Gen2, this is the directory path in container (defined in ABFS_Container) where the files are replicated to or captured from.

Host name of the proxy server used for connecting HVR to the file server (defined in File_Host).

Password for the File_Proxy_User.

Port number for the proxy server (defined in File_Proxy_Host) used for connecting HVR to the file server (File_Host).

Protocol for the proxy server (defined in File_Proxy_Host) used for connecting HVR to the file server (defined in File_Host).

Available options for protocol are:

• HTTP
• SOCKS4
• SOCKS4A
• SOCKS5
• SOCKS5H

Username for the proxy server (defined in File_Proxy_Host) used for connecting HVR to the file server (defined in File_Host).

Protocol for connecting HVR to the file server (defined in File_Host).

The options available/supported for protocol are location type-specific.

Directory path for internal state files used by HVR during file replication.

By default these files are created in sub-directory _hvr_state which is created inside the file location top directory.

If set to true, the directory specified in File_State_Directory is stored on the local drive of the file location's server.

Manage case sensitivity of object names created in the target DBMS tables. This property applies to Activating Replication, Refresh, or Compare.

Available options for case sensitivity are:

• nodefault: Create table and column names in the same case as received from the source, which can be either lowercase or uppercase.
• upper: Create table and column names in uppercase.
• lower: Create table and column names in lowercase.

This property is applicable only for Databricks (since 6.1.0/37) and PostgreSQL (since 6.1.0/34).

Databricks supports only lowercase table names, so this property affects only column names.

Encryption type used for connecting HVR to the file server (defined in File_Host). This is applicable only if File_Scheme is set to FTP.

Available options for type are:

• SSL
• TLS

Authentication method for connecting HVR to the Google Cloud server (Cloud Storage and Google BigQuery).

The options available/supported for method are location type-specific.

If set to true, enables OAuth 2.0 protocol based authentication for connecting HVR to the Google Cloud Storage.

Directory path for the service account key file (JSON) used in OAuth 2.0 protocol based authentication.

The HMAC access ID of the service account.

The HMAC secret of the service account.

Directory path for the Kerberos ticket cache file.

It is not required to define this property if keytab file is used for authentication or if Kerberos is not used on the Hadoop cluster.

Authentication method for connecting HVR to Hive Server 2.

This property is required only if Hive_Server_Type is set to 2.

Available options for method are:

• NONE
• USER
• USER_PASS
• KERBEROS
  
• HDINSIGHT

The partial URL corresponding to the Hive server.

Fully Qualified Domain Name (FQDN) of the Hive server host. This is the host part of Kerberos principal of the Hive server. For example, if the principal is "hive/example.host@EXAMPLE.REALM" then "example.host" should be specified here.

The value for this property may be set to _HOST to use the Hive server hostname as the domain name for Kerberos authentication.

If Hive_Service_Discovery_Mode is set to NONE, then the driver uses the value specified in the Host connection attribute.
If Hive_Service_Discovery_Mode is set to ZOOKEEPER, then the driver uses the Hive Server 2 host name returned by the ZooKeeper.

Realm of the Hive Server 2 host.

It is not required to specify any value in this property if the realm of the Hive Server 2 host is defined as the default realm in Kerberos configuration.

Kerberos service principal name of the Hive server. This is the service name part of Kerberos principal of the Hive server. For example, if the principal is hive/example.host@EXAMPLE.REALM then "hive" should be specified here.

Type of the Hive server.

Available options for type are:

• 1: HVR will connect to Hive Server 1 instance.
• 2: HVR will connect to Hive Server 2 instance.

Mode for connecting HVR to Hive Server 2.

This property is required only if Hive_Server_Type is set to 2.

Available options for mode are:

• NONE: HVR connects to Hive Server 2 without using the ZooKeeper service.
• ZOOKEEPER: HVR discovers Hive Server 2 services using the ZooKeeper service.

Transport protocol to use in the Thrift layer.

This property is required only if Hive_Server_Type is set to 2.

Available options for protocol are:

• BINARY (This option can be used only if Hive_Authentication_Method is set to NONE or USER_PASS.)
• SASL (This option can be used only if Hive_Authentication_Method is set to USER or USER_PASS or KERBEROS.)
• HTTP (This option can be used only if Hive_Authentication_Method is set to NONE or USER_PASS or KERBEROS or HDINSIGHT.)

For information about determining which Thrift transport protocols your Hive server supports, refer to HiveServer2 Overview and Setting Up HiveServer2 sections in Hive documentation.

Namespace on ZooKeeper under which Hive Server 2 nodes are added.

Directory path where the Actian Vector or Ingres database is installed.

Directory path for storing 'intermediate files' that are generated during compare. Intermediate files are generated while performing direct file or online compare.

If set to true, the directory specified in Intermediate_Directory is stored on the local drive of the file location's server.

Authentication method for connecting HVR to Kafka server (Broker).

Available options for method are:

• NONE
• USER_PASS
• KERBEROS

On Linux, to use either of the Kafka authentication methods (USER_PASS or KERBEROS), HVR requires the library libsasl2.so.2 to be installed. For more information, see section Installation Dependencies in Apache Kafka Requirements.

Hostname or IP address of the Kafka broker server(s) along with the TCP port that the Kafka server uses to listen for client connections.

The default port is 9092.

• {hvr_cap_loc} - for capture location name.
• {hvr_tbl_name} - for current table name. This is only allowed if the channel is defined with tables.
• {hvr_schema}- for schema name of the table. This is only allowed if the channel contains tables that have action TableProperties with parameter Schema=my_schema explicitly defined for these tables on the target file location.

Full Kerberos principal of the client connecting to the Kafka server. This property definition is required only on Linux/Unix.

Directory path where the Kerberos keytab file containing key for the Kafka_Kerberos_Client_Principal is located.

Kerberos Service Principal Name (SPN) of the Kafka server.

Number of messages written (bundled) into single Kafka message. Regardless of the file format chosen, each Kafka message contains one row by default.

Available options for mode are:

• ROW: Each Kafka message contains a single row; this mode does not support bundling of multiple rows into a single message. Note that this mode causes a key-update to be sent as multiple Kafka messages (first a 'before update' with hvr_op 3, and then an 'after update' with hvr_op 2).
• CHANGE: Each Kafka message is a bundle containing two rows (a 'before update' and an 'after update' row) whereas messages for other changes (e.g. insert and delete) contain just one row. During refresh there is no concept of changes, so each row is put into a single message. Therefore in that situation, this behavior is the same as mode ROW.
• TRANSACTION: During replication, each message contains all rows in the original captured transaction. An exception is if the message size looks like it will exceed the bundling threshold (see property Kafka_Message_Bundling_Threshold). During refresh, all changes are treated as if they are from a single capture transaction so this mode behaves the same as bundling mode THRESHOLD.
• THRESHOLD: Each Kafka message is bundled with rows until it exceeds the message bundling threshold (see property Kafka_Message_Bundling_Threshold).

Note that Confluent's Kafka Connect only allows certain message formats and does not allow any message bundling, therefore Kafka_Message_Bundling must either be undefined or set to ROW. Bundled messages simply consist of the contents of several single-row messages concatenated together.

When the mode is set to TRANSACTION or THRESHOLD and if the name of the Kafka topic contains an expression such as {hvr_tbl_name} then the rows of different tables will not be bundled into the same message.

Threshold (in bytes) for bundling rows in a Kafka message. Rows continue to be bundled into the same message until this threshold is exceeded, after which, the message is sent and new rows are bundled into the next message.

The default value is 800,000 bytes.

This property may be defined only if Kafka_Message_Bundling is set to TRANSACTION or THRESHOLD.

By default, the maximum size of a Kafka message is 1,000,000 bytes; HVR will not send a message exceeding this size and will instead give a fatal error.

HVR will configure the Kafka transport protocol to compress message sets transmitted to Kafka broker using one of the available algorithms. The compression allows to decrease the network latency and save disk space on the Kafka broker. Each message set can contain more than one Kafka message. For more information, see section Kafka Message Bundling and Size in Apache Kafka Requirements.

Available options for the algorithm are:

• NONE (recommended if action FileFormat is defined with property Compress or AvroCompression)
• LZ4
• GZIP
• SNAPPY

LZ4 compression is not supported on the Windows platform if Kafka broker version is less than 1.0.

URL (http:// or https://) of the schema registry to use Confluent compatible messages in Avro format.

For HVR versions until 6.1.0/27, if the basic authentication is configured for the schema registry, then the login credentials (username and password) must be specified in the URL. The format is http[s]://user:password@schemaregistry_url:port
For versions since 6.1.0/28, the login credentials (username and password) must be specified in the location properties Kafka_Schema_User and Kafka_Schema_Registry_Password.

For more information, see section Kafka Message Format in Apache Kafka Requirements.

Username for accessing the Kafka schema registry.

If the basic authentication is configured for the schema registry, then the login credentials (username and password) must be specified.

Format of the Kafka message. For more information, see section Kafka Message Format in Apache Kafka Requirements.

Available options for format are:

• AVRO
• JSON

If set to true, then write only the key columns into the capture table to improve the performance of trigger-based capture (when Capture_Method is DB_TRIGGER).

The trigger-based capture method (Capture_Method=DB_TRIGGER) has been deprecated since 6.2.0/0.

The non-key columns are extracted using an outer join from the capture table to the replicated table. Internally HVR uses the same outer join technique to capture changes to long columns (e.g. long varchar). This is necessary because DBMS rules/triggers do not support long data types.

The disadvantage of this technique is that 'transient' column values can sometimes be replicated, for example, if a delete happens just after the toggle has changed, then the outer join could produce a NULL for a column which never had that value.

The trigger-based capture method (Capture_Method=DB_TRIGGER) has been deprecated since 6.2.0/0.

Specify who advances the SQL Server/Sybase ASE transaction log truncation point (truncates the log).

Valid values for method are database-specific:

Absolute path of the Certificate Authority (CA) certificate file. The value in this field must point to the same certificate used by the server. If a value is specified in this field, the server's Common Name (CN) in its certificate is verified against the hostname used for the connection. If there is a mismatch between the CN and the hostname, the connection will be rejected.

Absolute path of the client public key certificate file.

Absolute path of the client private key file.

Minimum protocols the client permits for a TLS connection.

Available options for TLS version are:

• TLS v1
• TLS v1.1
• TLS v1.2
• TLS v1.3

Enable/disable (one way) SSL. If set to true, HVR authenticates the location connection by validating the SSL certificate shared by the database server.

Directory path where the ODBC Driver Manager Library is installed. This property is applicable only for Linux/Unix operating system.

For a default installation, the ODBC Driver Manager Library is available at /usr/lib64 and does not need to be specified. However, when UnixODBC is installed in for example /opt/unixodbc the value for this field would be /opt/unixodbc/lib.

Directory path where the odbcinst.ini file is located. This property is applicable only for Linux/Unix operating system.

For Databricks, the odbcinst.ini file should contain information about the Simba Spark ODBC Driver under the heading [Simba Spark ODBC Driver 64-bit].

Directory path where the odbc.ini and odbcinst.ini files are located. This property is applicable only for Linux/Unix operating system.

For a default installation, these files are available at /etc directory and do not need to be specified using this property. However, when UnixODBC is installed in for example /opt/unixodbc the value for this field would be /opt/unixodbc/etc.

For Azure SQL Database, the odbcinst.ini file should contain information about the Azure SQL Database ODBC Driver under the heading [ODBC Driverversionfor SQL Server].

For Db2 for i, the odbcinst.ini file should contain information about the IBM i Access Client Solutions ODBC Driver under the heading [IBM i Access ODBC Driver 64-bit].

For Redshift, the odbcinst.ini file should contain information about the Amazon Redshift ODBC Driver under the heading [Amazon Redshift (x64)].

For SAP HANA, the odbcinst.ini file should contain information about the HANA ODBC Driver under heading [HDBODBC] or [HDBODBC32].

Directoy path where the Oracle ASM instance is installed. In Linux/Unix, by default, this is located in /etc/oratab file.

This property is only relevant for a source Oracle with redo and/or archive files in ASM and Capture_Method is DIRECT.

The value of this property explicitly sets the system identifier (SID) for the ASM instance. Typically the value is +ASM or +ASM[instance_number], but in some cases it may be +asm in lowercase. HVR can automatically assess what it should be.

To find the value for the SID on a Linux/Unix environment, execute the following command:

ps -ef |grep pmon

This command returns the pmon (process monitor) processes for all instances running on the server, including the ASM instance(s), that always starts with +

Password for Oracle_ASM_User.

Connection string for connecting HVR to Oracle's Automatic Storage Management (ASM) using Transparent Network Substrate (TNS).

Set the real path to the wallet directory if the path includes symbolic links. This is necessary because Oracle does not allow access through the BFile interface to a directory that has symbolic links in its path.

For example, if the wallet directory is /var/foo/xxx, where /var/foo/ is a symbolic link to path /yyy/zzz. Thus, the real path to the wallet directory is /yyy/zzz/xxx. In this case, the property should be set as follows: Oracle_BFile_Dirs_Mapping={"/var/foo":"/yyy/zzz"}.

Connection string for connecting HVR to Oracle root container using Transparent Network Substrate (TNS).

Connection string for connecting HVR to the Oracle data guard primary database using Transparent Network Substrate (TNS).

Directory path where either Oracle or the Oracle client is installed.

Enables replication of invisible columns in Oracle tables. For example, it can be used to capture information stored by Oracle Label Security. This property should be set for the location from which you want to replicate the invisible columns.

Invisible columns will be displayed only in tables added after the property has been set. Tables that were present in a channel before the property was set will not be affected.

Unique name identifier of the Oracle instance/database.

Connection string for connecting to the Oracle database using TNS (Transparent Network Substrate).

The format for the connection string is host:port/service_name.

Alternatively, you can add the connection details into the clients tnsnames.ora file and use that net service name in this field. This method requires easy connect enabled

Directory path of the library (lib) directory in the PostgreSQL installation. This property can be left empty to use the system default path.

Name or IP address of the Amazon S3 bucket.

The keyid can be the ID of the key available in your own account or the full ARN if it is in another account.

If set to true, use Salesforce Bulk API instead of the SOAP interface.

This is more efficient for large volumes of data, because less round-trips are used across the network. A potential disadvantage is that some Salesforce.com licenses limit the number of bulk API operations per day.

Directory path where the Salesforce dataloader.jar file is located.

HVR uses Salesforce Dataloader tool for connecting to the Salesforce location.

If set to true, force serial mode instead of parallel processing for Bulk API.

The default is parallel processing, but enabling Salesforce_Serial_Mode can be used to avoid some problems inside Salesforce.com.

For SAP HANA, this property requires SAP_Source_Schema to be defined. For more information about using this property with SAP HANA, see section Recognizing SAP Archived Records in SAP HANA as Source.

For more information about using this property with SAP NetWeaver on HANA, see section Recognizing SAP Archived Records in Capture from SAP NetWeaver on HANA.

• USER_PASS

SAP logon group is a group of servers that belongs to one SAP system.

On Unix, the services are defined in /etc/services. On Windows, the services are defined in c:\windows\system32\drivers\etc\services.

Directory path containing the SAP NetWeaver RFC SDK library files.

Authentication method for connecting HVR to Azure SQL database.

Available options for method are:

• CLIENT_CREDSSince v6.1.0/4: Authenticate using the Azure SQL access token.

• USER_PASS: Authenticate using the username and password.

• AZURE_ADSince v6.1.0/5: Authenticate using the Azure SQL active directory (AD).

SqlServer_Native_Replicator_Connection

If set to true, disables the firing of database triggers, foreign key constraints, and check constraints during integration, provided these objects were defined with the `NOT FOR REPLICATION` option. This is done by connecting to the database with the SQL Server replication connection capability.

If using HVR version 6.1.5/8 (or older) or a MSODBC driver older than version 17.8, the database connection string format in SqlServer_Server must be server_name,port_number; the alternative connection string formats are not supported. The port_number must be configured in the Network Configuration section of the SQL Server Configuration Manager.

If the HVR version is 6.1.5/8 (or older) or when using a MSODBC driver older than 17.8, when this property is defined, encryption of the ODBC connection is not supported.

Server/instance name for connecting to SQL Server, Azure SQL Database, Azure SQL Managed Instance, and Azure Synapse Analytics.

Certificate used to protect a database encryption key (DEK). This property is defined by a key-value pair, where the key is a certificate name (a string) and the value is the respective certificate. The certificate must be a base64-encoded string. HVR accepts DER and PEM encoded certificates.

Private key associated with the certificate (defined in SqlServer_TDE_Database_Certificates). This property is defined by a key-value pair, where the key is a certificate name (a string) and the value is the respective certificate private key. The private key must be a base64-encoded string. HVR accepts PVK and PEM encoded private keys. The private key is stored encrypted in the repository database.

Password of the private key (defined in SqlServer_TDE_Database_Private_Keys). This property is defined by a key-value pair, where the key is a certificate name (string) and the value is the respective password. The password must be a string. The password is stored encrypted in the repository database.

Directory path for bulk load staging files. For certain databases (Redshift and Snowflake), HVR splits large amount data into multiple staging files, to optimize performance.

This property is supported only for certain location classes. For the list of supported location classes, see Bulk load requires a staging area in Capabilities.

For MariaDB or MySQL, when direct loading by the MySQL/MariaDB server option is used, this should be a directory local to the MySQL/MariaDB server on which the HVR user has write access from the server that HVR uses to connect to the DBMS. And when initial loading by the MySQL/MariaDB client option is used, this should be a local directory on the server where HVR connects to the DBMS.

Directory path for the bulk load staging files visible from the database. This property should point to the same files as Staging_Directory.

This property requires Staging_Directory.

This property is supported only for certain location classes. For the list of supported location classes, see Bulk load requires a staging area in Capabilities.

For Greenplum, this should either be a local directory on the Greenplum head-node or it should be a URL pointing to Staging_Directory, for example a path starting with gpfdist: or gpfdists:.

For HANA, this should be a local directory on the HANA server which is configured for importing data by HANA.

For MariaDB or MySQL, when direct loading by the MySQL/MariaDB server option is used, this should be the directory from which the MySQL/MariaDB server should load the files. And when initial loading by the MySQL/MariaDB client option is used, this should be left empty.

If set to true, the directory specified in Staging_Directory_Database is stored on the local drive of the file location's server.

Username for connecting HVR to the Kafka server.

Specify what action should be performed to enable supplemental logging for tables.

Supplemental logging should be enabled for HVR to perform log-based capture of updates. For more details see, section Supplemental Logging in SQL Server Requirements.

Valid values for method are:

• CDCTAB_ARTICLE (default): Enable supplemental logging of updates by creating a CDC table for the source table.
  If it is not possible to create the CDC table, then HVR will create replication articles instead. And, if it is not possible to create the replication articles also, then an error will be displayed.
• ARTICLE_CDCTAB: Enable supplemental logging of updates by creating SQL Server transactional replication articles if the source table has a primary key.
  If it is not possible to create replication articles or if the source table does not have a primary key, then HVR will create CDC table instead. And, if it is not possible to create the CDC table also, then an error will be displayed.
• EXISTING_CDCTAB_ARTICLE: Enable supplemental logging of updates by using the existing CDC table or replication article for the source table. If neither the CDC tables nor the replication article exists, then HVR will create a CDC table for the source table.
  If it is not possible to create the CDC table, then HVR will create replication articles instead. And, if it is not possible to create replication articles also, then an error will be displayed.
• EXISTING_ARTICLE_CDCTAB: Enable supplemental logging of updates by using the existing CDC table or replication articles for the source table. If neither the CDC tables nor the replication article exist, then HVR will create replication articles for the source table.
  If it is not possible to create replication articles, then HVR will create a CDC table instead. And, if it is not possible to create the CDC table also, then an error will be displayed.

Supplemental_Logging_Unavailable

Authentication method for connecting HVR to Sybase ASE server.

Available options for method are:

• USER_PASS
• KERBEROS

For more information about using KERBEROS authentication, see section Kerberos Authentication in Sybase ASE Requirements.

Directory path where the Kerberos keytab file is located. This keytab file contains the security key for the Database_User.

Name of the security mechanism that performs security services for this connection. Security mechanism names are defined in the Sybase libtcl.cfg configuration file.

If this property is not defined, the default mechanism defined in the libtcl.cfg file will be used.

Kerberos security mechanism services. It only defines how the connection behaves.

This property is required only if Sybase_Authentication_Method is set to KERBEROS.

Available options:

• Mutual Client/Server Authentication: Both HVR and the Sybase server are required to authenticate themselves.
• Encrypted Connection: Enables encrypted connection between HVR and the Sybase server.
• Data Integrity Checking: Enables data integrity checking.
• Replay Transmission Detection: Enables data replay detection.
• Data Out-Of-Sequence Detection: Enables out-of-sequence detection.
• Data Origin Verification: Enables data origin stamping service.
• Channel Binding: Enables channel binding.

The Kerberos Service Principal Name (SPN) of the Sybase ASE server.

• INTERFACES_FILE: Use the SAP Open Client’s interfaces file to get network transport information.
• DIRECT: Use the network transport information specified directly in the HVR's location definition for Sybase ASE.

Directory path where the Teradata TPT Library is installed.

If set to true, allows end user transactions to avoid lock on toggle table.

The toggle table is changed by HVR during trigger-based capture. Normally all changes from user transactions before a toggle is put into one set of capture tables and changes from after a toggle are put in the other set. This ensures that transactions are not split. If an end user transaction is running when HVR changes the toggle then HVR must wait, and if other end user transactions start then they must wait behind HVR.

Defining this property allows other transactions to avoid waiting, but the consequence is that their changes can be split across both sets of capture tables. During integration these changes will be applied in separate transactions; in between these transactions the target database is not consistent.

The trigger-based capture method (Capture_Method=DB_TRIGGER) has been deprecated since 6.2.0/0.

The trigger-based capture method (Capture_Method=DB_TRIGGER) has been deprecated since 6.2.0/0.

This is a discovered property that stores the version of the database (defined in View_Database_Name). HVR stores and uses this number internally to determine which Hive functionality should HVR attempt to use.

Authentication method for connecting HVR to Hive Server 2 instance.

This property is required only if View_Hive_Server_Type is set to Hive Server 2.

Available options for method are:

• NONE

• KERBEROS

• USER

• USER_PASS

• HDINSIGHT

The partial URL corresponding to the Hive server.

Fully Qualified Domain Name (FQDN) of the Hive Server 2 host. The value of Host can be set to _HOST to use the Hive server hostname as the domain name for Kerberos authentication.

If Hive_Service_Discovery_Mode is disabled, then the driver uses the value specified in the Host connection attribute.
If Hive_Service_Discovery_Mode is set to ZooKeeper, then the driver uses the Hive Server 2 host name returned by ZooKeeper.

Realm of the Hive Server 2 host.

It is not required to specify any value in this property if the realm of the Hive Server 2 host is defined as the default realm in Kerberos configuration.

Kerberos service principal name of the Hive server.

Type of the Hive server to which HVR will be connected.

Available options for type are:

• Hive Server 1: HVR connects to a Hive Server 1 instance.
• Hive Server 2: HVR connects to a Hive Server 2 instance.

Mode for connecting to Hive.

This property is required only if View_Hive_Server_Type is set to Hive Server 2.

Available options for mode are:

• NONE: HVR connects to Hive server without using the ZooKeeper service.
• ZOOKEEPER: HVR discovers Hive Server 2 services using the ZooKeeper service.

Transport protocol to use in the Thrift layer.

This property is required only if View_Hive_Server_Type is set to Hive Server 2.

Available options for protocol are:

• BINARY: This option can be used only if Hive_Authentication_Method is set to NONE or USER_PASS.
• SASL: This option can be used only if Hive_Authentication_Method is set to KERBEROS or USER or USER_PASS.
• HTTP: This option cannot be used if Hive_Authentication_Method is set to USER.

For information about determining which Thrift transport protocols your Hive server supports, refer to HiveServer2 Overview and Setting Up HiveServer2 sections in Hive documentation.

Namespace on ZooKeeper under which Hive Server 2 nodes are added.

Directory path where the ODBC Driver Manager Library is installed. This property is applicable only for Linux/Unix operating system.

Directory path where the odbc.ini and odbcinst.ini files are located. This property is applicable only for Linux/Unix operating system.

For a default installation, these files are available at /etc and do not need to be specified. However, when UnixODBC is installed in for example /opt/unixodbc the value for this property would be /opt/unixodbc/etc.

• For Db2i, the odbcinst.ini file should contain information about the IBM i Access Client Solutions ODBC Driver under the heading [IBM i Access ODBC Driver 64-bit].
• For Redshift, the odbcinst.ini file should contain information about the Amazon Redshift ODBC Driver under the heading [Amazon Redshift (x64)].
• For SAP HANA, the odbcinst.ini file should contain information about the HANA ODBC Driver under heading [HDBODBC] or [HDBODBC32].
• For Snowflake, the odbcinst.ini file should contain information about the Snowflake ODBC Driver under the heading [SnowflakeDSIIDriver].
• For Azure SQL Database, the odbcinst.ini file should contain information about the Snowflake ODBC Driver under the heading [ODBC Driverversionfor SQL Server].