Runner (Apache Derby V10.13 Test Javadoc)

java.lang.Object
- org.apache.derbyTesting.perf.clients.Runner

```
public class Runner
extends java.lang.Object
```
Class used for running a performance test from the command line. To learn how to run the tests, invoke this command:
```
 java org.apache.derbyTesting.perf.clients.Runner
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`DEFAULT_URL`
`private static java.lang.String`	`DERBY_EMBEDDED_DRIVER`
`private static java.lang.String`	`driver` The JDBC driver class to use in the test.
`private static java.lang.String`	`generator` The name of the load generator to use in the test.
`private static boolean`	`init` Flag which tells whether the data needed by this test should be (re)created.
`private static java.lang.String`	`load` The name of the type of load to use in the test.
`private static java.util.HashMap<java.lang.String,java.lang.String>`	`loadOpts` Map containing load-specific options.
`private static java.lang.String`	`password` Password for connecting to the database.
`private static int`	`requestsPerSecond` The number of requests to issue to the database per second (for the load generators that take that as an argument).
`private static int`	`steadySec` The number of seconds to collect results.
`private static int`	`threads` The number of client threads to use in the test.
`private static java.lang.String`	`url` The JDBC connection URL to use in the test.
`private static java.lang.String`	`USAGE` String to print when there are errors in the command line arguments.
`private static java.lang.String`	`user` Username for connecting to the database.
`private static int`	`warmupSec` The number of seconds to spend in the warmup phase.

Constructor Summary

Constructors
Constructor and Description

Runner()

Constructors
Constructor and Description
`Runner()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`private static DBFiller`	`getDBFiller()` Find the `DBFiller` instance for the load specified on the command line.
`private static LoadGenerator`	`getLoadGenerator()` Create a load generator for the load specified on the command line.
`(package private) static int`	`getLoadOpt(java.lang.String option, int defaultValue)` Get the `int` value of the specified option.
`private static int`	`getTextType()` Get the data type to be used for sr_select and sr_update types of load.
`private static boolean`	`hasOption(java.lang.String option)` Checks whether the specified option is set.
`static void`	`main(java.lang.String[] args)` Main method which starts the Runner application.
`private static Client`	`newClient()` Create a new client for the load specified on the command line.
`private static void`	`parseArgs(java.lang.String[] args)` Parse the command line arguments and set the state variables to reflect the arguments.
`private static void`	`parseLoadOpts(java.lang.String optsString)` Parse the load-specific options.
`private static void`	`printUsage(java.io.PrintStream out)` Print the usage string.
`private static void`	`shutdownDatabase()` Shut down the database if it is a Derby embedded database.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DERBY_EMBEDDED_DRIVER
```
private static final java.lang.String DERBY_EMBEDDED_DRIVER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_URL
```
private static final java.lang.String DEFAULT_URL
```
    See Also:
    
    Constant Field Values
  - driver
```
private static java.lang.String driver
```
    The JDBC driver class to use in the test.
  - url
```
private static java.lang.String url
```
    The JDBC connection URL to use in the test.
  - user
```
private static java.lang.String user
```
    Username for connecting to the database.
  - password
```
private static java.lang.String password
```
    Password for connecting to the database.
  - init
```
private static boolean init
```
    Flag which tells whether the data needed by this test should be (re)created.
  - load
```
private static java.lang.String load
```
    The name of the type of load to use in the test.
  - loadOpts
```
private static final java.util.HashMap<java.lang.String,java.lang.String> loadOpts
```
    Map containing load-specific options.
  - generator
```
private static java.lang.String generator
```
    The name of the load generator to use in the test.
  - threads
```
private static int threads
```
    The number of client threads to use in the test.
  - requestsPerSecond
```
private static int requestsPerSecond
```
    The number of requests to issue to the database per second (for the load generators that take that as an argument).
  - warmupSec
```
private static int warmupSec
```
    The number of seconds to spend in the warmup phase.
  - steadySec
```
private static int steadySec
```
    The number of seconds to collect results.
  - USAGE
```
private static final java.lang.String USAGE
```
    String to print when there are errors in the command line arguments.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Runner
```
public Runner()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Main method which starts the Runner application.
    
    Parameters:
    
    args - the command line arguments
    
    Throws:
    
    java.lang.Exception
  - parseArgs
```
private static void parseArgs(java.lang.String[] args)
                       throws java.lang.Exception
```
    Parse the command line arguments and set the state variables to reflect the arguments.
    
    Parameters:
    
    args - the command line arguments
    
    Throws:
    
    java.lang.Exception
  - parseLoadOpts
```
private static void parseLoadOpts(java.lang.String optsString)
```
    Parse the load-specific options. It's a comma-separated list of options, where each option is either a keyword or a (keyword, value) pair separated by an equals sign (=). The parsed options will be put into the map loadOpts.
    
    Parameters:
    
    optsString - the comma-separated list of options
  - hasOption
```
private static boolean hasOption(java.lang.String option)
```
    Checks whether the specified option is set.
    
    Parameters:
    
    option - the name of the option
    
    Returns:
    
    true if the option is set
  - getLoadOpt
```
static int getLoadOpt(java.lang.String option,
                      int defaultValue)
```
    Get the int value of the specified option.
    
    Parameters:
    
    option - the name of the option
    
    defaultValue - the value to return if the option is not set
    
    Returns:
    
    the value of the option
    
    Throws:
    
    java.lang.NumberFormatException - if the value is not an int
  - printUsage
```
private static void printUsage(java.io.PrintStream out)
```
    Print the usage string.
    
    Parameters:
    
    out - the stream to print the usage string to
  - getTextType
```
private static int getTextType()
```
    Get the data type to be used for sr_select and sr_update types of load.
    
    Returns:
    
    one of the java.sql.Types data type constants
  - getDBFiller
```
private static DBFiller getDBFiller()
```
    Find the DBFiller instance for the load specified on the command line.
    
    Returns:
    
    a DBFiller instance
  - newClient
```
private static Client newClient()
```
    Create a new client for the load specified on the command line.
    
    Returns:
    
    a Client instance
  - getLoadGenerator
```
private static LoadGenerator getLoadGenerator()
```
    Create a load generator for the load specified on the command line.
    
    Returns:
    
    a LoadGenerator instance
  - shutdownDatabase
```
private static void shutdownDatabase()
                              throws java.sql.SQLException
```
    Shut down the database if it is a Derby embedded database.
    
    Throws:
    
    java.sql.SQLException

Class Runner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DERBY_EMBEDDED_DRIVER

DEFAULT_URL

driver

url

user

password

init

load

loadOpts

generator

threads

requestsPerSecond

warmupSec

steadySec

USAGE

Constructor Detail

Runner

Method Detail

main

parseArgs

parseLoadOpts

hasOption

getLoadOpt

printUsage

getTextType

getDBFiller

newClient

getLoadGenerator

shutdownDatabase