HiveShell (HiveRunner 6.0.1 API)

All Known Subinterfaces:

HiveShellContainer
```
public interface HiveShell
```
Test handle to the hive server. Please refer to test class com.klarna.hiverunner.examples.HelloHiveRunner for usage examples.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addResource(String targetFile, File sourceFile)` Copy test data into hdfs May only be called pre #start()
`void`	`addResource(String targetFile, Path sourceFile)` Copy test data into hdfs May only be called pre #start()
`void`	`addResource(String targetFile, String data)` Copy test data into hdfs May only be called pre #start()
`void`	`addSetupScript(String script)` Add a hive script that will be executed when the hive shell is started Scripts will be executed in the order they are added.
`void`	`addSetupScripts(Charset charset, File... scripts)` Add hive scripts that will be executed when the hive shell is started.
`void`	`addSetupScripts(Charset charset, Path... scripts)` Add hive scripts that will be executed when the hive shell is started.
`void`	`addSetupScripts(File... scripts)` Add hive scripts that will be executed when the hive shell is started.
`void`	`addSetupScripts(Path... scripts)` Add hive scripts that will be executed when the hive shell is started.
`void`	`execute(Charset charset, File file)` Executes a hive script.
`void`	`execute(Charset charset, Path path)` Executes a hive script.
`void`	`execute(File file)` Executes a hive script.
`void`	`execute(Path path)` Executes a hive script.
`void`	`execute(String script)` Executes a hive script.
`List<String>`	`executeQuery(Charset charset, File script)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(Charset charset, File script, String rowValuesDelimitedBy, String replaceNullWith)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(Charset charset, Path script)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(Charset charset, Path script, String rowValuesDelimitedBy, String replaceNullWith)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(File script)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(File script, String rowValuesDelimitedBy, String replaceNullWith)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(Path script)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(Path script, String rowValuesDelimitedBy, String replaceNullWith)` Executes a single query from a script file, returning any results.
`List<String>`	`executeQuery(String hiveSql)` Executes a single query.
`List<String>`	`executeQuery(String hiveSql, String rowValuesDelimitedBy, String replaceNullWith)` Executes a single query.
`List<Object[]>`	`executeStatement(String hiveSql)` Execute a single hive query
`String`	`expandVariableSubstitutes(String expression)` Resolve all substituted variables with the hive conf.
`Path`	`getBaseDir()` Get the test case sand box base dir
`Path`	`getCwd()`
`org.apache.hadoop.hive.conf.HiveConf`	`getHiveConf()` Get the current HiveConf from hive
`OutputStream`	`getResourceOutputStream(String targetFile)` Open up a stream to write test data into HDFS.
`InsertIntoTable`	`insertInto(String databaseName, String tableName)` Returns an `InsertIntoTable` that allows programmatically inserting data into a table in a fluent manner.
`void`	`setCwd(Path cwd)`
`void`	`setHiveConfValue(String key, String value)` Set HiveConf property.
`void`	`setHiveVarValue(String var, String value)` Set Hive variable.
`void`	`setProperty(String key, String value)` Deprecated. Use `setHiveConfValue(String, String)` instead
`void`	`start()` Start the shell.

- Method Detail
  - executeQuery
```
List<String> executeQuery(String hiveSql)
```
    Executes a single query.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(String hiveSql,
                          String rowValuesDelimitedBy,
                          String replaceNullWith)
```
    Executes a single query.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(File script)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Path script)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Charset charset,
                          File script)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Charset charset,
                          Path script)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(File script,
                          String rowValuesDelimitedBy,
                          String replaceNullWith)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Path script,
                          String rowValuesDelimitedBy,
                          String replaceNullWith)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Charset charset,
                          File script,
                          String rowValuesDelimitedBy,
                          String replaceNullWith)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeQuery
```
List<String> executeQuery(Charset charset,
                          Path script,
                          String rowValuesDelimitedBy,
                          String replaceNullWith)
```
    Executes a single query from a script file, returning any results.
    May only be called post #start()
  - executeStatement
```
List<Object[]> executeStatement(String hiveSql)
```
    Execute a single hive query
    May only be called post #start()
  - execute
```
void execute(String script)
```
    Executes a hive script. The script may contain multiple statements delimited by ';'
    May only be called post #start()
  - execute
```
void execute(File file)
```
    Executes a hive script. The script may contain multiple statements delimited by ';'. Default charset will be used to read the given files.
    May only be called post #start()
  - execute
```
void execute(Path path)
```
    Executes a hive script. The script may contain multiple statements delimited by ';'. Default charset will be used to read the given files.
    May only be called post #start()
  - execute
```
void execute(Charset charset,
             File file)
```
    Executes a hive script. The script may contain multiple statements delimited by ';'
    May only be called post #start()
  - execute
```
void execute(Charset charset,
             Path path)
```
    Executes a hive script. The script may contain multiple statements delimited by ';'
    May only be called post #start()
  - start
```
void start()
```
    Start the shell. May only be called once. The test engine will by default call this method, Set HiveSQL.autoStart() to false to explicitly control when to start from the test case.
    This might be useful for test methods that needs additional setup not catered for with the provided annotations.
  - setProperty
```
@Deprecated
void setProperty(String key,
                             String value)
```
    Deprecated. Use setHiveConfValue(String, String) instead
    
    Set a HiveConf property.
    May only be called pre #start()
  - setHiveConfValue
```
void setHiveConfValue(String key,
                      String value)
```
    Set HiveConf property.
    May only be called pre #start()
  - setHiveVarValue
```
void setHiveVarValue(String var,
                     String value)
```
    Set Hive variable.
    May only be called pre #start()
  - getHiveConf
```
org.apache.hadoop.hive.conf.HiveConf getHiveConf()
```
    Get the current HiveConf from hive
  - setCwd
```
void setCwd(Path cwd)
```
  - getCwd
```
Path getCwd()
```
  - addResource
```
void addResource(String targetFile,
                 File sourceFile)
```
    Copy test data into hdfs May only be called pre #start()
    com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest() and com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()
  - addResource
```
void addResource(String targetFile,
                 Path sourceFile)
```
    Copy test data into hdfs May only be called pre #start()
    com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest() and com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()
  - addResource
```
void addResource(String targetFile,
                 String data)
```
    Copy test data into hdfs May only be called pre #start()
    com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsFileTest() and com.klarna.hiverunner.MethodLevelResourceTest#resourceLoadingAsStringTest()
  - addSetupScript
```
void addSetupScript(String script)
```
    Add a hive script that will be executed when the hive shell is started Scripts will be executed in the order they are added. Note that execution order is not guaranteed with fields annotated with HiveSetupScript
  - addSetupScripts
```
void addSetupScripts(Charset charset,
                     File... scripts)
```
    Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order. Note that execution order is not guaranteed with fields annotated with HiveSetupScript
  - addSetupScripts
```
void addSetupScripts(Charset charset,
                     Path... scripts)
```
    Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order. Note that execution order is not guaranteed with fields annotated with HiveSetupScript
  - addSetupScripts
```
void addSetupScripts(File... scripts)
```
    Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order. Default charset will be used to read the given files Note that execution order is not guaranteed with fields annotated with HiveSetupScript
  - addSetupScripts
```
void addSetupScripts(Path... scripts)
```
    Add hive scripts that will be executed when the hive shell is started. Scripts will be executed in given order. Default charset will be used to read the given files Note that execution order is not guaranteed with fields annotated with HiveSetupScript
  - getBaseDir
```
Path getBaseDir()
```
    Get the test case sand box base dir
  - expandVariableSubstitutes
```
String expandVariableSubstitutes(String expression)
```
    Resolve all substituted variables with the hive conf.
    
    Throws:
    
    IllegalArgumentException - if not all substitutes could be resolved
    
    IllegalStateException - if the HiveShell was not started yet.
  - getResourceOutputStream
```
OutputStream getResourceOutputStream(String targetFile)
```
    Open up a stream to write test data into HDFS. May only be called pre #start(). No writes to the stream will be allowed post #start().
    
    Parameters:
    
    targetFile - The path to the target file relative to the hive work space. See test class com.klarna.hiverunner.ResourceOutputStreamTest#sequenceFile() for an example of how this works. with sequence files.
  - insertInto
```
InsertIntoTable insertInto(String databaseName,
                           String tableName)
```
    Returns an InsertIntoTable that allows programmatically inserting data into a table in a fluent manner.
    May only be called post #start()
    
    Parameters:
    
    databaseName - The database name
    
    tableName - The table name

Interface HiveShell

Method Summary

Method Detail

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeQuery

executeStatement

execute

execute

execute

execute

execute

start

setProperty

setHiveConfValue

setHiveVarValue

getHiveConf

setCwd

getCwd

addResource

addResource

addResource

addSetupScript

addSetupScripts

addSetupScripts

addSetupScripts

addSetupScripts

getBaseDir

expandVariableSubstitutes

getResourceOutputStream

insertInto