nl.topicus.jdbc

Class CloudSpannerDriver

java.lang.Object

nl.topicus.jdbc.CloudSpannerDriver

All Implemented Interfaces:

Driver

public class CloudSpannerDriver
extends Object
implements Driver

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG
static int	INFO
static int	OFF

Constructor Summary

Constructors

Constructor and Description
CloudSpannerDriver()

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(String url)
void	closeSpanner() Closes all connections to Google Cloud Spanner that have been opened by this driver during the lifetime of this application.
CloudSpannerConnection	connect(String url, Properties info) Connects to a Google Cloud Spanner database.
static void	deregister() According to JDBC specification, this driver is registered against DriverManager when the class is loaded.
static CloudSpannerDriver	getDriver()
static int	getDriverMajorVersion()
static int	getDriverMinorVersion()
static int	getLogLevel()
static long	getLongTransactionTrigger()
int	getMajorVersion()
int	getMinorVersion()
Logger	getParentLogger()
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info)
static String	getVersion()
static boolean	isRegistered()
boolean	jdbcCompliant()
static String	quoteIdentifier(String identifier)
static void	register() Register the driver against DriverManager.
static void	setLogLevel(int logLevel)
static void	setLongTransactionTrigger(long trigger) Sets the number of milliseconds that should be used to consider a transaction long-running.
static String	unquoteIdentifier(String identifier)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final int DEBUG

See Also:

Constant Field Values

INFO

public static final int INFO

See Also:

Constant Field Values

OFF

public static final int OFF

See Also:

Constant Field Values

Constructor Detail

CloudSpannerDriver

public CloudSpannerDriver()

Method Detail

getDriver

public static CloudSpannerDriver getDriver()

Returns:

The registered CloudSpannerDriver

connect

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

Connects to a Google Cloud Spanner database.

Specified by:

connect in interface Driver

Parameters:

url - Connection URL in the form jdbc:cloudspanner://localhost;Project =projectId;Instance=instanceId ;Database=databaseName;PvtKeyPath =path_to_key_file;SimulateProductName=product_name

info - Additional connection properties that will be set on the new connection

Returns:

An open CloudSpannerConnection

Throws:

SQLException - if an error occurs while connecting to Google Cloud Spanner

closeSpanner

public void closeSpanner()

Closes all connections to Google Cloud Spanner that have been opened by this driver during the lifetime of this application. You should call this method when you want to shutdown your application, as this frees up all connections and sessions to Google Cloud Spanner. Failure to do so, will keep sessions open server side and can eventually lead to resource exhaustion. Any open JDBC connection to Cloud Spanner opened by this driver will also be closed by this method. This method is also called automatically in a shutdown hook when the JVM is stopped orderly.

acceptsURL

public boolean acceptsURL(String url)
                   throws SQLException

Specified by:

acceptsURL in interface Driver

Throws:

SQLException

getPropertyInfo

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

Specified by:

getPropertyInfo in interface Driver

Throws:

SQLException

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface Driver

getDriverMajorVersion

public static int getDriverMajorVersion()

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface Driver

getDriverMinorVersion

public static int getDriverMinorVersion()

getVersion

public static String getVersion()

jdbcCompliant

public boolean jdbcCompliant()

Specified by:

jdbcCompliant in interface Driver

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface Driver

Throws:

SQLFeatureNotSupportedException

quoteIdentifier

public static String quoteIdentifier(String identifier)

unquoteIdentifier

public static String unquoteIdentifier(String identifier)

getLongTransactionTrigger

public static long getLongTransactionTrigger()

setLongTransactionTrigger

public static void setLongTransactionTrigger(long trigger)

Sets the number of milliseconds that should be used to consider a transaction long-running. If a log writer has been set for JDBC by calling DriverManager.setLogWriter(java.io.PrintWriter) and the log level of the Cloud Spanner Driver has been set to at least INFO, transactions that are running for more than this number of milliseconds will log this to the log writer. If the log level of the Cloud Spanner Driver is set to at least DEBUG, then the driver will also log the stack trace of the call that started the transaction, making it easier to find the part of your code that is responsible for the long-running transaction.

Parameters:

trigger - The number of milliseconds that is to be considered a long-running transaction. Only values larger than zero are allowed.

setLogLevel

public static void setLogLevel(int logLevel)

getLogLevel

public static int getLogLevel()

register

public static void register()
                     throws SQLException

Register the driver against DriverManager. This is done automatically when the class is loaded. Dropping the driver from DriverManager's list is possible using deregister() method.

Throws:

IllegalStateException - if the driver is already registered

SQLException - if registering the driver fails

deregister

public static void deregister()
                       throws SQLException

According to JDBC specification, this driver is registered against DriverManager when the class is loaded. To avoid leaks, this method allow unregistering the driver so that the class can be gc'ed if necessary.

Throws:

IllegalStateException - if the driver is not registered

SQLException - if deregistering the driver fails

isRegistered

public static boolean isRegistered()

Returns:

true if the driver is registered against DriverManager