ClusterFixtureBuilder (Drill : 1.19.0 API)

java.lang.Object
- org.apache.drill.test.ClusterFixtureBuilder

```
public class ClusterFixtureBuilder
extends Object
```
Build a Drillbit and client with the options provided. The simplest builder starts an embedded Drillbit, with the "dfs" name space, a max width (parallelization) of 2.
Designed primarily for unit tests: the builders provide control over all aspects of the Drillbit or cluster. Can also be used to create an embedded Drillbit, use the zero-argument constructor which will omit creating set of test-only directories and will skip creating the test-only storage plugins and other configuration. In this mode, you should configure the builder to read from a config file, or specify all the non-default config options needed.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ClusterFixtureBuilder.RuntimeOption

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterFixtureBuilder.RuntimeOption`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bitCount`
`protected String[]`	`bitNames`
`protected Properties`	`clientProps`
`protected ConfigBuilder`	`configBuilder`
`static int`	`DEFAULT_ZK_REFRESH`
`protected BaseDirTestWatcher`	`dirTestWatcher`
`protected int`	`localZkCount`
`protected List<ClusterFixtureBuilder.RuntimeOption>`	`sessionOptions`
`protected List<ClusterFixtureBuilder.RuntimeOption>`	`systemOptions`
`protected boolean`	`usingZk`
`protected ZookeeperHelper`	`zkHelper`

Constructor Summary

Constructors
Constructor and Description

ClusterFixtureBuilder()

ClusterFixtureBuilder(BaseDirTestWatcher dirTestWatcher)

Constructors
Constructor and Description
`ClusterFixtureBuilder()`
`ClusterFixtureBuilder(BaseDirTestWatcher dirTestWatcher)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterFixture`	`build()` Create the embedded Drillbit and client, applying the options set in the builder.
`ClusterMockStorageFixture`	`buildCustomMockStorage()`
`ClusterFixtureBuilder`	`clusterSize(int n)` The number of Drillbits to start in the cluster.
`ConfigBuilder`	`configBuilder()` The configuration builder which this fixture builder uses.
`ClusterFixtureBuilder`	`configClientProperty(String key, Object value)` Add an additional property for the client connection URL.
`ClusterFixtureBuilder`	`configProperty(String key, Object value)` Add an additional boot-time property for the embedded Drillbit.
`ClusterFixtureBuilder`	`configResource(String configResource)` Use the given configuration file, stored as a resource, to start the embedded Drillbit.
`ClusterFixtureBuilder`	`maxParallelization(int n)` Set the maximum parallelization (max width per node).
`ClusterFixtureBuilder`	`putDefinition(OptionDefinition definition)`
`ClusterFixtureBuilder`	`saveProfiles()` Enable saving of query profiles.
`ClusterFixtureBuilder`	`sessionOption(String key, Object value)` Provide a session option to be set once the Drillbit is started.
`ClusterFixtureBuilder`	`setOptionDefault(String key, Object value)`
`ClusterFixtureBuilder`	`systemOption(String key, Object value)` Provide a system option to be set once the Drillbit is started.
`ClusterFixtureBuilder`	`withBits(String... bitNames)` Define a cluster by providing names to the Drillbits.
`ClusterFixtureBuilder`	`withLocalZk()` By default the embedded Drillbits use an in-memory cluster coordinator.
`ClusterFixtureBuilder`	`withLocalZk(int count)`
`ClusterFixtureBuilder`	`withRemoteZk(String connStr)`
`ClusterFixtureBuilder`	`withZk(ZookeeperHelper zk)` Run the cluster using a Zookeeper started externally.

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

- Field Detail
  - DEFAULT_ZK_REFRESH
```
public static final int DEFAULT_ZK_REFRESH
```
    See Also:
    
    Constant Field Values
  - configBuilder
```
protected ConfigBuilder configBuilder
```
  - sessionOptions
```
protected List<ClusterFixtureBuilder.RuntimeOption> sessionOptions
```
  - systemOptions
```
protected List<ClusterFixtureBuilder.RuntimeOption> systemOptions
```
  - bitCount
```
protected int bitCount
```
  - bitNames
```
protected String[] bitNames
```
  - localZkCount
```
protected int localZkCount
```
  - zkHelper
```
protected ZookeeperHelper zkHelper
```
  - usingZk
```
protected boolean usingZk
```
  - clientProps
```
protected Properties clientProps
```
  - dirTestWatcher
```
protected final BaseDirTestWatcher dirTestWatcher
```
- Constructor Detail
  - ClusterFixtureBuilder
```
public ClusterFixtureBuilder()
```
  - ClusterFixtureBuilder
```
public ClusterFixtureBuilder(BaseDirTestWatcher dirTestWatcher)
```
- Method Detail
  - configBuilder
```
public ConfigBuilder configBuilder()
```
    The configuration builder which this fixture builder uses.
    
    Returns:
    
    the configuration builder for use in setting "advanced" configuration options.
  - configResource
```
public ClusterFixtureBuilder configResource(String configResource)
```
    Use the given configuration file, stored as a resource, to start the embedded Drillbit. Note that the resource file should have the two following settings to work as a test:
```
 drill.exec.sys.store.provider.local.write : false,
 drill.exec.http.enabled : false
 
```
    It may be more convenient to add your settings to the default config settings with configProperty(String, Object).
    Parameters:
    
    configResource - path to the file that contains the config file to be read
    
    Returns:
    
    this builder
    
    See Also:
    
    #configProperty(String, Object)}
  - setOptionDefault
```
public ClusterFixtureBuilder setOptionDefault(String key,
                                              Object value)
```
  - configProperty
```
public ClusterFixtureBuilder configProperty(String key,
                                            Object value)
```
    Add an additional boot-time property for the embedded Drillbit.
    
    Parameters:
    
    key - config property name
    
    value - property value
    
    Returns:
    
    this builder
  - putDefinition
```
public ClusterFixtureBuilder putDefinition(OptionDefinition definition)
```
  - configClientProperty
```
public ClusterFixtureBuilder configClientProperty(String key,
                                                  Object value)
```
    Add an additional property for the client connection URL. Convert all the values into String type.
    
    Parameters:
    
    key - config property name
    
    value - property value
    
    Returns:
    
    this builder
  - sessionOption
```
public ClusterFixtureBuilder sessionOption(String key,
                                           Object value)
```
    Provide a session option to be set once the Drillbit is started.
    
    Parameters:
    
    key - the name of the session option
    
    value - the value of the session option
    
    Returns:
    
    this builder
  - systemOption
```
public ClusterFixtureBuilder systemOption(String key,
                                          Object value)
```
    Provide a system option to be set once the Drillbit is started.
    
    Parameters:
    
    key - the name of the system option
    
    value - the value of the system option
    
    Returns:
    
    this builder
  - maxParallelization
```
public ClusterFixtureBuilder maxParallelization(int n)
```
    Set the maximum parallelization (max width per node). Defaults to 2.
    
    Parameters:
    
    n - the "max width per node" parallelization option.
    
    Returns:
    
    this builder
  - clusterSize
```
public ClusterFixtureBuilder clusterSize(int n)
```
    The number of Drillbits to start in the cluster.
    
    Parameters:
    
    n - the desired cluster size
    
    Returns:
    
    this builder
  - withBits
```
public ClusterFixtureBuilder withBits(String... bitNames)
```
    Define a cluster by providing names to the Drillbits. The cluster size is the same as the number of names provided.
    
    Parameters:
    
    bitNames - array of (unique) Drillbit names
    
    Returns:
    
    this builder
  - withLocalZk
```
public ClusterFixtureBuilder withLocalZk()
```
    By default the embedded Drillbits use an in-memory cluster coordinator. Use this option to start an in-memory ZK instance to coordinate the Drillbits.
    
    Returns:
    
    this builder
  - withLocalZk
```
public ClusterFixtureBuilder withLocalZk(int count)
```
  - withRemoteZk
```
public ClusterFixtureBuilder withRemoteZk(String connStr)
```
  - withZk
```
public ClusterFixtureBuilder withZk(ZookeeperHelper zk)
```
    Run the cluster using a Zookeeper started externally. Use this if multiple tests start a cluster: allows ZK to be started once for the entire suite rather than once per test case.
    
    Parameters:
    
    zk - the global Zookeeper to use
    
    Returns:
    
    this builder
  - saveProfiles
```
public ClusterFixtureBuilder saveProfiles()
```
    Enable saving of query profiles. The only way to save them is to enable local store provider writes, which also saves the storage plugin configs.
    
    Returns:
    
    this builder
  - build
```
public ClusterFixture build()
```
    Create the embedded Drillbit and client, applying the options set in the builder. Best to use this in a try-with-resources block:
```
 FixtureBuilder builder = ClientFixture.newBuilder()
   .property(...)
   .sessionOption(...)
   ;
 try (ClusterFixture cluster = builder.build();
      ClientFixture client = cluster.clientFixture()) {
   // Do the test
 }
 
```
    Note that you use a single cluster fixture to create any number of drillbits in your cluster. If you want multiple clients, create the first as above, the others (or even the first) using the ClusterFixture.clientBuilder(). Using the client builder also lets you set client-side options in the rare cases that you need them.
  - buildCustomMockStorage
```
public ClusterMockStorageFixture buildCustomMockStorage()
```

Class ClusterFixtureBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ZK_REFRESH

configBuilder

sessionOptions

systemOptions

bitCount

bitNames

localZkCount

zkHelper

usingZk

clientProps

dirTestWatcher

Constructor Detail

ClusterFixtureBuilder

ClusterFixtureBuilder

Method Detail

configBuilder

configResource

setOptionDefault

configProperty

putDefinition

configClientProperty

sessionOption

systemOption

maxParallelization

clusterSize

withBits

withLocalZk

withLocalZk

withRemoteZk

withZk

saveProfiles

build

buildCustomMockStorage