com.pivotal.gemfirexd.jdbc

Class EmbeddedDriver

java.lang.Object

com.pivotal.gemfirexd.jdbc.EmbeddedDriver

All Implemented Interfaces:

Driver

public class EmbeddedDriver
extends Object
implements Driver

The embedded JDBC driver (Type 4) for GemFireXD.

The driver automatically supports the correct JDBC specification version for the Java Virtual Machine's environment.

• JDBC 4.0 - Java SE 6
• JDBC 3.0 - Java 2 - JDK 1.4, J2SE 5.0

Loading this JDBC driver boots the database engine within the same Java virtual machine.

The correct code to load the GemFireXD engine using this driver is (with approriate try/catch blocks):

         Class.forName("com.pivotal.gemfirexd.jdbc.EmbeddedDriver").newInstance();

         // or

     new com.pivotal.gemfirexd.jdbc.EmbeddedDriver();


        

When loaded in this way, the class boots the actual JDBC driver indirectly. The JDBC specification recommends the Class.ForName method without the .newInstance() method call, but adding the newInstance() guarantees that GemFireXD will be booted on any Java Virtual Machine.

Note that you do not need to manually load the driver this way if you are running on Jave SE 6 or later. In that environment, the driver will be automatically loaded for you when your application requests a connection to a GemFireXD database.

Any initial error messages are placed in the PrintStream supplied by the DriverManager. If the PrintStream is null error messages are sent to System.err. Once the GemFireXD engine has set up an error logging facility (by default to gemfirexd.log) all subsequent messages are sent to it.

By convention, the class used in the Class.forName() method to boot a JDBC driver implements java.sql.Driver. This class is not the actual JDBC driver that gets registered with the Driver Manager. It proxies requests to the registered GemFireXD JDBC driver.

See Also:

DriverManager, DriverManager.getLogStream(), Driver, SQLException

Constructor Summary

Constructors

Constructor and Description
EmbeddedDriver()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsURL(String url) Accept anything that starts with jdbc:derby:.
static void	boot()
Connection	connect(String url, Properties info) Connect to the URL if possible
int	getMajorVersion() Returns the driver's major version number.
int	getMinorVersion() Returns the driver's minor version number.
Logger	getParentLogger()
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info) Returns an array of DriverPropertyInfo objects describing possible properties.
boolean	jdbcCompliant() Report whether the Driver is a genuine JDBC COMPLIANT (tm) driver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbeddedDriver

public EmbeddedDriver()

Method Detail

acceptsURL

public boolean acceptsURL(String url)
                   throws SQLException

Accept anything that starts with jdbc:derby:.

Specified by:

acceptsURL in interface Driver

Throws:

SQLException - if a database-access error occurs.

See Also:

Driver

connect

public Connection connect(String url,
                 Properties info)
                   throws SQLException

Connect to the URL if possible

Specified by:

connect in interface Driver

Throws:

SQLException - illegal url or problem with connectiong

See Also:

Driver

getPropertyInfo

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

Returns an array of DriverPropertyInfo objects describing possible properties.

Specified by:

getPropertyInfo in interface Driver

Throws:

SQLException - if a database-access error occurs.

See Also:

Driver

getMajorVersion

public int getMajorVersion()

Returns the driver's major version number.

Specified by:

getMajorVersion in interface Driver

See Also:

Driver

getMinorVersion

public int getMinorVersion()

Returns the driver's minor version number.

Specified by:

getMinorVersion in interface Driver

See Also:

Driver

jdbcCompliant

public boolean jdbcCompliant()

Report whether the Driver is a genuine JDBC COMPLIANT (tm) driver.

Specified by:

jdbcCompliant in interface Driver

See Also:

Driver

boot

public static void boot()

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface Driver

Throws:

SQLFeatureNotSupportedException