nl.topicus.jdbc.CloudSpannerDriver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation
Show all versions of spanner-jdbc Show documentation
JDBC Driver for Google Cloud Spanner
package nl.topicus.jdbc;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.DriverPropertyInfo;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import nl.topicus.jdbc.shaded.com.google.cloud.spanner.Spanner;
import nl.topicus.jdbc.shaded.com.google.rpc.Code;
import nl.topicus.jdbc.CloudSpannerConnection.CloudSpannerDatabaseSpecification;
import nl.topicus.jdbc.exception.CloudSpannerSQLException;
public class CloudSpannerDriver implements Driver
{
static
{
try
{
register();
}
catch (SQLException e)
{
java.sql.DriverManager.println("Registering driver failed: " + e.getMessage());
}
}
private static CloudSpannerDriver registeredDriver;
public static final int DEBUG = 2;
public static final int INFO = 1;
public static final int OFF = 0;
private static final Logger logger = new Logger();
private static boolean logLevelSet = false;
static final int MAJOR_VERSION = 1;
static final int MINOR_VERSION = 0;
static final class ConnectionProperties
{
static String getPropertyName(String propertyPart)
{
return propertyPart.substring(0, propertyPart.length() - 1);
}
static final String PROJECT_URL_PART = "Project=";
static final String INSTANCE_URL_PART = "Instance=";
static final String DATABASE_URL_PART = "Database=";
static final String KEY_FILE_URL_PART = "PvtKeyPath=";
static final String OAUTH_ACCESS_TOKEN_URL_PART = "OAuthAccessToken=";
static final String SIMULATE_PRODUCT_NAME = "SimulateProductName=";
static final String SIMULATE_PRODUCT_MAJOR_VERSION = "SimulateProductMajorVersion=";
static final String SIMULATE_PRODUCT_MINOR_VERSION = "SimulateProductMinorVersion=";
static final String ALLOW_EXTENDED_MODE = "AllowExtendedMode=";
static final String ASYNC_DDL_OPERATIONS = "AsyncDdlOperations=";
String project = null;
String instance = null;
String database = null;
String keyFile = null;
String oauthToken = null;
String productName = null;
Integer majorVersion = null;
Integer minorVersion = null;
boolean allowExtendedMode = false;
boolean asyncDdlOperations = false;
static ConnectionProperties parse(String url) throws SQLException
{
ConnectionProperties res = new ConnectionProperties();
if (url != null)
{
String[] parts = url.split(":", 3);
String[] connectionParts = parts[2].split(";");
// Get connection properties from connection string
for (int i = 1; i < connectionParts.length; i++)
{
String conPart = connectionParts[i].replace(" ", "");
String conPartLower = conPart.toLowerCase();
if (conPartLower.startsWith(PROJECT_URL_PART.toLowerCase()))
res.project = conPart.substring(PROJECT_URL_PART.length());
else if (conPartLower.startsWith(INSTANCE_URL_PART.toLowerCase()))
res.instance = conPart.substring(INSTANCE_URL_PART.length());
else if (conPartLower.startsWith(DATABASE_URL_PART.toLowerCase()))
res.database = conPart.substring(DATABASE_URL_PART.length());
else if (conPartLower.startsWith(KEY_FILE_URL_PART.toLowerCase()))
res.keyFile = conPart.substring(KEY_FILE_URL_PART.length());
else if (conPartLower.startsWith(OAUTH_ACCESS_TOKEN_URL_PART.toLowerCase()))
res.oauthToken = conPart.substring(OAUTH_ACCESS_TOKEN_URL_PART.length());
else if (conPartLower.startsWith(SIMULATE_PRODUCT_NAME.toLowerCase()))
res.productName = conPart.substring(SIMULATE_PRODUCT_NAME.length());
else if (conPartLower.startsWith(SIMULATE_PRODUCT_MAJOR_VERSION.toLowerCase()))
res.majorVersion = parseInteger(conPart.substring(SIMULATE_PRODUCT_MAJOR_VERSION.length()));
else if (conPartLower.startsWith(SIMULATE_PRODUCT_MINOR_VERSION.toLowerCase()))
res.minorVersion = parseInteger(conPart.substring(SIMULATE_PRODUCT_MINOR_VERSION.length()));
else if (conPartLower.startsWith(ALLOW_EXTENDED_MODE.toLowerCase()))
res.allowExtendedMode = Boolean.valueOf(conPart.substring(ALLOW_EXTENDED_MODE.length()));
else if (conPartLower.startsWith(ASYNC_DDL_OPERATIONS.toLowerCase()))
res.asyncDdlOperations = Boolean.valueOf(conPart.substring(ASYNC_DDL_OPERATIONS.length()));
else
throw new CloudSpannerSQLException("Unknown URL parameter " + conPart, Code.INVALID_ARGUMENT);
}
}
return res;
}
private static Integer parseInteger(String val)
{
try
{
return Integer.valueOf(val);
}
catch (NumberFormatException e)
{
}
return null;
}
private static String defaultString(Integer val)
{
return val == null ? null : val.toString();
}
void setAdditionalConnectionProperties(Properties info) throws SQLException
{
if (info != null)
{
// Make all lower case
Properties lowerCaseInfo = new Properties();
for (String key : info.stringPropertyNames())
{
lowerCaseInfo.setProperty(key.toLowerCase(), info.getProperty(key));
}
project = lowerCaseInfo.getProperty(
PROJECT_URL_PART.substring(0, PROJECT_URL_PART.length() - 1).toLowerCase(), project);
instance = lowerCaseInfo.getProperty(
INSTANCE_URL_PART.substring(0, INSTANCE_URL_PART.length() - 1).toLowerCase(), instance);
database = lowerCaseInfo.getProperty(
DATABASE_URL_PART.substring(0, DATABASE_URL_PART.length() - 1).toLowerCase(), database);
keyFile = lowerCaseInfo.getProperty(
KEY_FILE_URL_PART.substring(0, KEY_FILE_URL_PART.length() - 1).toLowerCase(), keyFile);
oauthToken = lowerCaseInfo.getProperty(OAUTH_ACCESS_TOKEN_URL_PART
.substring(0, OAUTH_ACCESS_TOKEN_URL_PART.length() - 1).toLowerCase(), oauthToken);
productName = lowerCaseInfo.getProperty(
SIMULATE_PRODUCT_NAME.substring(0, SIMULATE_PRODUCT_NAME.length() - 1).toLowerCase(),
productName);
majorVersion = parseInteger(lowerCaseInfo.getProperty(SIMULATE_PRODUCT_MAJOR_VERSION
.substring(0, SIMULATE_PRODUCT_MAJOR_VERSION.length() - 1).toLowerCase(),
defaultString(majorVersion)));
minorVersion = parseInteger(lowerCaseInfo.getProperty(SIMULATE_PRODUCT_MINOR_VERSION
.substring(0, SIMULATE_PRODUCT_MINOR_VERSION.length() - 1).toLowerCase(),
defaultString(minorVersion)));
allowExtendedMode = Boolean.valueOf(lowerCaseInfo.getProperty(
ALLOW_EXTENDED_MODE.substring(0, ALLOW_EXTENDED_MODE.length() - 1).toLowerCase(),
String.valueOf(allowExtendedMode)));
asyncDdlOperations = Boolean.valueOf(lowerCaseInfo.getProperty(
ASYNC_DDL_OPERATIONS.substring(0, ASYNC_DDL_OPERATIONS.length() - 1).toLowerCase(),
String.valueOf(asyncDdlOperations)));
if (!logLevelSet)
setLogLevel(OFF);
}
}
DriverPropertyInfo[] getPropertyInfo()
{
DriverPropertyInfo[] res = new DriverPropertyInfo[10];
res[0] = new DriverPropertyInfo(PROJECT_URL_PART.substring(0, PROJECT_URL_PART.length() - 1), project);
res[0].description = "Google Cloud Project id";
res[1] = new DriverPropertyInfo(INSTANCE_URL_PART.substring(0, INSTANCE_URL_PART.length() - 1), instance);
res[1].description = "Google Cloud Spanner Instance id";
res[2] = new DriverPropertyInfo(DATABASE_URL_PART.substring(0, DATABASE_URL_PART.length() - 1), database);
res[2].description = "Google Cloud Spanner Database name";
res[3] = new DriverPropertyInfo(KEY_FILE_URL_PART.substring(0, KEY_FILE_URL_PART.length() - 1), keyFile);
res[3].description = "Path to json key file to be used for authentication";
res[4] = new DriverPropertyInfo(
OAUTH_ACCESS_TOKEN_URL_PART.substring(0, OAUTH_ACCESS_TOKEN_URL_PART.length() - 1), oauthToken);
res[4].description = "OAuth access token to be used for authentication (optional, only to be used when no key file is specified)";
res[5] = new DriverPropertyInfo(SIMULATE_PRODUCT_NAME.substring(0, SIMULATE_PRODUCT_NAME.length() - 1),
productName);
res[5].description = "Use this property to make the driver return a different database product name than Google Cloud Spanner, for example if you are using a framework like Spring that use this property to determine how to a generate data model for Spring Batch";
res[6] = new DriverPropertyInfo(
SIMULATE_PRODUCT_MAJOR_VERSION.substring(0, SIMULATE_PRODUCT_MAJOR_VERSION.length() - 1),
defaultString(majorVersion));
res[6].description = "Use this property to make the driver return a different major version number, for example if you are using a framework like Spring that use this property to determine how to a generate data model for Spring Batch";
res[7] = new DriverPropertyInfo(
SIMULATE_PRODUCT_MINOR_VERSION.substring(0, SIMULATE_PRODUCT_MINOR_VERSION.length() - 1),
defaultString(minorVersion));
res[7].description = "Use this property to make the driver return a different minor version number, for example if you are using a framework like Spring that use this property to determine how to a generate data model for Spring Batch";
res[8] = new DriverPropertyInfo(ALLOW_EXTENDED_MODE.substring(0, ALLOW_EXTENDED_MODE.length() - 1),
String.valueOf(allowExtendedMode));
res[8].description = "Allow the driver to enter 'extended' mode for bulk operations. A value of false (default) indicates that the driver should never enter extended mode. If this property is set to true, the driver will execute all bulk DML-operations in a separate transaction when the number of records affected is greater than what will exceed the limitations of Cloud Spanner.";
res[9] = new DriverPropertyInfo(ASYNC_DDL_OPERATIONS.substring(0, ASYNC_DDL_OPERATIONS.length() - 1),
String.valueOf(asyncDdlOperations));
res[9].description = "Run DDL-operations (CREATE TABLE, ALTER TABLE, DROP TABLE, etc.) in asynchronous mode. When set to true, DDL-statements will be checked for correct syntax and other basic checks before the call returns. It can take up to several minutes before the statement has actually finished executing. The status of running DDL-operations can be queried by issuing a SHOW_DDL_OPERATIONS statement. DDL-operations that have finished can be cleared from this view by issuing a CLEAN_DDL_OPERATIONS statement.";
return res;
}
}
/**
* Keep track of all connections that are opened, so that we know which
* Spanner instances to close.
*/
private Map> connections = new HashMap<>();
/**
* Connects to a Google Cloud Spanner database.
*
* @param url
* Connection URL in the form
* jdbc:cloudspanner://localhost;Project
* =projectId;Instance=instanceId
* ;Database=databaseName;PvtKeyPath
* =path_to_key_file;SimulateProductName=product_name
* @param info
* not used
* @return A CloudSpannerConnection
* @throws SQLException
* if an error occurs while connecting to Google Cloud Spanner
*/
@Override
public Connection connect(String url, Properties info) throws SQLException
{
if (!acceptsURL(url))
return null;
// Parse URL
ConnectionProperties properties = ConnectionProperties.parse(url);
// Get connection properties from properties
properties.setAdditionalConnectionProperties(info);
CloudSpannerDatabaseSpecification database = new CloudSpannerDatabaseSpecification(properties.project,
properties.instance, properties.database);
CloudSpannerConnection connection = new CloudSpannerConnection(this, url, database, properties.keyFile,
properties.oauthToken, properties.allowExtendedMode, info);
connection.setSimulateProductName(properties.productName);
connection.setSimulateMajorVersion(properties.majorVersion);
connection.setSimulateMinorVersion(properties.minorVersion);
connection.setAsyncDdlOperations(properties.asyncDdlOperations);
registerConnection(connection);
return connection;
}
private void registerConnection(CloudSpannerConnection connection)
{
List list = connections.get(connection.getSpanner());
if (list == null)
{
list = new ArrayList<>();
connections.put(connection.getSpanner(), list);
}
list.add(connection);
}
void closeConnection(CloudSpannerConnection connection)
{
List list = connections.get(connection.getSpanner());
if (list == null)
throw new IllegalStateException("Connection is not registered");
if (!list.remove(connection))
throw new IllegalStateException("Connection is not registered");
if (list.isEmpty())
{
Spanner spanner = connection.getSpanner();
connections.remove(spanner);
spanner.close();
}
}
@Override
public boolean acceptsURL(String url) throws SQLException
{
return url.startsWith("jdbc:cloudspanner:");
}
@Override
public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException
{
if (!acceptsURL(url))
return new DriverPropertyInfo[0];
ConnectionProperties properties = ConnectionProperties.parse(url);
properties.setAdditionalConnectionProperties(info);
return properties.getPropertyInfo();
}
@Override
public int getMajorVersion()
{
return getDriverMajorVersion();
}
public static int getDriverMajorVersion()
{
return MAJOR_VERSION;
}
@Override
public int getMinorVersion()
{
return getDriverMinorVersion();
}
public static int getDriverMinorVersion()
{
return MINOR_VERSION;
}
public static String getVersion()
{
return "Google Cloud Spanner Driver " + getDriverMajorVersion() + "." + getDriverMinorVersion();
}
@Override
public boolean jdbcCompliant()
{
return true;
}
@Override
public java.util.logging.Logger getParentLogger() throws SQLFeatureNotSupportedException
{
throw new SQLFeatureNotSupportedException("java.util.logging is not used");
}
public static String quoteIdentifier(String identifier)
{
if (identifier == null)
return identifier;
if (identifier.charAt(0) == '`' && identifier.charAt(identifier.length() - 1) == '`')
return identifier;
return new StringBuilder(identifier.length() + 2).append("`").append(identifier).append("`").toString();
}
public static String unquoteIdentifier(String identifier)
{
String res = identifier;
if (identifier == null)
return identifier;
if (identifier.charAt(0) == '`' && identifier.charAt(identifier.length() - 1) == '`')
res = identifier.substring(1, identifier.length() - 1);
return res;
}
public static void setLogLevel(int logLevel)
{
synchronized (CloudSpannerDriver.class)
{
logger.setLogLevel(logLevel);
logLevelSet = true;
}
}
public static int getLogLevel()
{
synchronized (CloudSpannerDriver.class)
{
return logger.getLogLevel();
}
}
/**
* Register the driver against {@link DriverManager}. This is done
* automatically when the class is loaded. Dropping the driver from
* DriverManager's list is possible using {@link #deregister()} method.
*
* @throws IllegalStateException
* if the driver is already registered
* @throws SQLException
* if registering the driver fails
*/
public static void register() throws SQLException
{
if (isRegistered())
{
throw new IllegalStateException("Driver is already registered. It can only be registered once.");
}
CloudSpannerDriver registeredDriver = new CloudSpannerDriver();
DriverManager.registerDriver(registeredDriver);
CloudSpannerDriver.registeredDriver = registeredDriver;
}
/**
* According to JDBC specification, this driver is registered against
* {@link 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
* @throws SQLException
* if deregistering the driver fails
*/
public static void deregister() throws SQLException
{
if (!isRegistered())
{
throw new IllegalStateException(
"Driver is not registered (or it has not been registered using Driver.register() method)");
}
DriverManager.deregisterDriver(registeredDriver);
registeredDriver = null;
}
/**
* @return {@code true} if the driver is registered against
* {@link DriverManager}
*/
public static boolean isRegistered()
{
return registeredDriver != null;
}
}