Added in API level 1

DriverManager

open class DriverManager

kotlin.Any
↳	java.sql.DriverManager

The basic service for managing a set of JDBC drivers.
NOTE: The DataSource interface, new in the JDBC 2.0 API, provides another way to connect to a data source. The use of a DataSource object is the preferred means of connecting to a data source.

As part of its initialization, the DriverManager class will attempt to load the driver classes referenced in the "jdbc.drivers" system property. This allows a user to customize the JDBC Drivers used by their applications. For example in your ~/.hotjava/properties file you might specify:

<code>jdbc.drivers=foo.bah.Driver:wombat.sql.Driver:bad.taste.ourDriver</code>

The DriverManager methods getConnection and getDrivers have been enhanced to support the Java Standard Edition Service Provider mechanism. JDBC 4.0 Drivers must include the file META-INF/services/java.sql.Driver. This file contains the name of the JDBC drivers implementation of java.sql.Driver. For example, to load the my.sql.Driver class, the META-INF/services/java.sql.Driver file would contain the entry:

<code>my.sql.Driver</code>

Applications no longer need to explictly load JDBC drivers using Class.forName(). Existing programs which currently load JDBC drivers using Class.forName() will continue to work without modification.

When the method getConnection is called, the DriverManager will attempt to locate a suitable driver from amongst those loaded at initialization and those loaded explicitly using the same classloader as the current applet or application.

Starting with the Java 2 SDK, Standard Edition, version 1.3, a logging stream can be set only if the proper permission has been granted. Normally this will be done with the tool PolicyTool, which can be used to grant permission java.sql.SQLPermission "setLog".

Summary

Public methods
open static Unit	`deregisterDriver(driver: Driver!)` Drops a driver from the `DriverManager`'s list.
open static Connection!	`getConnection(url: String!)` Attempts to establish a connection to the given database URL.
open static Connection!	`getConnection(url: String!, user: String!, password: String!)` Attempts to establish a connection to the given database URL.
open static Connection!	`getConnection(url: String!, info: Properties!)` Attempts to establish a connection to the given database URL.
open static Driver!	`getDriver(url: String!)` Attempts to locate a driver that understands the given URL.
open static Enumeration<Driver!>!	`getDrivers()` Retrieves an Enumeration with all of the currently loaded JDBC drivers to which the current caller has access.
open static PrintStream!	`getLogStream()` Retrieves the logging/tracing PrintStream that is used by the `DriverManager` and all drivers.
open static PrintWriter!	`getLogWriter()` Retrieves the log writer.
open static Int	`getLoginTimeout()` Gets the maximum time in seconds that a driver can wait when attempting to log in to a database.
open static Unit	`println(message: String!)` Prints a message to the current JDBC log stream.
open static Unit	`registerDriver(driver: Driver!)` Registers the given driver with the `DriverManager`.
open static Unit	`setLogStream(out: PrintStream!)` Sets the logging/tracing PrintStream that is used by the `DriverManager` and all drivers.
open static Unit	`setLogWriter(out: PrintWriter!)` Sets the logging/tracing `PrintWriter` object that is used by the `DriverManager` and all drivers.
open static Unit	`setLoginTimeout(seconds: Int)` Sets the maximum time in seconds that a driver will wait while attempting to connect to a database.

Public methods

deregisterDriver

Added in API level 1

open static fun deregisterDriver(driver: Driver!): Unit

Drops a driver from the DriverManager's list. Applets can only deregister drivers from their own classloaders.

Parameters
`driver`	Driver!: the JDBC Driver to drop

Exceptions
`java.sql.SQLException`	if a database access error occurs

getConnection

Added in API level 1

open static fun getConnection(url: String!): Connection!

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters
`url`	String!: a database url of the form `jdbc:subprotocol:subname`

Return
`Connection!`	a connection to the URL

Exceptions
`java.sql.SQLException`	if a database access error occurs

getConnection

Added in API level 1

open static fun getConnection(
    url: String!, 
    user: String!, 
    password: String!
): Connection!

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters
`url`	String!: a database url of the form `jdbc:subprotocol:subname`
`user`	String!: the database user on whose behalf the connection is being made
`password`	String!: the user's password

Return
`Connection!`	a connection to the URL

Exceptions
`java.sql.SQLException`	if a database access error occurs

getConnection

Added in API level 1

open static fun getConnection(
    url: String!, 
    info: Properties!
): Connection!

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters
`url`	String!: a database url of the form `jdbc:subprotocol:subname`
`info`	Properties!: a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included

Return
`Connection!`	a Connection to the URL

Exceptions
`java.sql.SQLException`	if a database access error occurs

getDriver

Added in API level 1

open static fun getDriver(url: String!): Driver!

Attempts to locate a driver that understands the given URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters
`url`	String!: a database URL of the form `jdbc:subprotocol:subname`

Return
`Driver!`	a `Driver` object representing a driver that can connect to the given URL

Exceptions
`java.sql.SQLException`	if a database access error occurs

getDrivers

Added in API level 1

open static fun getDrivers(): Enumeration<Driver!>!

Retrieves an Enumeration with all of the currently loaded JDBC drivers to which the current caller has access.

Note: The classname of a driver can be found using d.getClass().getName()

Return
`Enumeration<Driver!>!`	the list of JDBC Drivers loaded by the caller's class loader

getLogStream

Added in API level 1
Deprecated in API level 15

open static fun getLogStream(): PrintStream!

Deprecated: Use getLogWriter instead.

Retrieves the logging/tracing PrintStream that is used by the DriverManager and all drivers.

Return
`PrintStream!`	the logging/tracing PrintStream; if disabled, is `null`

See Also

#setLogStream

getLogWriter

Added in API level 1

open static fun getLogWriter(): PrintWriter!

Retrieves the log writer. The getLogWriter and setLogWriter methods should be used instead of the get/setlogStream methods, which are deprecated.

Return
`PrintWriter!`	a `java.io.PrintWriter` object

See Also

#setLogWriter

getLoginTimeout

Added in API level 1

open static fun getLoginTimeout(): Int

Gets the maximum time in seconds that a driver can wait when attempting to log in to a database.

Return
`Int`	the driver login time limit in seconds

See Also

#setLoginTimeout

println

Added in API level 1

open static fun println(message: String!): Unit

Prints a message to the current JDBC log stream.

Parameters
`message`	String!: a log or tracing message

registerDriver

Added in API level 1

open static fun registerDriver(driver: Driver!): Unit

Registers the given driver with the DriverManager. A newly-loaded driver class should call the method registerDriver to make itself known to the DriverManager.

Parameters
`driver`	Driver!: the new JDBC Driver that is to be registered with the `DriverManager`

Exceptions
`java.sql.SQLException`	if a database access error occurs

setLogStream

Added in API level 1
Deprecated in API level 15

open static fun setLogStream(out: PrintStream!): Unit

Deprecated: Use setLogWriter instead.

Sets the logging/tracing PrintStream that is used by the DriverManager and all drivers.

In the Java 2 SDK, Standard Edition, version 1.3 release, this method checks to see that there is an SQLPermission object before setting the logging stream. If a SecurityManager exists and its checkPermission method denies setting the log writer, this method throws a java.lang.SecurityException.

Parameters
`out`	PrintStream!: the new logging/tracing PrintStream; to disable, set to `null`

Exceptions
`java.lang.SecurityException`	if a security manager exists and its `checkPermission` method denies setting the log stream

See Also

#getLogStream

setLogWriter

Added in API level 1

open static fun setLogWriter(out: PrintWriter!): Unit

Sets the logging/tracing PrintWriter object that is used by the DriverManager and all drivers.

There is a minor versioning problem created by the introduction of the method setLogWriter. The method setLogWriter cannot create a PrintStream object that will be returned by getLogStream---the Java platform does not provide a backward conversion. As a result, a new application that uses setLogWriter and also uses a JDBC 1.0 driver that uses getLogStream will likely not see debugging information written by that driver.

Starting with the Java 2 SDK, Standard Edition, version 1.3 release, this method checks to see that there is an SQLPermission object before setting the logging stream. If a SecurityManager exists and its checkPermission method denies setting the log writer, this method throws a java.lang.SecurityException.

Parameters
`out`	PrintWriter!: the new logging/tracing `PrintStream` object; `null` to disable logging and tracing

Exceptions
`java.lang.SecurityException`	if a security manager exists and its `checkPermission` method denies setting the log writer

See Also

#getLogWriter

setLoginTimeout

Added in API level 1

open static fun setLoginTimeout(seconds: Int): Unit

Sets the maximum time in seconds that a driver will wait while attempting to connect to a database.

Parameters
`seconds`	Int: the login time limit in seconds; zero means there is no limit

See Also

#getLoginTimeout