Connection String Parameters for Hive
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
Name | Description |
AuthScheme | The authentication scheme used. Accepted entries are PLAIN, LDAP, NOSASL, and KERBEROS. |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
CacheProvider | The name of the provider to be used to cache data. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
Database | The name of the Hive database to use by default. |
FailoverHosts | This property allows you to specify a list of failover hosts in addition to the one configured in Server and Port . |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
HTTPPath | The path component of the URL endpoint when using HTTP TransportMode. |
KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
KerberosRealm | The Kerberos Realm used to authenticate the user with. |
KerberosServiceKDC | The Kerberos KDC of the service. |
KerberosServiceRealm | The Kerberos realm of the service. |
KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The number of results to return per request from Hive. |
Password | The password used to authenticate with Hive. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
Port | The port for the connection to the HiveServer2 instance. |
ProtocolVersion | The Protocol Version used to authenticate with Hive. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryPassthrough | This option passes the query to the Apache Hive server as is. |
Readonly | You can use this property to enforce read-only access to Apache Hive from the provider. |
RTK | The runtime key used for licensing. |
Server | The host name or IP address of the server hosting HiveServer2. |
ServerConfigurations | A list of server configuration variables to override the server defaults. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TransportMode | The transport mode to use to communicate with the Hive server. Accepted entries are BINARY and HTTP. |
UseConnectionPooling | This property enables connection pooling. |
UseDescTableQuery | This option specifies whether the columns will be retrieved using a DESC TABLE query or the GetColumns Thrift API. |
User | The username used to authenticate with Hive. |
UseShowDatabasesQuery | This option specifies whether the schemas will be retrieved using a SHOW DATABASES query or the GetSchemas Thrift API. |
UseShowTablesQuery | This option specifies whether the tables will be retrieved using a SHOW TABLES query or the GetTables Thrift API. |
UseSSL | Specifies whether to use SSL Encryption when connecting to Hive. |
UseZookeeperDiscovery | Specifies whether to use ZooKeeper Service Discovery. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
ZookeeperNamespace | The namespace configured on ZooKeeper for the Hive Server 2 znodes. |