public class JDBCDriver
extends java.lang.Object
implements java.sql.Driver
The Java SQL framework allows for multiple database drivers.
The DriverManager will try to load as many drivers as it can find and then for any given connection request, it will ask each driver in turn to try to connect to the target URL.
The application developer will normally not need to call any function of the Driver directly. All required calls are made by the DriverManager.
When the HSQL Database Engine Driver class is loaded, it creates an instance of itself and register it with the DriverManager. This means that a user can load and register the HSQL Database Engine driver by calling:
Class.forName("org.hsqldb.jdbc.JDBCDriver")
For detailed information about how to obtain HSQLDB JDBC Connections,
please see JDBCConnection
.
Starting with JDBC 4.0 (JDK 1.6), the DriverManager
methods
getConnection
and getDrivers
have been
enhanced to support the Java Standard Edition Service Provider mechanism.
When built under a Java runtime that supports JDBC 4.0, HSQLDB distribution
jars containing the Driver implementation also include the file
META-INF/services/java.sql.Driver
. This file contains the fully
qualified class name ('org.hsqldb.jdbc.JDBCDriver') of the HSQLDB implementation
of java.sql.Driver
.
Hence, under JDBC 4.0 or greater, applications no longer need to explicitly
load the HSQLDB JDBC driver using Class.forName()
. Of course,
existing programs which do load JDBC drivers using
Class.forName()
will continue to work without modification.
JDBC 4.2 methods added in Java 8 are generally supported when the HSQLDB jar is compiled with JDK 8
JDBCConnection
Modifier and Type | Field and Description |
---|---|
static JDBCDriver |
driverInstance |
java.lang.ThreadLocal<JDBCConnection> |
threadConnection
As a separate instance of this class is registered with DriverManager
for each class loader, the threadConnection is not declared as static.
|
Constructor and Description |
---|
JDBCDriver()
Default constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsURL(java.lang.String url)
Returns true if the driver thinks that it can open a connection to
the given URL.
|
java.sql.Connection |
connect(java.lang.String url,
java.util.Properties info)
Attempts to make a database connection to the given URL.
|
static java.sql.Connection |
getConnection(java.lang.String url,
java.util.Properties info)
The static equivalent of the
connect(String,Properties)
method. |
int |
getMajorVersion()
Gets the driver's major version number.
|
int |
getMinorVersion()
Gets the driver's minor version number.
|
java.util.logging.Logger |
getParentLogger()
Return the parent Logger of all the Loggers used by this driver.
|
java.sql.DriverPropertyInfo[] |
getPropertyInfo(java.lang.String url,
java.util.Properties info)
Gets information about the possible properties for this driver.
|
boolean |
jdbcCompliant()
Reports whether this driver is a genuine JDBC Compliant™ driver.
|
public static final JDBCDriver driverInstance
public final java.lang.ThreadLocal<JDBCConnection> threadConnection
public java.sql.Connection connect(java.lang.String url, java.util.Properties info) throws java.sql.SQLException
Returns "null" if this is the wrong kind of driver to connect to the given URL. This will be common, as when the JDBC driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.
The driver throws an SQLException
if it is the right
driver to connect to the given URL but has trouble connecting to
the database.
The java.util.Properties
argument can be used to pass
arbitrary string tag/value pairs as connection arguments.
Normally at least "user" and "password" properties should be
included in the Properties
object.
For the HSQL Database Engine, at least "user" and "password" properties should be included in the Properties.
From version 1.7.1, two optional properties are supported:
get_column_name
(default true) - if set to false,
a ResultSetMetaData.getColumnName() call will return the user
defined label (getColumnLabel()) instead of the column
name.strict_md
if set to true, some ResultSetMetaData
methods return more strict values for compatibility
reasons.
From version 1.8.0.x, strict_md
is deprecated (ignored)
because metadata reporting is always strict (JDBC-compliant), and
three new optional properties are supported:
ifexits
(default false) - when true, an exception
is raised when attempting to connect to an in-process
file: or mem: scheme database instance if it has not yet been
created. When false, an in-process file: or mem: scheme
database instance is created automatically if it has not yet
been created. This property does not apply to requests for
network or res: (i.e. files_in_jar) scheme connections. shutdown
(default false) - when true, the
the target database mimics the behaviour of 1.7.1 and older
versions. When the last connection to a database is closed,
the database is automatically shut down. The property takes
effect only when the first connection is made to the database.
This means the connection that opens the database. It has no
effect if used with subsequent, simultaneous connections. default_schema
- backwards compatibility feature.
To be used for clients written before HSQLDB schema support.
Denotes whether to use the default schema when a schema
qualifier is not included in a database object's SQL identifier
character sequence. Also affects the semantics of
DatabaseMetaData calls that supply null-valued schemaNamePattern
parameter values.connect
in interface java.sql.Driver
url
- the URL of the database to which to connectinfo
- a list of arbitrary string tag/value pairs as connection
arguments. Normally at least a "user" and "password" property
should be included.Connection
object that represents a
connection to the URLjava.sql.SQLException
- if a database access error occurspublic static java.sql.Connection getConnection(java.lang.String url, java.util.Properties info) throws java.sql.SQLException
connect(String,Properties)
method. url
- the URL of the database to which to connectinfo
- a list of arbitrary string tag/value pairs as connection
arguments including at least at a "user" and a "password" propertyConnection
object that represents a
connection to the URLjava.sql.SQLException
- if a database access error occurspublic boolean acceptsURL(java.lang.String url)
acceptsURL
in interface java.sql.Driver
url
- the URL of the databasepublic java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url, java.util.Properties info)
The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database. Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate though several calls to getPropertyInfo.
HSQLDB uses the values submitted in info to set the value for each DriverPropertyInfo object returned. It does not use the default value that it would use for the property if the value is null.
getPropertyInfo
in interface java.sql.Driver
url
- the URL of the database to which to connectinfo
- a proposed list of tag/value pairs that will be sent on
connect openpublic int getMajorVersion()
getMajorVersion
in interface java.sql.Driver
public int getMinorVersion()
getMinorVersion
in interface java.sql.Driver
public boolean jdbcCompliant()
true
here if it passes the JDBC compliance tests; otherwise
it is required to return false
. JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level.
HSQLDB 2.0 is aimed to be compliant with JDBC 4.2 specification. It supports SQL 92 Entry Level and beyond.
jdbcCompliant
in interface java.sql.Driver
true
if this driver is JDBC Compliant;
false
otherwisepublic java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException
getParentLogger
in interface java.sql.Driver
java.sql.SQLFeatureNotSupportedException
- if the driver does not use java.util.logging
.Copyright © 2001 - 2018 HSQL Development Group.