Top Description Constructors Methods
com.mysql.cj.jdbc

public Class NonRegisteringDriver

extends Object
implements Driver
Class Inheritance
All Implemented Interfaces
java.sql.Driver
Known Direct Subclasses
com.mysql.cj.jdbc.Driver
Static Imports
com.mysql.cj.util.StringUtils.isNullOrEmpty

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 doing Class.forName("foo.bar.Driver").

Constructor Summary

AccessConstructor and Description
public
NonRegisteringDriver()

Construct a new driver and register it with DriverManager.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if this driver accepts the given URL.
acceptsURL
(String
the URL of the driver.
url
)

Implements java.sql.Driver.acceptsURL.

Typically, drivers will return true if they understand the subprotocol specified in the URL and false if they don't.

public Connection

Returns:

a connection to the URL or null if it isn't us.
connect
(String
the URL of the database to connect to.
url
,
Properties
a list of arbitrary tag/value pairs as connection arguments.
info
)

Implements java.sql.Driver.connect.

Try to make a database connection to the given URL.

public int
getMajorVersion()

Implements java.sql.Driver.getMajorVersion.

Retrieves the driver's major version number.

pack-priv static int

Returns:

the drivers major version number
getMajorVersionInternal
()

Gets the drivers major version number.

public int
getMinorVersion()

Implements java.sql.Driver.getMinorVersion.

Gets the driver's minor version number.

pack-priv static int

Returns:

the drivers minor version number
getMinorVersionInternal
()

Get the drivers minor version number.

public static String

Returns:

the transformed, standardized OS name
getOSName
()

Standardizes OS name information to align with other drivers/clients for MySQL connection attributes.

public Logger
getParentLogger()

Implements java.sql.Driver.getParentLogger.

Return the parent Logger of all the Loggers used by this driver.

public static String

Returns:

the transformed, standardized platform details
getPlatform
()

Standardizes platform information to align with other drivers/clients for MySQL connection attributes.

public DriverPropertyInfo[]
getPropertyInfo(String
the URL of the database to which to connect
url
,
Properties
a proposed list of tag/value pairs that will be sent on connect open
info
)

Implements java.sql.Driver.getPropertyInfo.

Gets information about the possible properties for this driver.

public boolean
jdbcCompliant()

Implements java.sql.Driver.jdbcCompliant.

Reports whether this driver is a genuine JDBC Compliant driver.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

NonRegisteringDriverback to summary
public NonRegisteringDriver() throws SQLException

Construct a new driver and register it with DriverManager.

Exceptions
SQLException:
if a database error occurs.

Method Detail

acceptsURLback to summary
public boolean acceptsURL(String url) throws SQLException

Implements java.sql.Driver.acceptsURL.

Typically, drivers will return true if they understand the subprotocol specified in the URL and false if they don't. This driver's protocols start with jdbc:mysql:

Parameters
url:String

the URL of the driver.

Returns:boolean

true if this driver accepts the given URL.

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs or the url is null.
connectback to summary
public Connection connect(String url, Properties info) throws SQLException

Implements java.sql.Driver.connect.

Try to make a database connection to the given URL. The driver should return "null" if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the JDBC driverManager is asked to connect to a given URL, it passes the URL to each loaded driver in turn.

The driver should raise an SQLException if the URL is null or 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. These properties take precedence over any properties sent in the URL.

MySQL protocol takes the form: jdbc:mysql://host:port/database.

Parameters
url:String

the URL of the database to connect to.

info:Properties

a list of arbitrary tag/value pairs as connection arguments.

Returns:Connection

a connection to the URL or null if it isn't us.

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs or the url is null.
getMajorVersionback to summary
public int getMajorVersion()

Implements java.sql.Driver.getMajorVersion.

Doc from java.sql.Driver.getMajorVersion.

Retrieves the driver's major version number. Initially this should be 1.

Returns:int

this driver's major version number

Annotations
@Override
getMajorVersionInternalback to summary
pack-priv static int getMajorVersionInternal()

Gets the drivers major version number.

Returns:int

the drivers major version number

getMinorVersionback to summary
public int getMinorVersion()

Implements java.sql.Driver.getMinorVersion.

Doc from java.sql.Driver.getMinorVersion.

Gets the driver's minor version number. Initially this should be 0.

Returns:int

this driver's minor version number

Annotations
@Override
getMinorVersionInternalback to summary
pack-priv static int getMinorVersionInternal()

Get the drivers minor version number.

Returns:int

the drivers minor version number

getOSNameback to summary
public static String getOSName()

Standardizes OS name information to align with other drivers/clients for MySQL connection attributes.

Returns:String

the transformed, standardized OS name

getParentLoggerback to summary
public Logger getParentLogger() throws SQLFeatureNotSupportedException

Implements java.sql.Driver.getParentLogger.

Doc from java.sql.Driver.getParentLogger.

Return the parent Logger of all the Loggers used by this driver. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this driver. Configuring this Logger will affect all of the log messages generated by the driver. In the worst case, this may be the root Logger.

Returns:Logger

the parent Logger for this driver

Annotations
@Override
Exceptions
SQLFeatureNotSupportedException:
if the driver does not use java.util.logging.
getPlatformback to summary
public static String getPlatform()

Standardizes platform information to align with other drivers/clients for MySQL connection attributes.

Returns:String

the transformed, standardized platform details

getPropertyInfoback to summary
public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException

Implements java.sql.Driver.getPropertyInfo.

Doc from java.sql.Driver.getPropertyInfo.

Gets information about the possible properties for this driver.

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.

Parameters
url:String

the URL of the database to which to connect

info:Properties

a proposed list of tag/value pairs that will be sent on connect open

Returns:DriverPropertyInfo[]

an array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
jdbcCompliantback to summary
public boolean jdbcCompliant()

Implements java.sql.Driver.jdbcCompliant.

Doc from java.sql.Driver.jdbcCompliant.

Reports whether this driver is a genuine JDBC Compliant driver. A driver may only report 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.

Returns:boolean

true if this driver is JDBC Compliant; false otherwise

Annotations
@Override