Class CloudSpannerAdapter

java.lang.Object

org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter

org.datanucleus.store.rdbms.adapter.CloudSpannerAdapter

All Implemented Interfaces:

DatastoreAdapter

public class CloudSpannerAdapter
extends BaseDatastoreAdapter

CloudSpannerAdapter defines the types, features that are supported and also deviate from the BaseDatastoreAdapter.

Nested Class Summary

Nested classes/interfaces inherited from class BaseDatastoreAdapter

BaseDatastoreAdapter.ColumnTypeMappings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOUD_SPANNER_RESERVED_KEYWORDS

Fields inherited from class BaseDatastoreAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, datastoreTypeMappingsByJavaType, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, MAX_IDENTIFIER_LENGTH, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, NONRESERVED_WORDS, reservedKeywords, SQL2003_RESERVED_WORDS, SQL92_RESERVED_WORDS, SQL99_RESERVED_WORDS, supportedJdbcTypesById, supportedOptions, unsupportedJdbcTypesById

Fields inherited from interface DatastoreAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, BIT_IS_REALLY_BOOLEAN, BLOB_SET_USING_SETSTRING, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, COLUMN_LENGTH_SEMANTICS, CREATE_INDEX_COLUMN_ORDERING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, CROSSJOIN_ASINNER11_SYNTAX, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_IN_END_CREATE_STATEMENTS, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, GROUP_BY_REQUIRES_ALL_SELECT_PRIMARIES, GROUPING_WITH_SELECT_FOR_UPDATE, HAVING_WITH_SELECT_FOR_UPDATE, HOLD_CURSORS_OVER_COMMIT, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMN_TYPE_SPECIFICATION, IDENTITY_COLUMNS, IDENTITY_KEYS_NULL_SPECIFICATION, IDENTITY_PK_IN_CREATE_TABLE_COLUMN_DEF, INCLUDE_ORDERBY_COLS_IN_SELECT, INCLUDE_TABLE_INDEX_STATISTICS, LOCK_ROW_USING_OPTION_AFTER_FROM, LOCK_ROW_USING_OPTION_WITHIN_JOIN, LOCK_ROW_USING_SELECT_FOR_UPDATE, LOCK_ROW_USING_SELECT_FOR_UPDATE_NOWAIT, MULTITABLES_WITH_SELECT_FOR_UPDATE, NATIVE_ENUM_TYPE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, OPERATOR_BITWISE_AND, OPERATOR_BITWISE_OR, OPERATOR_BITWISE_XOR, ORDERBY_NULLS_DIRECTIVES, ORDERBY_NULLS_USING_CASE_NULL, ORDERBY_NULLS_USING_COLUMN_IS_NULL, ORDERBY_NULLS_USING_ISNULL, ORDERBY_USING_SELECT_COLUMN_INDEX, ORDERING_WITH_SELECT_FOR_UPDATE, PARAMETER_IN_CASE_IN_UPDATE_CLAUSE, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, PROJECTION_IN_TABLE_REFERENCE_JOINS, RAW_PREFIX_LIKE_STATEMENTS, RESULTSET_TYPE_FORWARD_ONLY, RESULTSET_TYPE_SCROLL_INSENSITIVE, RESULTSET_TYPE_SCROLL_SENSITIVE, RIGHT_OUTER_JOIN, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES, SOME_ANY_ALL_SUBQUERY_EXPRESSIONS, STATEMENT_BATCHING, STORED_PROCEDURES, SUBQUERY_IN_HAVING, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, UPDATE_DELETE_STATEMENT_ALLOW_TABLE_ALIAS_IN_WHERE_CLAUSE, UPDATE_STATEMENT_ALLOW_TABLE_ALIAS_IN_SET_CLAUSE, USE_UNION_ALL, VALUE_GENERATION_UUID_STRING, VIEWS

Constructor Summary

Constructors

Constructor	Description
CloudSpannerAdapter(DatabaseMetaData metadata)

Method Summary

Modifier and Type	Method	Description
String	getAddPrimaryKeyStatement(PrimaryKey pk, IdentifierFactory factory)	Cannot add or change primary key after creation
String	getCreateDatabaseStatement(String catalogName, String schemaName)	Create database statement for Spanner JDBC.
String	getCreateTableStatement(TableImpl table, Column[] columns, Properties props, IdentifierFactory factory)	Creates a spanner table with primary key.
String	getDropDatabaseStatement(String catalogName, String schemaName)	Drop database statement for Spanner JDBC
String	getDropTableStatement(Table table)	Drop table statement
String	getEscapeCharacter()	The character for escaping characters in pattern expressions.
String	getEscapePatternExpression()	Escape pattern is not supported in Spanner
String	getRangeByLimitEndOfStatementClause(long offset, long count, boolean hasOrdering)	Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMIT keyword.
Class<? extends SQLMethod>	getSQLMethodClass(String className, String methodName, org.datanucleus.ClassLoaderResolver clr)	Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).
int	getTransactionIsolationForSchemaCreation()	Spanner INFORMATION_SCHEMA works only in read-only transactions https://cloud.google.com/spanner/docs/information-schema
String	getVendorID()	How vendor calls this driver
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn)	This function adds on any missing JDBC types when not available from driver metadata Spanner driver only provides the common types.
boolean	isStatementCancel(SQLException sqle)	return whether this exception represents a cancelled statement.
boolean	isStatementTimeout(SQLException sqle)	return whether this exception represents a timed out statement.
boolean	isValidPrimaryKeyType(org.datanucleus.metadata.JdbcType jdbcType)	Spanner does not support NUMERIC (and hence DECIMAL) as a valid primary key column type.
protected void	loadColumnMappings(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr)	Load all datastore mappings defined in the associated plugins.
SQLTypeInfo	newSQLTypeInfo(ResultSet rs)	Create a new SQL type info from the current row of the passed ResultSet.
boolean	sequenceExists(Connection conn, String catalogName, String schemaName, String seqName)	Spanner does not support sequence statements.

Methods inherited from class BaseDatastoreAdapter

addSQLTypeForJDBCType, deregisterColumnMappingsForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddColumnStatement, getAddForeignKeyStatement, getCatalogName, getCatalogSeparator, getCheckConstraintForValues, getColumnMappingClass, getColumns, getContinuationString, getCreateIndexStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreProductName, getDatastoreProductVersion, getDefaultSqlTypeForJavaType, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getExistingIndexes, getIdentifierQuoteString, getIdentityJavaTypeForType, getIdentityKeyword, getIdentityLastValueStmt, getInsertStatementForNoColumns, getJDBCTypeForName, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNameForJDBCType, getNewUUIDFunction, getNumericConversionFunction, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getPreferredDefaultSQLTypeForJDBCType, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getReservedWords, getSchemaName, getSelectForUpdateText, getSelectNewUUIDStmt, getSelectWithLockOption, getSequenceCreateStmt, getSequenceNextStmt, getSQLOperationClass, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getUnlimitedLengthPrecisionValue, getUpdateTableStatement, initialise, initialiseDatastore, isIdentityFieldDataType, isReservedKeyword, newFKInfo, newRDBMSColumnInfo, registerColumnMapping, registerColumnMapping, supportsOption, supportsQueryFetchSize, supportsTransactionIsolation, toString, validToIndexMapping, validToSelectMappingInStatement

Methods inherited from class Object

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

Methods inherited from interface DatastoreAdapter

getIdentityKeyword

Field Details

CLOUD_SPANNER_RESERVED_KEYWORDS

public static final String CLOUD_SPANNER_RESERVED_KEYWORDS

See Also:

• Constant Field Values

Constructor Details

CloudSpannerAdapter

public CloudSpannerAdapter(DatabaseMetaData metadata)

Method Details

getVendorID

public String getVendorID()

How vendor calls this driver

Specified by:

getVendorID in interface DatastoreAdapter

Overrides:

getVendorID in class BaseDatastoreAdapter

Returns:

the vendor naming

getTransactionIsolationForSchemaCreation

public int getTransactionIsolationForSchemaCreation()

Spanner INFORMATION_SCHEMA works only in read-only transactions https://cloud.google.com/spanner/docs/information-schema

Specified by:

getTransactionIsolationForSchemaCreation in interface DatastoreAdapter

Overrides:

getTransactionIsolationForSchemaCreation in class BaseDatastoreAdapter

Returns:

transaction isolation level for schema creation

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
 org.datanucleus.store.connection.ManagedConnection mconn)

This function adds on any missing JDBC types when not available from driver metadata Spanner driver only provides the common types. We should map the missing ones.

JDBC type (Spanner type) as follows :- nvarchar (string), bigint (int64), binary (byte), double (float64), boolean (bool), date (date), timestamp (timestamp), numeric (numeric)

Copied the mappings from Hibernate, https://github.com/GoogleCloudPlatform/google-cloud-spanner-hibernate/blob/master/google-cloud-spanner-hibernate-dialect/src/main/java/com/google/cloud/spanner/hibernate/SpannerDialect.java

The precision values are obtained from Spanner JDBC driver metadata https://github.com/googleapis/java-spanner-jdbc/blob/master/src/main/java/com/google/cloud/spanner/jdbc/JdbcDatabaseMetaData.java

Specified by:

initialiseTypes in interface DatastoreAdapter

Overrides:

initialiseTypes in class BaseDatastoreAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - managed connection to use

isValidPrimaryKeyType

public boolean isValidPrimaryKeyType(org.datanucleus.metadata.JdbcType jdbcType)

Spanner does not support NUMERIC (and hence DECIMAL) as a valid primary key column type.

Specified by:

isValidPrimaryKeyType in interface DatastoreAdapter

Overrides:

isValidPrimaryKeyType in class BaseDatastoreAdapter

Parameters:

jdbcType - the jdbc type to check

Returns:

Whether the provided type is suitable for part of the PK

sequenceExists

public boolean sequenceExists(Connection conn,
 String catalogName,
 String schemaName,
 String seqName)

Spanner does not support sequence statements.

Specified by:

sequenceExists in interface DatastoreAdapter

Overrides:

sequenceExists in class BaseDatastoreAdapter

Parameters:

conn - Connection to use for checking

catalogName - Catalog name

schemaName - Schema name

seqName - Name of the sequence

Returns:

false since Spanner does not support sequence statements

getCreateDatabaseStatement

public String getCreateDatabaseStatement(String catalogName,
 String schemaName)

Create database statement for Spanner JDBC.

Specified by:

getCreateDatabaseStatement in interface DatastoreAdapter

Overrides:

getCreateDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - catalog name (does not exist in Spanner)

schemaName - schema name

Returns:

The DDL statement

getDropDatabaseStatement

public String getDropDatabaseStatement(String catalogName,
 String schemaName)

Drop database statement for Spanner JDBC

Specified by:

getDropDatabaseStatement in interface DatastoreAdapter

Overrides:

getDropDatabaseStatement in class BaseDatastoreAdapter

Parameters:

catalogName - catalog name (does not exist in Spanner)

schemaName - schema name

Returns:

The DDL statement

getDropTableStatement

public String getDropTableStatement(Table table)

Drop table statement

Specified by:

getDropTableStatement in interface DatastoreAdapter

Overrides:

getDropTableStatement in class BaseDatastoreAdapter

Parameters:

table - to drop.

Returns:

The text of the SQL statement.

getCreateTableStatement

public String getCreateTableStatement(TableImpl table,
 Column[] columns,
 Properties props,
 IdentifierFactory factory)

Creates a spanner table with primary key. Many other features like check, constraint, interleave, cascade are not supported yet. It is better to create table without using Datanucleus. Instead, use plain SQL statements.

Specified by:

getCreateTableStatement in interface DatastoreAdapter

Overrides:

getCreateTableStatement in class BaseDatastoreAdapter

Parameters:

table - the table to create.

columns - the columns of the table.

props - properties for controlling the table creation

factory - factory for identifiers

Returns:

The text of the SQL statement.

getAddPrimaryKeyStatement

public String getAddPrimaryKeyStatement(PrimaryKey pk,
 IdentifierFactory factory)

Cannot add or change primary key after creation

Specified by:

getAddPrimaryKeyStatement in interface DatastoreAdapter

Overrides:

getAddPrimaryKeyStatement in class BaseDatastoreAdapter

Parameters:

pk - an object describing the primary key.

factory - identifier factory

Returns:

The text of the SQL statement.

getEscapePatternExpression

public String getEscapePatternExpression()

Escape pattern is not supported in Spanner

Specified by:

getEscapePatternExpression in interface DatastoreAdapter

Overrides:

getEscapePatternExpression in class BaseDatastoreAdapter

Returns:

the character.

getEscapeCharacter

public String getEscapeCharacter()

The character for escaping characters in pattern expressions.

Specified by:

getEscapeCharacter in interface DatastoreAdapter

Overrides:

getEscapeCharacter in class BaseDatastoreAdapter

Returns:

the character.

getRangeByLimitEndOfStatementClause

public String getRangeByLimitEndOfStatementClause(long offset,
 long count,
 boolean hasOrdering)

Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the LIMIT keyword.

Specified by:

getRangeByLimitEndOfStatementClause in interface DatastoreAdapter

Overrides:

getRangeByLimitEndOfStatementClause in class BaseDatastoreAdapter

Parameters:

offset - the offset to return from

count - the number of items to return

hasOrdering - whether ordering is present

Returns:

the SQL to append to allow for ranges using OFFSET/FETCH.

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: DatastoreAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface DatastoreAdapter

Overrides:

newSQLTypeInfo in class BaseDatastoreAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

isStatementCancel

public boolean isStatementCancel(SQLException sqle)

Description copied from class: BaseDatastoreAdapter

return whether this exception represents a cancelled statement.

Specified by:

isStatementCancel in interface DatastoreAdapter

Overrides:

isStatementCancel in class BaseDatastoreAdapter

Parameters:

sqle - the exception

Returns:

whether it is a cancel

isStatementTimeout

public boolean isStatementTimeout(SQLException sqle)

Description copied from class: BaseDatastoreAdapter

return whether this exception represents a timed out statement.

Specified by:

isStatementTimeout in interface DatastoreAdapter

Overrides:

isStatementTimeout in class BaseDatastoreAdapter

Parameters:

sqle - the exception

Returns:

whether it is a timeout

getSQLMethodClass

public Class<? extends SQLMethod> getSQLMethodClass(String className,
 String methodName,
 org.datanucleus.ClassLoaderResolver clr)

Description copied from interface: DatastoreAdapter

Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).

Specified by:

getSQLMethodClass in interface DatastoreAdapter

Overrides:

getSQLMethodClass in class BaseDatastoreAdapter

Parameters:

className - Name of the class (or null if this is a STATIC method)

methodName - Method name

clr - ClassLoader resolver, in case className is a subclass of a supported type

Returns:

The SQLMethod class (or null if not defined for this datastore).

loadColumnMappings

protected void loadColumnMappings(org.datanucleus.plugin.PluginManager mgr,
 org.datanucleus.ClassLoaderResolver clr)

Load all datastore mappings defined in the associated plugins. We handle RDBMS datastore mappings so refer to rdbms-mapping-class, jdbc-type, sql-type in particular. SQL Type (Spanner Type) as follows :- nvarchar (string), bigint (int64), binary (byte), double (float64), boolean (bool), date (date), timestamp (timestamp), numeric (numeric)

Overrides:

loadColumnMappings in class BaseDatastoreAdapter

Parameters:

mgr - the PluginManager

clr - the ClassLoaderResolver