Using the JDBC Table Data Construct

A JDBC Table is a data construct that enables a StreamBase application to read from, write to, update, and query an external, persistent JDBC data source. When connected to a JDBC Table, a Query operator can manipulate the JDBC data together with tuples from the application's input streams. JDBC Tables can be associated with multiple Query operators, but each Query operator can be associated only with one JDBC Table.

This topic describes the configuration options for each tab of the JDBC Table's Properties view. To connect a JDBC Table data construct to an actual JDBC data source, you must declare the data source in the server configuration file for your Studio project and add the path to the JDBC driver's JAR file, as described in JDBC Data Source Overview.


JDBC Query operators that specify a SELECT statement generate a typecheck error when working in an environment that does not have a current connection to the database server. As a workaround, you can specify an explicit schema for the SQL query in the operator's Result Settings tab.

If you anticipate having database connectivity when composing the EventFlow module, but none later, use the Execute query and populate fields link in the JDBC Query operator. This derives the schema from running the SQL query and stores the schema for use when the operator cannot reach its configured database.

Affected Components Link

At the top of the Properties view for a JDBC Table data construct, there is an Affected Components link. Click this link to display a pop-up window that lists the Query operators in the current module that are associated with the selected JDBC Table. Click anywhere outside the pop-up to close the pop-up.

The following example shows an Affected Components pop-up window for the BikesOrder JDBC Table in the JDBCQuery.sbapp sample included in StreamBase.

Properties: General Tab

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Properties: Data Source Tab

In the Data Source tab, select the JDBC data source you want to use from the dropdown list. The list contains the name of every JDBC data source declared in the <data-sources> section of the current project's server configuration file.

Use the configure sources link to open the project's server configuration file. If no configuration file exists for this project, clicking this link opens the New StreamBase Server Configuration File dialog to create a new, empty configuration file.


If you specify a data source name, but that data source's definition is incomplete in the server configuration file, the typechecking errors show up in the associated Query operators, not in the JDBC Table data construct itself.

You can also type a parameter name in parameter notation, such as ${ds}. This lets you pass in the name of a data source at runtime as a global parameter.