Client Tools Contents

<< Click to Display Table of Contents >>

Navigation:  Installing Blaze >

Client Tools Contents

Previous pageReturn to chapter overviewNext page

Client Tools Contents

Client Tools contains sqlline, mtsql, datagen, jdbc, Log File Agent, and WebAgent, as described below with links to further detail.

Tool

Description

Comments

sqlline

SQLLine is a command-line tool for communicating with the SQLstream s-Server or with other servers or databases, a generic & open-source database client that works with any jdbc database. More information about SQLLine can be found at: http://sqlline.sourceforge.net/

 

SQLLine can be used interactively or to read a script. Its command language is SQL: it reads SQL statements and sends them to the server, gets the results, and prints the results.

For the version in our client tools, the command line options are explained in the source file aspen/tools/sqlline. (See also the sqlline page in this manual.)

 

Note that a streaming query can take a long time to complete — maybe forever.

 

If SQLline executes a query, it prints all the rows in the result set.

mtsql

The tool mtsql is like sqlline, but can run several SQL clients at the same time, in parallel, in separate threads of execution.

 

You can use MTSQL to test and benchmark your applications by writing multi-threaded SQL scripts, synchronizing separate threads, and capturing output from each thread separately.

 

Each thread executes a list of commands, in the mtsql language. The language is an extension of SQL which provides ways of coordinating the parallel clients.

The point of mtsql is that one script runs as several parallel, coordinated clients.

 

The command line options are simple and described in comments in aspen/tools/mtsql.

 

datagen

Datagen generates test data for SQLstream applications, and pushes the data into SQLstream using the SQLstream JDBC Driver.

 

The test data to be generated is described in XML files. DataGen processes DataSet and TupleRule XML definitions to generate streaming sample data for SQLstream.

See also the DataGen section of the Concepts Guide.

datagen/jdbc

JDBC (Java DataBase Connectivity) is a standard Java API for connecting to relational databases and other data sources that can produce relational data.

See also the JDBC Driver section of the Enterprise Interface Guide, for a discussion of JDBC in the SQLstream context, where it is used by applications to get data into or out of SQLstream.

Log File Agent

The Log File Agent is installed on a remote server to supply log file records generated on that server as input to a stream being generated on the SQLstream s-Server.

Logs that are generated from other servers, termed remote servers, can be input to streams using the SQLstream Log File Agent as described in its chapter at the indicated link.

 

Logs that are accessible directly from the server that hosts SQLstream can be input to streams directly through the use of the SQLstream Log File Adapter.

 

Application tracing uses a trace.properties file similar to that used by the SQLstream s-Server. An example properties file is included in the Client Tools zip file. See the description in the Application Tracing section of the Log File Agent topic in the Integration Guide and the sample trace.properties file in the Client Tools zip file. (See also the Tracing Parameters section of the Administration Guide.)

WebAgent

The Web Agent functions as a simple, miniature Web server. It accepts HTTP requests, sends these to s-Server, and returns JSON objects. See json.org for more details on JSON objects. SQLstream WebAgent is delivered as part of the SQLstream Client Tools, in the shell script webagent.sh.

WebAgent is used by a number of SQLstream applications, including StreamLab and s-Dashboard.

In order to use WebAgent with web applications, users need one of the following browsers.

 

* Microsoft Internet Explorer 11 (or later), Google Chrome 31 (or later), Mozilla Firefox 17 (or later), or Apple Safari 7 (or later).

Structure of the ClientTools.zip file

The following table shows the directory structure and contents of the ClientTools.zip file, with links to further descriptions for DATAGEN, JDBC, the Log File Agent, and how the trace.properties file is used.

Directory

Next-level Contents

Next-level Contents

bin/

mtsql

sqlline

 

datagen

 

 

datagen/conf/

datagen.properties

DataSet.xsd

TupleRule.xsd

trace.properties

 

datagen/conf/

sample/

sales.bids.linear.embedded.set.xml

sales.bids.linear.row.xml

sales.bids.linear.set.xml

sales.bids.random.row.xml

sales.bids.random.set.xml

datagen/doc/api/

allclasses-frame.html?toc=0

allclasses-noframe.html?toc=0

constant-values.html?toc=0

deprecated-list.html?toc=0

help-doc.html?toc=0

index-all.html?toc=0

index.html?toc=0

overview-summary.html?toc=0

overview-tree.html?toc=0

package-list

serialized-form.html?toc=0

 

datagen/doc/api/com/

sqlstream/

datagen

AbstractDataRule.html?toc=0

AbstractParser.html?toc=0

CompoundDataRule.html?toc=0

DataGenerator.html?toc=0

DataGeneratorTest.html?toc=0

DataRule.html?toc=0

DataSet.CommitMode.html?toc=0

Dataset.html?toc=0

DataSet.PunctDeliveryStyle.html?toc=0

DataSet.TupleDeliveryStyle.html?toc=0

DataSetParser.html?toc=0

DataSink.html?toc=0

DoubleDataRule.html?toc=0

LongDataRule.html?toc=0

package-frame.html?toc=0

package-summary.html?toc=0

package-tree.html?toc=0

ParserTest.html?toc=0

RelativeDate.html?toc=0

StreamDataSink.html?toc=0

StringDataRule.html?toc=0

TimeDataRule.html?toc=0

TupleGeneratorTest.html?toc=0

TupleRuleParser.html?toc=0

datagen/doc/api/com

sqlstream/images

DataSet_schema.png

TupleRule_schema.png

datagen/doc/api/com

sqlstream/resources

inherit.gif

datagen/lib

DataGen.jar

 

datagen/jdbc

DataSet_schema.png

TupleRule_schema.png

aspen-tools.jar

jline.jars

READMEs

sqlline.jars

SqlStreamJdbc.jars

SqlStreamJdbc_Complete.jar

 

Log File Agent

 

 

Log File Agent/lib

LogFileAgent.jar

 

Log File Agent/trace

trace.properties