org.apache.hive.beeline.hs2connection

Class BeelineSiteParser

java.lang.Object

org.apache.hive.beeline.hs2connection.BeelineSiteParser

All Implemented Interfaces:

HS2ConnectionFileParser

public class BeelineSiteParser
extends Object
implements HS2ConnectionFileParser

This class implements HS2ConnectionFileParser for the named url configuration file named beeline-site.xml. The class looks for this file in ${user.home}/.beeline, ${HIVE_CONF_DIR} or /etc/conf/hive in that order and uses the first file found in the above locations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEELINE_CONNECTION_NAMED_JDBC_URL_PREFIX Prefix string used for named jdbc uri configs
static String	DEFAULT_BEELINE_SITE_FILE_NAME
static String	DEFAULT_BEELINE_SITE_LOCATION
static String	DEFAULT_NAMED_JDBC_URL_PROPERTY_KEY Property key used to provide the default named jdbc uri in the config file
static String	ETC_HIVE_CONF_LOCATION

Fields inherited from interface org.apache.hive.beeline.hs2connection.HS2ConnectionFileParser

BEELINE_CONNECTION_PROPERTY_PREFIX, DEFAULT_DB_PROPERTY_KEY, HIVE_CONF_PROPERTY_KEY, HIVE_VAR_PROPERTY_KEY, HOST_PROPERTY_KEY, URL_PREFIX_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
BeelineSiteParser()

Method Summary

Modifier and Type	Method and Description
boolean	configExists()
Properties	getConnectionProperties() Returns a Java properties object which contain the key value pairs which can be used in the Beeline connection URL
Properties	getConnectionProperties(String propertyValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BEELINE_CONNECTION_NAMED_JDBC_URL_PREFIX

public static final String BEELINE_CONNECTION_NAMED_JDBC_URL_PREFIX

Prefix string used for named jdbc uri configs

See Also:

Constant Field Values

DEFAULT_NAMED_JDBC_URL_PROPERTY_KEY

public static final String DEFAULT_NAMED_JDBC_URL_PROPERTY_KEY

Property key used to provide the default named jdbc uri in the config file

See Also:

Constant Field Values

DEFAULT_BEELINE_SITE_FILE_NAME

public static final String DEFAULT_BEELINE_SITE_FILE_NAME

See Also:

Constant Field Values

DEFAULT_BEELINE_SITE_LOCATION

public static final String DEFAULT_BEELINE_SITE_LOCATION

ETC_HIVE_CONF_LOCATION

public static final String ETC_HIVE_CONF_LOCATION

Constructor Detail

BeelineSiteParser

public BeelineSiteParser()

Method Detail

getConnectionProperties

public Properties getConnectionProperties()
                                   throws BeelineSiteParseException

Description copied from interface: HS2ConnectionFileParser

Returns a Java properties object which contain the key value pairs which can be used in the Beeline connection URL

The properties returned must include url_prefix and hosts

Following are some examples of the URLs and returned properties object

• jdbc:hive2://hs2-instance1.example.com:10000/default;user=hive;password=mypassword should return [ "url_prefix"="jdbc:hive2://", "hosts"="hs2-instance1.example.com:10000", "defaultDB"=default, "user"="hive", "password"="mypassword" ]
• jdbc:hive2://zk-instance1:10001,zk-instance2:10002,zk-instance3:10003/default; serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=hiveserver2 should return [ "url_prefix"="jdbc:hive2://", "hosts"="zk-instance1:10001,zk-instance2:10002,zk-instance3:10003", "defaultDB"="default", "serviceDiscoveryMode"="zooKeeper", "zooKeeperNamespace"="hiveserver2" ]
• If hive_conf_list and hive_var_list is present in the url it should return a comma separated key=value pairs for each of them

  For example :

  jdbc:hive2://hs2-instance1.example.com:10000/default;user=hive?hive.cli.print.currentdb=true; hive.cli.print.header=true#hivevar:mytbl=customers;hivevar:mycol=id it should return [ "url_prefix"="jdbc:hive2://", "hosts"="hs2-instance1.example.com:10000", "defaultDB"="default", "user"="hive", "hiveconf"="hive.cli.print.currentdb=true, hive.cli.print.header=true", "hivevar"="hivevar:mytb1=customers, hivevar:mycol=id" ]

Specified by:

getConnectionProperties in interface HS2ConnectionFileParser

Returns:

Properties object which contain connection URL properties for Beeline connection. Returns an empty properties object if the connection configuration is not found

Throws:

BeelineSiteParseException

getConnectionProperties

public Properties getConnectionProperties(String propertyValue)
                                   throws BeelineSiteParseException

Throws:

BeelineSiteParseException

configExists

public boolean configExists()

Specified by:

configExists in interface HS2ConnectionFileParser

Returns:

returns true if the configuration exists else returns false