JDBC interface
.See: Description
Interface | Description |
---|---|
StreamingPreparedStatement |
Aspen streaming prepared statement interface.
|
StreamingResultSet | |
StreamingStatement |
SQLstream streaming statement interface.
|
Class | Description |
---|---|
Driver |
Implements the SQLstream client side of
the
Driver interface. |
Enum | Description |
---|---|
StreamingResultSet.RowEvent |
Exception | Description |
---|---|
TimeoutException |
TimeoutException is thrown when a JDBC operation
has exceeded a timeout limit.
|
Provides SQLstream JDBC driver and public SQLstream extensions
to the standard JDBC interface
.
Java class | com.sqlstream.jdbc.Driver |
---|---|
JDBC URI | jdbc:sqlstream: |
The SQLstream JDBC driver implements Driver
and
user applications can load it in any of the standard ways:
jdbc.drivers
Class.forName("com.sqlstream.jdbcDriver")
DataSource
configuration (see below)
The SQLstream JDBC driver connect string has the following format:
jdbc:sqlstream://host[:port];[attribute=value];...
The syntax conforms to the OLE DB spec.
The "authority" portion of the URI, //host[:port]
,
refers to the SQLstream Control Node:
Control Node | |
---|---|
host | Address of the control node. Might be a local name ("yourhost"), fully-qualified name ("yourhost.domain.com") or IP address ("64.81.65.21"). The default value is "localhost". |
port | Port of the control node. Since the SQLstream JDBC driver uses Java RMI for control purposes, this will be the port on which the RMI server is listening. The default value is 5435. |
The following attributes are allowed:
Attribute | Value |
---|---|
user | DB Username |
password | DB Password |
sessionName | Name of session, e.g. "A/P Transaction Filter" |
clientUserName | OS login name, e.g. "fjfarrago" |
clientUserFullName | full name, e.g. "Franklin J. Farrago" |
clientProgramName | Name program making the connection, e.g. "Accounts Payable" |
clientProcessId | Process ID of program making the connection, e.g. "12345" |
Here is a connect string that uses the default host and port but supplies all the above sample attributes:
jdbc:sqlstream:;user=someuser;password=somepass;
sessionName=A/P Transaction Filter;clientUserName=fjfarrago;
clientUserFullName="Franklin J. Farrago";
clientProgramName='Accounts Payable';clientProcessId=12345
The example illustrates the use of several quoting styles, but none
of these sample attribute values require any quoting.
Refer to
OLE DB spec for complete syntax rules.
If the application uses Driver.connect(String, Properties)
or DriverManager.getConnection(String, Properties)
, then
any connection attribute can instead be supplied as an entry in a
Properties
object.
An attribute on the URI takes precedence over
the same-named attribute in the Properties object.
A more typical example might be to supply just the optional host and port on the connect string,
jdbc:sqlstream://yourhost:1234
and then to supply the username and password credentials
plus any other connection attributes in the Properties object.
In the following table,
required values are shown in monospace
typeface
and user-configurable sample values are shown in italic typeface.
resource name | jdbc/SQLstream/node1 |
---|---|
resource type | javax.sql.DataSource |
resource factory | com.sqlstream.jdbc.DataSourceFactory |
driver class | com.sqlstream.jdbc.Driver |
url | jdbc:sqlstream: |
username | name |
password | pass |
The optional control node specification (//host:port) and any applicable connection attributes must be supplied on the url string.
Copyright (C) 2003-2021 SQLstream, Inc.