Modifier and Type	Class and Description
private static record	GenericTableMetaDataProvider.TableMetaData Record representing table meta-data.

Modifier and Type	Field and Description
private String	databaseVersion The version of the database.
private boolean	generatedKeysColumnNameArraySupported Indicates whether the use of a String[] for generated keys is supported.
private boolean	getGeneratedKeysSupported Indicates whether generated keys retrieval is supported.
private String	identifierQuoteString The string used to quote SQL identifiers.
protected static final Log	logger Logger available to subclasses.
private static final List<String>	productsNotSupportingGeneratedKeysColumnNameArray Database products we know not supporting the use of a String[] for generated keys.
private boolean	storesLowerCaseIdentifiers Indicates whether the identifiers are lowercased.
private boolean	storesUpperCaseIdentifiers Indicates whether the identifiers are uppercased.
private boolean	tableColumnMetaDataUsed Indicates whether column meta-data has been used.
private final List<TableParameterMetaData>	tableParameterMetaData Collection of TableParameterMetaData objects.
private final String	userName The name of the user currently connected.

Access	Constructor and Description
protected	GenericTableMetaDataProvider(DatabaseMetaData meta-data to be used databaseMetaData) Constructor used to initialize with provided database meta-data.

Method Summary

Modifier and Type	Method and Description
public String	catalogNameToUse(String catalogName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.catalogNameToUse. Get the catalog name formatted based on meta-data information.
public String	columnNameToUse(String columnName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.columnNameToUse. Get the column name formatted based on meta-data information.
private GenericTableMetaDataProvider.TableMetaData	findTableMetaData(String schemaName, String tableName, Map<String, GenericTableMetaDataProvider.TableMetaData> tableMeta)
protected String	getDatabaseVersion() Provide access to the version info for subclasses.
protected String	getDefaultSchema() Provide access to the default schema for subclasses.
public String	getIdentifierQuoteString() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getIdentifierQuoteString. Get the string used to quote SQL identifiers.
public String	getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getSimpleQueryForGetGeneratedKey. Get the simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported.
public List<TableParameterMetaData>	getTableParameterMetaData() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getTableParameterMetaData. Get the table parameter meta-data that is currently used.
private String	identifierNameToUse(String identifierName)
public void	initializeWithMetaData(DatabaseMetaData used to retrieve database specific information databaseMetaData) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithMetaData. Initialize using the database meta-data provided.
public void	initializeWithTableColumnMetaData(DatabaseMetaData used to retrieve database specific information databaseMetaData, String name of catalog to use (or `null` if none) catalogName, String name of schema name to use (or `null` if none) schemaName, String name of the table tableName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithTableColumnMetaData. Initialize using provided database meta-data, table and column information.
public boolean	isGeneratedKeysColumnNameArraySupported() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGeneratedKeysColumnNameArraySupported. Does this database support a column name String array for retrieving generated keys?
public boolean	isGetGeneratedKeysSimulated() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSimulated. Does this database support a simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported?
public boolean	isGetGeneratedKeysSupported() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSupported. Does this database support the JDBC feature for retrieving generated keys?
public boolean	isStoresLowerCaseIdentifiers()
public boolean	isStoresUpperCaseIdentifiers()
public boolean	isTableColumnMetaDataUsed() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isTableColumnMetaDataUsed. Are we using the meta-data for the table columns?
private void	locateTableAndProcessMetaData(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) Method supporting the meta-data processing for a table.
public String	metaDataCatalogNameToUse(String catalogName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataCatalogNameToUse. Provide any modification of the catalog name passed in to match the meta-data currently used.
public String	metaDataSchemaNameToUse(String schemaName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataSchemaNameToUse. Provide any modification of the schema name passed in to match the meta-data currently used.
private void	processTableColumns(DatabaseMetaData databaseMetaData, GenericTableMetaDataProvider.TableMetaData tmd) Method supporting the meta-data processing for a table's columns.
public String	schemaNameToUse(String schemaName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.schemaNameToUse. Get the schema name formatted based on meta-data information.
public void	setGeneratedKeysColumnNameArraySupported(boolean generatedKeysColumnNameArraySupported)
public void	setGetGeneratedKeysSupported(boolean getGeneratedKeysSupported)
public void	setStoresLowerCaseIdentifiers(boolean storesLowerCaseIdentifiers)
public void	setStoresUpperCaseIdentifiers(boolean storesUpperCaseIdentifiers)
public String	tableNameToUse(String tableName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.tableNameToUse. Get the table name formatted based on meta-data information.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

databaseVersion	back to summary
private String databaseVersion The version of the database. Annotations @Nullable

generatedKeysColumnNameArraySupported	back to summary
private boolean generatedKeysColumnNameArraySupported Indicates whether the use of a String[] for generated keys is supported.

getGeneratedKeysSupported	back to summary
private boolean getGeneratedKeysSupported Indicates whether generated keys retrieval is supported.

identifierQuoteString	back to summary
private String identifierQuoteString The string used to quote SQL identifiers.

logger	back to summary
protected static final Log logger Logger available to subclasses.

productsNotSupportingGeneratedKeysColumnNameArray	back to summary
private static final List<String> productsNotSupportingGeneratedKeysColumnNameArray Database products we know not supporting the use of a String[] for generated keys.

storesLowerCaseIdentifiers	back to summary
private boolean storesLowerCaseIdentifiers Indicates whether the identifiers are lowercased.

storesUpperCaseIdentifiers	back to summary
private boolean storesUpperCaseIdentifiers Indicates whether the identifiers are uppercased.

tableColumnMetaDataUsed	back to summary
private boolean tableColumnMetaDataUsed Indicates whether column meta-data has been used.

tableParameterMetaData	back to summary
private final List<TableParameterMetaData> tableParameterMetaData Collection of TableParameterMetaData objects.

userName	back to summary
private final String userName The name of the user currently connected. Annotations @Nullable

Constructor Detail

GenericTableMetaDataProvider

back to summary

protected GenericTableMetaDataProvider(DatabaseMetaData databaseMetaData) throws SQLException

Constructor used to initialize with provided database meta-data.

Parameters

databaseMetaData:DatabaseMetaData: meta-data to be used

Method Detail

catalogNameToUse	back to summary
public String catalogNameToUse(String catalogName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.catalogNameToUse. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.catalogNameToUse. Get the catalog name formatted based on meta-data information. This could include altering the case. Annotations @Override @Nullable

catalogNameToUse

back to summary

public String catalogNameToUse(String catalogName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.catalogNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.catalogNameToUse.

Get the catalog name formatted based on meta-data information.

This could include altering the case.

Annotations

@Override
@Nullable

columnNameToUse	back to summary
public String columnNameToUse(String columnName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.columnNameToUse. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.columnNameToUse. Get the column name formatted based on meta-data information. This could include altering the case. Annotations @Override @Nullable

columnNameToUse

back to summary

public String columnNameToUse(String columnName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.columnNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.columnNameToUse.

Get the column name formatted based on meta-data information.

This could include altering the case.

Annotations

@Override
@Nullable

findTableMetaData	back to summary
private GenericTableMetaDataProvider.TableMetaData findTableMetaData(String schemaName, String tableName, Map<String, GenericTableMetaDataProvider.TableMetaData> tableMeta)

getDatabaseVersion	back to summary
protected String getDatabaseVersion() Provide access to the version info for subclasses. Annotations @Nullable

getDatabaseVersion

back to summary

protected String getDatabaseVersion()

Provide access to the version info for subclasses.

Annotations

@Nullable

getDefaultSchema	back to summary
protected String getDefaultSchema() Provide access to the default schema for subclasses. Annotations @Nullable

getDefaultSchema

back to summary

protected String getDefaultSchema()

Provide access to the default schema for subclasses.

Annotations

@Nullable

getIdentifierQuoteString back to summary

getIdentifierQuoteString	back to summary
public String getIdentifierQuoteString() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getIdentifierQuoteString. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.getIdentifierQuoteString. Get the string used to quote SQL identifiers. This method returns a space (`" "`) if identifier quoting is not supported. Returns:String database identifier quote string Annotations @Override

public String getIdentifierQuoteString()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getIdentifierQuoteString.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.getIdentifierQuoteString.

Get the string used to quote SQL identifiers.

This method returns a space (" ") if identifier quoting is not supported.

Returns:String

database identifier quote string

Annotations

@Override

getSimpleQueryForGetGeneratedKey	back to summary
public String getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getSimpleQueryForGetGeneratedKey. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.getSimpleQueryForGetGeneratedKey. Get the simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported. Annotations @Override @Nullable

getSimpleQueryForGetGeneratedKey

back to summary

public String getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getSimpleQueryForGetGeneratedKey.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.getSimpleQueryForGetGeneratedKey.

Get the simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported.

Annotations

@Override
@Nullable

getTableParameterMetaData back to summary

public List<TableParameterMetaData> getTableParameterMetaData()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.getTableParameterMetaData.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.getTableParameterMetaData.

Get the table parameter meta-data that is currently used.

Returns:List<TableParameterMetaData>

a List of TableParameterMetaData

Annotations

@Override

identifierNameToUse	back to summary
private String identifierNameToUse(String identifierName) Annotations @Nullable

initializeWithMetaData

back to summary

public void initializeWithMetaData(DatabaseMetaData databaseMetaData) throws SQLException

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithMetaData.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithMetaData.

Initialize using the database meta-data provided.

Parameters

databaseMetaData:DatabaseMetaData: used to retrieve database specific information

Annotations

@Override

Exceptions

SQLException:: in case of initialization failure

initializeWithTableColumnMetaData back to summary

public void initializeWithTableColumnMetaData(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) throws SQLException

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithTableColumnMetaData.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.initializeWithTableColumnMetaData.

Initialize using provided database meta-data, table and column information.

This initialization can be turned off by specifying that column meta-data should not be used.

Parameters

databaseMetaData:DatabaseMetaData: used to retrieve database specific information
catalogName:String: name of catalog to use (or null if none)
schemaName:String: name of schema name to use (or null if none)
tableName:String: name of the table

Annotations

@Override

Exceptions

SQLException:: in case of initialization failure

isGeneratedKeysColumnNameArraySupported	back to summary
public boolean isGeneratedKeysColumnNameArraySupported() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGeneratedKeysColumnNameArraySupported. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGeneratedKeysColumnNameArraySupported. Does this database support a column name String array for retrieving generated keys? Annotations @Override

isGeneratedKeysColumnNameArraySupported

back to summary

public boolean isGeneratedKeysColumnNameArraySupported()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGeneratedKeysColumnNameArraySupported.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGeneratedKeysColumnNameArraySupported.

Does this database support a column name String array for retrieving generated keys?

Annotations

@Override

isGetGeneratedKeysSimulated	back to summary
public boolean isGetGeneratedKeysSimulated() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSimulated. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSimulated. Does this database support a simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported? Annotations @Override

isGetGeneratedKeysSimulated

back to summary

public boolean isGetGeneratedKeysSimulated()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSimulated.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSimulated.

Does this database support a simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported?

Annotations

@Override

isGetGeneratedKeysSupported	back to summary
public boolean isGetGeneratedKeysSupported() Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSupported. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSupported. Does this database support the JDBC feature for retrieving generated keys? Annotations @Override

isGetGeneratedKeysSupported

back to summary

public boolean isGetGeneratedKeysSupported()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSupported.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isGetGeneratedKeysSupported.

Does this database support the JDBC feature for retrieving generated keys?

Annotations

@Override

isStoresLowerCaseIdentifiers	back to summary
public boolean isStoresLowerCaseIdentifiers()

isStoresUpperCaseIdentifiers	back to summary
public boolean isStoresUpperCaseIdentifiers()

isTableColumnMetaDataUsed

back to summary

public boolean isTableColumnMetaDataUsed()

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.isTableColumnMetaDataUsed.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.isTableColumnMetaDataUsed.

Are we using the meta-data for the table columns?

Annotations

@Override

locateTableAndProcessMetaData	back to summary
private void locateTableAndProcessMetaData(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String tableName) Method supporting the meta-data processing for a table.

metaDataCatalogNameToUse

back to summary

public String metaDataCatalogNameToUse(String catalogName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataCatalogNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataCatalogNameToUse.

Provide any modification of the catalog name passed in to match the meta-data currently used.

The returned value will be used for meta-data lookups.

This could include altering the case used or providing a base catalog if none is provided.

Annotations

@Override
@Nullable

metaDataSchemaNameToUse

back to summary

public String metaDataSchemaNameToUse(String schemaName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataSchemaNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.metaDataSchemaNameToUse.

Provide any modification of the schema name passed in to match the meta-data currently used.

The returned value will be used for meta-data lookups.

This could include altering the case used or providing a base schema if none is provided.

Annotations

@Override
@Nullable

processTableColumns	back to summary
private void processTableColumns(DatabaseMetaData databaseMetaData, GenericTableMetaDataProvider.TableMetaData tmd) Method supporting the meta-data processing for a table's columns.

schemaNameToUse	back to summary
public String schemaNameToUse(String schemaName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.schemaNameToUse. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.schemaNameToUse. Get the schema name formatted based on meta-data information. This could include altering the case. Annotations @Override @Nullable

schemaNameToUse

back to summary

public String schemaNameToUse(String schemaName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.schemaNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.schemaNameToUse.

Get the schema name formatted based on meta-data information.

This could include altering the case.

Annotations

@Override
@Nullable

setGeneratedKeysColumnNameArraySupported	back to summary
public void setGeneratedKeysColumnNameArraySupported(boolean generatedKeysColumnNameArraySupported)

setGetGeneratedKeysSupported	back to summary
public void setGetGeneratedKeysSupported(boolean getGeneratedKeysSupported)

setStoresLowerCaseIdentifiers	back to summary
public void setStoresLowerCaseIdentifiers(boolean storesLowerCaseIdentifiers)

setStoresUpperCaseIdentifiers	back to summary
public void setStoresUpperCaseIdentifiers(boolean storesUpperCaseIdentifiers)

tableNameToUse	back to summary
public String tableNameToUse(String tableName) Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.tableNameToUse. Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.tableNameToUse. Get the table name formatted based on meta-data information. This could include altering the case. Annotations @Override @Nullable

tableNameToUse

back to summary

public String tableNameToUse(String tableName)

Implements org.springframework.jdbc.core.metadata.TableMetaDataProvider.tableNameToUse.

Doc from org.springframework.jdbc.core.metadata.TableMetaDataProvider.tableNameToUse.

Get the table name formatted based on meta-data information.

This could include altering the case.

Annotations

@Override
@Nullable

org.springframework.jdbc.core.metadata back to summary

private final Record GenericTableMetaDataProvider.TableMetaData

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.springframework.jdbc.core.metadata.GenericTableMetaDataProvider.TableMetaData

Record Components

catalogName:String
schemaName:String
tableName:String

Record representing table meta-data.

Field Summary

Modifier and Type	Field and Description
private final String	catalogName Record Component accessed by catalogName().
private final String	schemaName Record Component accessed by schemaName().
private final String	tableName Record Component accessed by tableName().

Constructor Summary

Access	Constructor and Description
private	TableMetaData(String catalogName, String schemaName, String tableName)

Method Summary

Modifier and Type	Method and Description
public String	catalogName() Record Component getter of catalogName.
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	schemaName() Record Component getter of schemaName.
public String	tableName() Record Component getter of tableName.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

catalogName	back to summary
private final String catalogName Record Component accessed by catalogName(). Annotations @Nullable

schemaName	back to summary
private final String schemaName Record Component accessed by schemaName(). Annotations @Nullable

tableName	back to summary
private final String tableName Record Component accessed by tableName(). Annotations @Nullable

Constructor Detail

TableMetaData	back to summary
private TableMetaData(String catalogName, String schemaName, String tableName)

Method Detail

catalogName

back to summary

public String catalogName()

Record Component getter of catalogName.

Annotations

@Nullable

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

schemaName

back to summary

public String schemaName()

Record Component getter of schemaName.

Annotations

@Nullable

tableName

back to summary

public String tableName()

Record Component getter of tableName.

Annotations

@Nullable

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String: a string representation of the object.

public Class GenericTableMetaDataProvider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record GenericTableMetaDataProvider.TableMetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail