public interface Driver
The Java SQL framework allows for multiple database drivers.
Each driver should supply a class that implements the Driver interface.
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.
It is strongly recommended that each Driver class should be small and standalone so that the Driver class can be loaded and queried without bringing in vast quantities of supporting code.
When a Driver class is loaded, it should create an instance of itself and register it with the DriverManager. This means that a user can load and register a driver by calling:
Class.forName("foo.bah.Driver")
A JDBC driver may create a DriverAction implementation in order to receive notifications when DriverManager.deregisterDriver(java.sql.Driver) has been called.
Modifier and Type | Method | Description |
---|---|---|
boolean |
acceptsURL |
Retrieves whether the driver thinks that it can open a connection to the given URL. |
Connection |
connect |
Attempts to make a database connection to the given URL. |
int |
getMajorVersion() |
Retrieves the driver's major version number. |
int |
getMinorVersion() |
Gets the driver's minor version number. |
Logger |
getParentLogger() |
Return the parent Logger of all the Loggers used by this driver. |
DriverPropertyInfo[] |
getPropertyInfo |
Gets information about the possible properties for this driver. |
boolean |
jdbcCompliant() |
Reports whether this driver is a genuine JDBC Compliant driver. |
Connection connect(String url, Properties info) throws SQLException
The driver should throw an SQLException
if it is the right driver to connect to the given URL but has trouble connecting to the database.
The 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.
Note: If a property is specified as part of the url
and is also specified in the Properties
object, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once.
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 URLSQLException
- if a database access error occurs or the url is null
boolean acceptsURL(String url) throws SQLException
true
if they understand the sub-protocol specified in the URL and false
if they do not.url
- the URL of the databasetrue
if this driver understands the given URL; false
otherwiseSQLException
- if a database access error occurs or the url is null
DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException
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 the getPropertyInfo
method.
url
- the URL of the database to which to connectinfo
- a proposed list of tag/value pairs that will be sent on connect openDriverPropertyInfo
objects describing possible properties. This array may be an empty array if no properties are required.SQLException
- if a database access error occursint getMajorVersion()
int getMinorVersion()
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. It is expected that JDBC compliant drivers will be available for all the major commercial databases.
This method is not intended to encourage the development of non-JDBC compliant drivers, but is a recognition of the fact that some vendors are interested in using the JDBC API and framework for lightweight databases that do not support full database functionality, or for special databases such as document information retrieval where a SQL implementation may not be feasible.
true
if this driver is JDBC Compliant; false
otherwiseLogger getParentLogger() throws SQLFeatureNotSupportedException
SQLFeatureNotSupportedException
- if the driver does not use java.util.logging
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/Driver.html