StreamBase Server Configuration File XML Reference

The following UNIX example assumes that you have given a value to the STREAMBASE_HOME environment variable:

<global>
  <plugin directory="/usr/share/sbplugins" />
  <plugin file="/home/sbuser/sbproject/waycooloperator.so" />
  <module-search directory="/usr/share/sbapps" />
  <operator-resource-search directory="${STREAMBASE_HOME}/resourceFiles" />
  <ignore-unbound-captures/>
</global>

Back to top ^

Identifies a native code library in the form of a DLL file for Windows or a .so file for UNIX, that contains the implementation of one or more custom simple or aggregate functions to be loaded when the application runs. You can have as many plug-in elements as you need, each identifying a different library. For custom C++ functions, each function name must also be declared in a <custom-functions>.

Do not confuse the <global/plugin> element with the <java-vm/library> element, which also specifies native code libraries to load. Use <plugin> to specify native libraries that contain C++ functions custom-written for your organization. Use <library> to specify native libraries called by Java functions, adapters, or JDBC drivers, possibly written and provided by third parties.

Identifies a directory containing EventFlow or StreamSQL application modules to be called and used by the top-level module at run time. These external modules then can be referenced using a module reference in an EventFlow application, or an APPLY statement in a StreamSQL application.

StreamBase Studio maintains its own module search path as described in module search path in the Authoring Guide. Studio appends entries specified in <global/module-search> elements in the server configuration file, after reconciling relative paths, as described in How StreamBase Studio Uses Server Configuration Files in the Administration Guide.

TIBCO recommends deploying your StreamBase applications by bundling your Studio project and running the bundle file as an argument to the sbd command. Running a bundle has the advantage of preserving the Studio module search path (supplemented as necessary by <module-search> entries in the configuration file), plus the resource search path and Java build path, all in a runnable format.

To run an application from the sbd command line without the benefit of a bundle, you must specify each module-containing directory with <module-search> elements, even if that means re-specifying the Studio module search path.

See Module Search Path Order of Precedence to understand how StreamBase locates module files.

Specifies a directory containing resource files used by Java operator and adapter code at run time. File resources might include text files, SQL files, CSV data files from which to load tables or feed simulations, or other file types.

StreamBase Studio maintains its own resource search path as described in resource search path in the Authoring Guide. Studio appends entries specified in <global/operator-resource-search> elements in the server configuration file, after reconciling relative paths, as described in How StreamBase Studio Uses Server Configuration Files in the Administration Guide.

TIBCO recommends deploying your StreamBase applications by bundling your Studio project and running the bundle file as an argument to the sbd command. Running a bundle has the advantage of preserving the Studio module search path, resource search path, and Java build path in a runnable format.

To run an application from the sbd command line without the benefit of a bundle, you must specify each resource-containing directory with <operator-resource-search> elements, even if that means re-specifying the Studio resource search path.

See Module Search Path Order of Precedence to understand how StreamBase locates resource files. The search path order for modules also applies to locating resources on the resource search path.

StreamBase's default behavior is to fail typechecking when an unbound capture is detected. An unbound capture occurs when an input stream of a module is implemented with a capture field and that input stream is not connected to an input port of the calling Module Reference in the parent application. This situation results in an error because there is no schema to examine or fields to capture for the unbound capture instance.

This existing behavior is preserved to maintain compatibility with pre-7.6.0 previous releases. However, when you are certain your unbound captures are benign, you can optionally suppress the resulting typecheck errors. To do this, use this option in the StreamBase server configuration file syntax:

 <global><ignore-unbound-captures/></global>

<server>
    <param name="tcp-port" value="10100"/>
    <param name="connection-backlog" value="12"/>
    <param name="datadir" value="/tmp/112233/querytable/last10stocks"/>    
    <param name="disk-querytable-cache" value="256"/>
    <param name="disk-querytable-transaction_mode" value="1"/>
    <param name="disk-querytable-flush-interval-ms" value="40000"/>  
</server>

Back to top ^

In the following configuration example, the administrator decided to double the max-client-pages value from its 2048 default, resulting in a 16 MB page buffer for all dequeuing client connections:

<page-pool>
  <param name="page-size" value="4096" />
  <param name="max-client-pages" value="4096" />    
</page-pool>

For related details, see the <java-vm> section below.

Back to top ^

<runtime>
  <param name="schema-max-size" value="1048576"/>
  <param name="now-implementation" value="system"/>  
</runtime>

Back to top ^

To use a custom C++ function in your StreamBase application, you must:

In the following example, a custom C++ function named func1 takes a string and an int argument and returns a string:

<custom-functions>
    <custom-function name="func1" type="simple" >
      <args>
        <arg type="int" />    
        <arg type="string" /> 
      </args>
      <return type="string" />
    </custom-function>
</custom-functions>

Add the alias attribute to allow the use of a short name or alternate name for a given function. For example, the following allows you to call the func1 function (from the example above) in StreamBase expressions in the form f(myString, myInt):

<custom-functions>
    <custom-function name="func1" type="simple" alias="f">
      <args>
      ... [same as example above]

The language attribute in the above examples is the default, which is the same as specifying language="cplusplus".

Use the <args> and <return> elements to describe the data types of the function's arguments and return types. For C++ functions, you must register each argument and return type. If the type attribute of an <arg> or <return> element is list or tuple, the element must have a child element that further describes the type. For tuple types, this is a <schema> element. For list types, this is an <element-type> element. For example:

<args>
  <arg type="tuple">
    <schema>
      <field name="f1" type="int" />
      <field name="f2" type="double" />
    </schema>
  </arg>
  <arg type="list">
    <element-type type="string" />
  </arg>
</args>
<return type="list">
  <element-type type="tuple">
    <schema>
      <field name="g1" type="blob" />
      <field name="g2" type="timestamp" />
    </schema>
  </element-type>
</return>

The example above describes the arguments to a function that takes:

The example returns:

Back to top ^

Unlike C++ functions, you do not need to add a <custom-function> element for every Java function. A <custom-function> element is required under two circumstances:

For simple Java functions that you expect to use in limited cases, it may be simpler to call it with calljava() than to define a <custom-function> element.

To use a custom Java function in your StreamBase application, you must:

Java functions that have a <custom-function> definition must have the alias attribute defined. If not defined, StreamBase Server starts but does not load the specified function, instead printing a notification message on the console that the function definition will be ignored. As an alternative, you can call a Java function using calljava(), without first specifying a <custom-functions> definition for that function.

When using <custom-function> to describe a custom Java function:

For Java functions only, as an alternative to explicitly specifying argument and return types, you can specify args="auto" to have StreamBase Server autodetect the argument and return types. If the server autodetects overloaded functions of the same name with different argument types, it adds all detected versions of the specified function.

Java functions typically use the args="auto" attribute. If you do not use args="auto" for a Java function, then you must specify <arg> and <return> elements to describe each argument and return type, using the syntax described above for C++ functions. You might use <arg type=> instead of args="auto" if your function has many overloaded signatures, and you only want to expose a subset of those signatures for use in your StreamBase application.

If your Java function has an argument or return value of type list or tuple, and you use args="auto", then you must provide a custom function resolver as described on Custom Functions with Complex Data Types. If you use explicit <arg type=> elements, you do not need to provide a custom function resolver.

The following example shows a typical definition for a Java function:

<custom-functions>
  <custom-function 
    language="java" 
    class="com.streambase.sb.sample.Hypotenuse" 
    name="calculate" 
    alias="hypotenuse"
    type="simple" 
    args="auto" />
</custom-functions>

You can specify an alias for any Java function in the server's classpath, including standard library functions:

<custom-functions>
  <custom-function 
    language="java" 
    class="java.lang.Math" 
    name="toDegrees" 
    alias="degrees" 
    args="auto" />
</custom-functions>

You can use the same string for name and alias. Using the same string allows you to call a function directly by its original name. For example, the following allows you to call log10() in a StreamBase expression:

<custom-functions>
  <custom-function 
    language="java" 
    class="java.lang.Math" 
    name="log10" 
    alias="log10" 
    args="auto" />
</custom-functions>

Back to top ^

Each simple or aggregate C++ function must be declared in a <custom-function> element, as described above in C++ Function Overview. Java functions can be optionally declared in a <custom-function> element, as described in Java Function Overview.

C++ and Java functions can be assigned aliases. You can use the aliased function name as if that function were embedded in your StreamBase application. For example, setting alias="foo" means you can invoke foo(arg) in a StreamBase expression instead of calljava(foo(arg)) or callcpp(foo(arg)).

The <custom-function> element has the following child elements:

Back to top ^

For Java functions, you can set the args="auto" attribute of the <custom-function> element to have StreamBase Server autodetect the argument types. In this case, do not use the <args> element. You can optionally use <args> for Java functions as described in Java Function Overview.

For C++ functions, you must use an <args> element with <arg> child elements for each of the function's arguments.

The <args> element has the following child element:

Back to top ^

Defines the data type returned by a C++ or Java function. For C++ functions, this element is required if the function returns a value.

For Java functions only, setting the args="auto" attribute of the <custom-function> element autodetects the return type as well as the argument types. Thus, when using args="auto", no <return> element is required.

The <return> element has the following child elements:

Back to top ^

Defines the data type of one of a function's arguments. The order of <arg> elements in the configuration file should match the argument order for the function.

The <arg> element has the following child elements:

Back to top ^

Defines the schema for a value when type="tuple" for the <arg>, <return>, <element-type>, or <field> elements. The <schema> element has one child element:

Defines the data type for a single field in a tuple.

The <field> element has the following child elements:

Back to top ^

Defines the data type for the elements of a list when type="list" for the <arg>, <return>, <element-type>, or <field> elements.

The <element-type> element has the following child elements:

Back to top ^

This element specifies a constant value to be used at runtime in place of an original value. Substitution and typechecking takes place during initialization of the application. The element has two required attributes:

Using the above example, a configuration file could specify a new file name at run time by including:

<streambase-configuration>
    ...
    <constants-overwrite>
        <constant-overwrite name="FileName" value="&quote;deploy.csv&quote;"/>
        <constant-overwrite name="timeoutMs" value="250"/>
    </constants-overwrite>
    ....
</streambase-configuration>

The &quote; sequences are required around string values for proper interpretation.

Back to top ^

You can add or remove choices from a <adapter-configurations> element and change their content at will. You can also nest alternatives in arbitrarily named sub-elements to partition them as needed. For example, here is the <adapter-configurations> section of the configuration file for the Configuration File Access Sample, which happens to contain a sub-element named <configuration>. That element has two <choice> sub-elements that indirectly select strings provided in <text> elements:

  <adapter-configurations>
    <configuration type="ConfigBasedOperatorSample">
  <!-- See ConfigBasedOperatorSampleBeanInfo for how Studio displays these two choices to the user -->
      <choice id="choice-1" value="First choice" />
      <choice id="choice-2" value="Second choice" />
  <!-- See ConfigBasedOperatorSample#typecheck for how the operator retrieves one of these -->
      <text id="First choice">
         0
      </text>
      <text id="Second choice">
         1
      </text>
    </configuration>
  </adapter-configurations>

As mentioned above, the names of elements and how they are structured are arbitrary. Here, the <choice> id attributes are the menu items that the widget displays to users. If the menu included a third item, you would insert a new <choice> and a corresponding <text> element. For example:

<adapter-configurations>
    <configuration type="ConfigBasedOperatorSample">
  <!-- See ConfigBasedOperatorSampleBeanInfo for how Studio displays these two choices to the user -->
      <choice id="choice-1" value="First choice" />
      <choice id="choice-2" value="Second choice" />
      <choice id="choice-3" value="Third choice" />
  <!-- See ConfigBasedOperatorSample#typecheck for how the operator retrieves one of these -->
      <text id="First choice">
         0
      </text>
      <text id="Second choice">
         1
      </text>
      <text id="Third choice">
         2
      </text>
    </configuration>
  </adapter-configurations>

The chooser for this property is typically a pull-down choice menu that lists a set of alternative strings corresponding to the child elements. Choices are SBPropertyDescriptors accessed through a ConfigurationChooserPropertyDescriptor in a SBSimpleBeanInfo class file. ConfigBasedOperatorSampleBeanInfo.java in the sample application creates a choice menu for a property descriptor that is labeled "Choose one":

package com.tibco.streambase.sample;

import java.beans.IntrospectionException;

import javax.xml.xpath.XPathExpressionException;

import com.streambase.sb.operator.parameter.ConfigurationChooserPropertyDescriptor;
import com.streambase.sb.operator.parameter.SBPropertyDescriptor;
import com.streambase.sb.operator.parameter.SBSimpleBeanInfo;

public class ConfigBasedOperatorSampleBeanInfo extends SBSimpleBeanInfo {

  public SBPropertyDescriptor[] getPropertyDescriptorsChecked()
    throws IntrospectionException {
  
  try {
    ConfigurationChooserPropertyDescriptor ccpd =
      new ConfigurationChooserPropertyDescriptor("configElement",
        "configuration[@type='ConfigBasedOperatorSample']/choice/@id",
        ConfigBasedOperatorSample.class);
    ccpd.displayName("Choose one:");
    SBPropertyDescriptor[] p = { ccpd };
    return p;

    } catch (XPathExpressionException e) {
      throw new RuntimeException(e);
    }
  }
}

At runtime, the adapter or operator Java code retrieves the configuration file elements with getOperatorConfigurationAccessor(), as in the sample's code (unrelated blocks and exception handling code elided) shown below:

private String configElement;
private String valueFound;
...
NodeList blocks = getOperatorConfigurationAccessor().getConfigurationBlocksAsXML(
MessageFormat.format("configuration[@type=\"ConfigBasedOperatorSample\"]/choice[@id=\"{0}\"]",
  getConfigElement()));
...
NamedNodeMap attributes = blocks.item(0).getAttributes();
...
Node valueAttr = attributes.getNamedItem("value");
...
String selValue = valueAttr.getNodeValue();
NodeList textBlocks = getOperatorConfigurationAccessor().getConfigurationBlocksAsXML(
  MessageFormat.format("configuration[@type=\"ConfigBasedOperatorSample\"]/text[@id=\"{0}\"]",
  selValue));
...
valueFound = textBlocks.item(0).getTextContent();

The retrieved property descriptor is created with an XPath expression that selects XPathConstants.NODESET and is expected to return a list of attribute nodes, whose values are presented to the user to select from. The value selected (or entered) is set to a String property type. Then, in the processTuple method, out.setString() overrides a field value, in this case the first field (0), with the retrieved property value:

public void processTuple(int inputPort, Tuple tuple)
      throws StreamBaseException {
    assert configElement != null;

    Tuple out = outputSchemas[inputPort].createTuple();

    for (int i = 0; i < out.getSchema().getFieldCount(); ++i) {
      out.setField(i, tuple.getField(i));
    }
  out.setString(0, valueFound.trim());
  sendOutput(0, out);
}

In the sample application, values are prepared at typecheck time, but you can use the getOperatorConfigurationAccessor API at runtime as well.

Back to top ^

<sbmonitor>
    <param name="enabled" value="true"/>
    <param name="period-ms" value="2000"/>
</sbmonitor>

Back to top ^

<security>
  <ssl-authentication>
    <param name="keystore" value="../test/proxy/security/signed.keystore"/>
    <param name="keystore-password" value="secret"/>
    <param name="key-password" value="secret1"/>
    <param name="enabled" value="true"/>
  </ssl-authentication>

  <param name="perform-authentication" value="false"/>

  <transform-principal>
    <param name="searchRegexp" value="cn=([^,]*).*"/>
    <param name="replaceRegexp" value="$1"/>
  </transform-principal>

  <client-ssl-connections>
    <param name="require-client-authentication" value="true"/>
    <param name="cipher-suite" value="SSL_RSA_WITH_3DES_EDE_CBC_SHA"/>
  </client-ssl-connections>

  <ldap>
    <!-- a TLS auth server -->
    <server host="parallels" port="838">
      <param name="principal-root" value="ou=Users,dc=example,dc=com"/>
      <param name="principal-search" value="cn={0}"/>
      <param name="keystore" value="ldapuser.keystore"/>
      <param name="keystore-password" value="secret"/>
      <param name="key-password" value="secret1"/>
    </server>
  </ldap>

  <ldap>
    <!-- a basic auth server -->
    <server host="parallels" port="839">
      <param name="principal-root" value="ou=Users,dc=example,dc=com"/>
      <param name="principal-search" value="cn={0}"/>
      <param name="root-dn" value="cn=Manager,dc=example,dc=com"/>
      <param name="password" value="secret"/>
    </server>
  </ldap>

  <role name="StreamBaseSuperuser">
    <param name="action" value="Administrate"/>
  </role>

  <role name="InnocentBystander">
    <param name="action" value="Status"/>
    <param name="action" value="Enqueue default.InputStream1"/>
    <param name="action" value="Dequeue default.OutputStream1"/>
  </role>

  <user-data>
    <user>
      <param name="cn" value="cn=Alice Pleasance Liddell,ou=Users,dc=example,dc=com"/>
      <param name="role" value="InnocentBystander"/>
      <param name="role" value="StreamBaseSuperuser"/>
      <param name="password" value="secret"/>
    </user>
    <user>
      <param name="cn" value="EMAILADDRESS=bobn@streambase.com, CN=Bob Newhart, 
        OU=Users, O=TIBCO StreamBase, L=Waltham, ST=Massachusetts, C=US"/>
      <param name="role" value="InnocentBystander"/>
    </user>
  </user-data>

</security>

Back to top ^

Specifies the keystore that holds the signed X.509 server certificate that will be used for SSL connections between clients and the sbproxy server.

<ssl-authentication> has the following child elements:

Back to top ^

Defines a search/replace regular expression that will change the name of the principal. The transform in the preceding security example extracts the CN section from the entire principal's name as it appears in a certificate.

<transform-principal> has the following child elements:

Back to top ^

Defines the type of SSL connection and the external tools used for encryption.

<client-ssl-connections> has the following child elements:

Back to top ^

Specifies information for connecting to and searching LDAP servers to manage user authentication. Create a separate <ldap> element for each LDAP server. If more than one LDAP server is defined, the requests will be sent to each LDAP server in turn, in a round-robin manner. You can configure one or more LDAP servers.

<ldap> has the following child elements:

Back to top ^

Use the role element to define a role and assign its actions. You can define any number of roles and use any role names, each with a different combination of actions. Later (in the user-data element) you can assign users to roles.

When a client attempts to perform an action, such as dequeue OutputStream1, the user is authenticated, then the authentication source (an LDAP server or a user-data in the sbconf file) is asked for all of the roles the user has. If the user has as role which has the dequeue default.OutputStream1 action listed, then the dequeue operation is allowed.

<role> has the following child elements:

Back to top ^

Defines the Principal-to-role mapping for each user. This section should not be defined if an <ldap> section is defined.

<user-data> has the following child elements:

Back to top ^

<authentication>
    <param name="enabled" value="true"/>
    <param name="type" value="sb-password-file"/>
    <param name="filepath" value="/opt/tibco/sb-cep/n.m/etc/sbpasswd"/>
</authentication>

Back to top ^

<high-availability>
  <param name="leadership-status" value="LEADER"/>
  <param name="enabled" value="auto"/>
  <ha-application>
    <param name="HB_OTHER_SERVER" value="name_of_other_server"/>
    <param name="HB_PORT" value="12345"/>
    <param name="HB_TIMEOUT" value="3000"/>
    <param name="HB_INTERVAL" value="1000"/>
    <param name="HB_RECON_ATTEMPTS" value="10"/>
    <param name="HB_RECON_SLEEP" value="500"/>
  </ha-application>
  <table-replication>
    <param name="HB_OTHER_SERVER" value="name_of_other_server"/>
    <param name="REPL_OTHER_SERVER_PORT" value="6789"/>
    <param name="REPL_CHECK_INTERVAL" value="1"/>
    <param name="REPL_BATCH_SIZE" value="100"/>
    <param name="REPL_RECONNECT_INTERVAL" value="250"/>
  </table-replication>
</high-availability>      

Back to top ^

The following shows a complete example of the <java-vm> top-level element with all of its child elements in use.

<java-vm>
  <param name="java-home" value="/usr/lib/java" />
  <param name="jvm-args" value="
    -Xms1024m -Xmx4096m     
    -XX:+UseG1GC
    -XX:MaxGCPauseMillis=500 
    "/>
  <jar file="/usr/lib/calcs/othercalcs.jar" />
  <jar file="./Resources/ojdbc14.jar" />
  <dir path="./java-bin" />
  <dir path="/usr/share/maths/classes" />
  <library path="/usr/lib/vendor/lib/" />
  <sysproperty name="streambase.tuple-charset" 
    value="UTF-8" />
  <sysproperty name="codegen.intermediate-stream-dequeue" 
    value="true" />
</java-vm>

Back to top ^

The <java-vm> element accepts zero or one of the <param> child element for each of the name-value pairs in the following table:

<java-vm>
  <param name="java-home" 
    value="/usr/lib/java" />
</java-vm>

<java-vm>
  <param name="java-home" 
    value="C:/Program Files/Java/jdk1.8.0_60" />
</java-vm>

When you generate a default server configuration file in Studio and you opt to include the default contents, or when you generate a default configuration file with sbd –s, it contains the following settings for the <java-vm> element:

<java-vm>
  <param name="jvm-args" value="
    -Xms1024m -Xmx4096m     
    -XX:+UseG1GC
    -XX:MaxGCPauseMillis=500 
    "/>
</java-vm>

See Java VM Memory Settings and Garbage Collection Policy Settings for further discussions of these settings.

Back to top ^

Specifies a JAR file to be loaded at runtime, used by a Java Operator or by a JDBC data source server. Required within a parent <java-vm> element when Java operators or JDBC tables are used in the StreamBase application. You can specify multiple JAR files, as shown in the <java-vm> example.

You can specify multiple <jar> elements. One <jar> element specifying the path to a JDBC driver is required when using a JDBC Table data construct.

The <jar> element has the following attribute:

Examples:

<java-vm>
  <jar file="./Resources/ojdbc14.jar" />
  <jar file="/usr/lib/calcs/othercalcs.jar" />
</java-vm>

Back to top ^

Use the <dir> element to add a directory to the classpath of the JVM that runs StreamBase Server. You can use multiple <dir> elements.

The <dir> element has the following attribute:

Examples:

<java-vm>
  <dir path="./java-bin" />
  <dir path="/usr/share/maths/classes" />
</java-vm>

Back to top ^

Use the <library> element to specify the path to a directory that will be prepended to the JVM's java.library.path to identify the location of native libraries used by your Java code, by an adapter, or called by JDBC drivers. The directory you specify is expected to contain one or more DLL files for Windows or .so files for UNIX. To load multiple library sets, use multiple <library> elements. See <java-vm> for an example.

Do not confuse the <java-vm/library> element with the <global/plugin> element, which also specifies native code libraries to load. Use <plugin> to specify native libraries that contain C++ functions custom-written for your organization. Use <library> to specify native libraries called by Java functions, adapters, or JDBC drivers, possibly written and provided by third parties.

The <library> element has the following attribute:

Example for UNIX:

<java-vm>
  <library path="/usr/lib/vendor/lib" />
</java-vm>

Example for Windows:

<java-vm>
  <library path="C:/Program Files/vendor/lib" />
</java-vm>

Back to top ^

Use the <sysproperty> element as an alternative to adding system properties with the jvm-args parameter of the <java-vm> element. You can only specify one jvm-args parameter, so in order to add a system property with it, you must append the property setting to the jvm-args parameter. By contrast, you can add as many <sysproperty> elements as you need, each one specifying an individual property.

The <sysproperty> element has the following attributes:

Examples:

<java-vm>
  <sysproperty name="streambase.tuple-charset" 
    value="UTF-8" />
  <sysproperty name="codegen.intermediate-stream-dequeue" 
    value="true" />
</java-vm>

Back to top ^

The following shows three examples of <data-sources> sections of the server configuration file, illustrating three different database connections. First, a connection to a MySQL database:

<data-sources>
  <data-source name="MYSQL" type="jdbc">
    <driver value="com.mysql.jdbc.Driver"/>
    <uri value="jdbc:mysql://mysql.example.com:3306/qa?user=username&amp;password=secret"/>
    <param name="jdbc-reconnect-regexp" value="Communications link failure"/>
    <param name="jdbc-reconnect-regexp" value="Connection reset"/>
    <param name="jdbc-reconnect-attempts" value="5"/>
    <param name="jdbc-reconnect-sleep" value="250"/>
  </data-source>
</data-sources>

Next, a connection to an Oracle 10g database, using an enciphered connection password:

<data-sources>
  <data-source name="Oracle_10g" type="jdbc">
    <driver value="oracle.jdbc.driver.OracleDriver"/>
    <uri value="jdbc:oracle:thin:@orasrv.example.com:1521:sb_test"/>
    <param name="user" value="orauser"/>
    <param name="password" enciphered="true"
      value="M5DSWylszg5aA9AK29MOiaDLq7SMqmTor+nW3qURTrT9E9eqJfTPyyUudCK34nhXHE53PXK6pregp4MW8qrueg=="/>
    <param name="jdbc-fetch-size" value="10000"/>
    <param name="jdbc-batch-size" value="20"/>
    <param name="jdbc-max-column-size" value="32768"/>
    </data-source>
</data-sources>

Finally, a JDBC connection to a Vertica database. (StreamBase also supports high-performance loading of a Vertica database using non-JDBC native API connectivity.)

<data-sources>
  <data-source name="Vertica" type="jdbc">
    <driver value="com.vertica.Driver"/>
    <uri value="jdbc:vertica://MyHost:5433/chron_vertica"/>
    <param name="user" value="vertigo"/>
    <param name="jdbc-share-connection" value="true"/>
    <param name="jdbc-quote-strings" value="true"/>
  </data-source>
</data-sources>

Back to top ^

This element identifies a database server to be used as a data source and accessed from an EventFlow or StreamSQL application. This element specifies the JDBC driver, the JDBC connection string that identifies the server's location, and one or more JDBC connection parameters.

<data-source> has the following child elements:

Identifies the database driver's Java class.

See examples of the driver element in <data-source> Examples below.

Back to top ^

Use the <uri> element to specify the JDBC connection string appropriate for your database and server location. Each supported database has its own syntax for JDBC connection strings. You must obtain the correct connection string syntax from your database vendor, possibly from a README file distributed with the JAR file that implements the vendor's JDBC support. Use the examples in <data-sources> Examples as general guidelines for constructing your site's JDBC connection string.

jdbc:vendorname://server-address:port

Back to top ^

The <param> child element of the <data-source> element has the attributes shown in the following table. See <data-sources> Examples for examples of the <param> element used in the context of several <data-source> elements. These elements only affect Query operator access to a JDBC database through the JDBC Table data construct. They do not affect feed simulations that take input data from JDBC data sources.

The following table lists the possible values for the name attribute, with the corresponding values for each:

<param name="jdbc-timeout" value="25000"/>

Back to top ^

Use this element to declare global operator parameters and assign them a default value. Parameters are defined as name-value attribute pairs, with the name attribute being a simple name such as ParamOne.

Assign a value to ParamOne for two purposes:

You can set the value of an <operator-parameter> to the value of a system environment variable whose value is resolved at StreamBase Server startup time. However, if the specified system variable is not set or not present, StreamBase Server can fail to start. In this case, you can use the colon-equals syntax described in Environment Variables and the Colon-Equals Syntax.

Specify the following name-value attribute pair:

See String Values in Parameters for TIBCO' recommended policy on quoting string parameters.

Examples:

<operator-parameters>
  <operator-parameter name="MyStringParam" value="somestring"/>
  <operator-parameter name="MyIntParam" value="2"/>
  <operator-parameter name="ContainerName.OperatorName.ParamName"
    value="120" />
</operator-parameters>

Applying this example, the following expressions could be used:

SELECT * FROM SourceTagger_1
    "${MyStringParam}" AS source
    ...
    WHERE myint > ${MyIntParam}

<operator-parameter name="Host" value="${STREAMBASE_SERVER}"/>

Or use the colon-equals syntax to specify a default value for the environment variable:

<operator-parameter name="Host" value="${STREAMBASE_SERVER:=sb://sbhost:9900}"/>

Back to top ^

<error-handler>
    <error type="eval-error" action="shutdown" />
    <error type="eval-plugin-error" action="shutdown" />
</error-handler> 

Defines a single error type for the error handler. Use multiple error elements to define multiple error types, as shown in the <error-handler> example.

Back to top ^

The <type> element accepts one of two values:

Use the <target-time> element to specify a timestamp to be used as the starting point reference time of a test to be run as a StreamBase JUnit test. Timestamp values set in this element are ignored if the <type> element specifies WALLCLOCK, or is absent. That is, <target-time> is only recognized when accompanied by <type>CONTROLLABLE</type>.

Specify the timestamp value with format string patterns as used in the format_time() expression language function (which is itself based on the java.lang.SimpleDateFormat class). The <target-time> element is optional; if unspecified when CONTROLLABLE type is specified, the reference start time of the JUnit test is the actual start time of the module.

Back to top ^