org.apache.hive.beeline.hs2connection

Interface HS2ConnectionFileParser

All Known Implementing Classes:

HiveSiteHS2ConnectionFileParser, UserHS2ConnectionFileParser

public interface HS2ConnectionFileParser

HS2ConnectionFileParser provides a interface to be used by Beeline to parse a configuration (file or otherwise) to return a Java Properties object which contain key value pairs to be used to construct connection URL automatically for the Beeline connection

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEELINE_CONNECTION_PROPERTY_PREFIX prefix string used for the keys
static String	DEFAULT_DB_PROPERTY_KEY Property key used to provide the default database in the connection URL
static String	HIVE_CONF_PROPERTY_KEY Property key used to provide the hive configuration key value pairs in the connection URL
static String	HIVE_VAR_PROPERTY_KEY Property key used to provide the hive variables in the connection URL
static String	HOST_PROPERTY_KEY Property key used to provide the hosts in the connection URL
static String	URL_PREFIX_PROPERTY_KEY Property key used to provide the URL prefix for the connection URL

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

Field Detail

BEELINE_CONNECTION_PROPERTY_PREFIX

static final String BEELINE_CONNECTION_PROPERTY_PREFIX

prefix string used for the keys

See Also:

Constant Field Values

URL_PREFIX_PROPERTY_KEY

static final String URL_PREFIX_PROPERTY_KEY

Property key used to provide the URL prefix for the connection URL

See Also:

Constant Field Values

DEFAULT_DB_PROPERTY_KEY

static final String DEFAULT_DB_PROPERTY_KEY

Property key used to provide the default database in the connection URL

See Also:

Constant Field Values

HOST_PROPERTY_KEY

static final String HOST_PROPERTY_KEY

Property key used to provide the hosts in the connection URL

See Also:

Constant Field Values

HIVE_CONF_PROPERTY_KEY

static final String HIVE_CONF_PROPERTY_KEY

Property key used to provide the hive configuration key value pairs in the connection URL

See Also:

Constant Field Values

HIVE_VAR_PROPERTY_KEY

static final String HIVE_VAR_PROPERTY_KEY

Property key used to provide the hive variables in the connection URL

See Also:

Constant Field Values

Method Detail

getConnectionProperties

Properties getConnectionProperties()
                            throws BeelineHS2ConnectionFileParseException

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" ]

Returns:

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

Throws:

BeelineHS2ConnectionFileParseException - if there is invalid key with appropriate message

configExists

boolean configExists()

Returns:

returns true if the configuration exists else returns false