All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class postgresql.Driver

java.lang.Object
   |
   +----postgresql.Driver

public class Driver
extends Object
implements 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 doing Class.forName("foo.bah.Driver")

See Also:
Connection, Driver

Constructor Index

 o Driver()
Construct a new driver and register it with DriverManager

Method Index

 o acceptsURL(String)
Returns true if the driver thinks it can open a connection to the given URL.
 o connect(String, Properties)
Try to make a database connection to the given URL.
 o database()
 o getMajorVersion()
Gets the drivers major version number
 o getMinorVersion()
Get the drivers minor version number
 o getPropertyInfo(String, Properties)
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.
 o host()
 o jdbcCompliant()
Report whether the driver is a genuine JDBC compliant driver.
 o notImplemented()
This method was added in v6.5, and simply throws an SQLException for an unimplemented method.
 o port()
 o property(String)

Constructors

 o Driver
 public Driver() throws SQLException
Construct a new driver and register it with DriverManager

Throws: SQLException
for who knows what!

Methods

 o connect
 public Connection connect(String url,
                           Properties info) throws SQLException
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 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. Our protocol takes the forms:

	jdbc:postgresql://host:port/database?param1=val1&...
 

Parameters:
url - the URL of the database to connect to
info - a list of arbitrary tag/value pairs as connection arguments
Returns:
a connection to the URL or null if it isnt us
Throws: SQLException
if a database access error occurs
See Also:
connect
 o acceptsURL
 public boolean acceptsURL(String url) throws SQLException
Returns true if the driver thinks it can open a connection to the given URL. Typically, drivers will return true if they understand the subprotocol specified in the URL and false if they don't. Our protocols start with jdbc:postgresql:

Parameters:
url - the URL of the driver
Returns:
true if this driver accepts the given URL
Throws: SQLException
if a database-access error occurs (Dont know why it would *shrug*)
See Also:
acceptsURL
 o getPropertyInfo
 public 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 through several calls to getPropertyInfo

Parameters:
url - the Url of the database to connect to
info - a proposed list of tag/value pairs that will be sent on connect open.
Returns:
An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required
Throws: SQLException
if a database-access error occurs
See Also:
getPropertyInfo
 o getMajorVersion
 public int getMajorVersion()
Gets the drivers major version number

Returns:
the drivers major version number
 o getMinorVersion
 public int getMinorVersion()
Get the drivers minor version number

Returns:
the drivers minor version number
 o jdbcCompliant
 public boolean jdbcCompliant()
Report whether the 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.

For PostgreSQL, this is not yet possible, as we are not SQL92 compliant (yet).

 o host
 public String host()
Returns:
the hostname portion of the URL
 o port
 public int port()
Returns:
the port number portion of the URL or -1 if no port was specified
 o database
 public String database()
Returns:
the database name of the URL
 o property
 public String property(String name)
Returns:
the value of any property specified in the URL or properties passed to connect(), or null if not found.
 o notImplemented
 public static SQLException notImplemented()
This method was added in v6.5, and simply throws an SQLException for an unimplemented method. I decided to do it this way while implementing the JDBC2 extensions to JDBC, as it should help keep the overall driver size down.


All Packages  Class Hierarchy  This Package  Previous  Next  Index