Spring Framework 6.1.4 · org.springframework.jdbc.core.metadata.TableMetaDataContext

Modifier and Type	Class and Description
private static class	TableMetaDataContext.QuoteHandler

Modifier and Type	Field and Description
private boolean	accessTableColumnMetaData
private String	catalogName
private boolean	generatedKeyColumnsUsed
protected final Log	logger
private TableMetaDataProvider	metaDataProvider
private boolean	overrideIncludeSynonymsDefault
private boolean	quoteIdentifiers
private String	schemaName
private List<String>	tableColumns
private String	tableName

Access	Constructor and Description
public	TableMetaDataContext()

Method Summary

Modifier and Type	Method and Description
public String	Returns: the insert string to be used createInsertString(String... generatedKeyNames) Build the insert string based on configuration and meta-data information.
public int[]	Returns: the array of types to be used createInsertTypes() Build the array of `java.sql.Types` based on configuration and meta-data information.
public String	getCatalogName() Get the name of the catalog for this context.
public String	getSchemaName() Get the name of the schema for this context.
public String	getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName) Get the simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported.
public List<String>	getTableColumns() Get a List of the table column names.
public String	getTableName() Get the name of the table for this context.
public boolean	isAccessTableColumnMetaData() Are we accessing table meta-data?
public boolean	isGeneratedKeysColumnNameArraySupported() Does this database support a column name String array for retrieving generated keys?
public boolean	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() Does this database support the JDBC feature for retrieving generated keys?
public boolean	isOverrideIncludeSynonymsDefault() Are we overriding include synonyms default?
public boolean	isQuoteIdentifiers() Are we quoting identifiers?
public List<Object>	matchInParameterValuesWithInsertColumns(SqlParameterSource the parameter names and values parameterSource) Match the provided column names and values with the list of columns used.
public List<Object>	matchInParameterValuesWithInsertColumns(Map<String, ?> the parameter names and values inParameters) Match the provided column names and values with the list of columns used.
private TableMetaDataProvider	obtainMetaDataProvider()
public void	processMetaData(DataSource the DataSource being used dataSource, List<String> any columns that are declared declaredColumns, String[] name of generated keys generatedKeyNames) Process the current meta-data with the provided configuration options.
protected List<String>	reconcileColumnsToUse(List<String> declared column names declaredColumns, String[] names of generated key columns generatedKeyNames) Compare columns created from meta-data with declared columns and return a reconciled list.
public void	setAccessTableColumnMetaData(boolean accessTableColumnMetaData) Specify whether we should access table column meta-data.
public void	setCatalogName(String catalogName) Set the name of the catalog for this context.
public void	setOverrideIncludeSynonymsDefault(boolean override) Specify whether we should override default for accessing synonyms.
public void	setQuoteIdentifiers(boolean whether identifiers should be quoted quoteIdentifiers) Specify whether we are quoting SQL identifiers.
public void	setSchemaName(String schemaName) Set the name of the schema for this context.
public void	setTableName(String tableName) Set the name of the table for this context.

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

catalogName	back to summary
private String catalogName Annotations @Nullable

generatedKeyColumnsUsed	back to summary
private boolean generatedKeyColumnsUsed

logger	back to summary
protected final Log logger

overrideIncludeSynonymsDefault	back to summary
private boolean overrideIncludeSynonymsDefault

quoteIdentifiers	back to summary
private boolean quoteIdentifiers

schemaName	back to summary
private String schemaName Annotations @Nullable

tableColumns	back to summary
private List<String> tableColumns

tableName	back to summary
private String tableName Annotations @Nullable

Method Detail

createInsertString	back to summary
public String createInsertString(String... generatedKeyNames) Build the insert string based on configuration and meta-data information. Returns:String the insert string to be used

createInsertString

back to summary

public String createInsertString(String... generatedKeyNames)

Build the insert string based on configuration and meta-data information.

Returns:String: the insert string to be used

createInsertTypes back to summary

createInsertTypes	back to summary
public int[] createInsertTypes() Build the array of `java.sql.Types` based on configuration and meta-data information. Returns:int[] the array of types to be used

public int[] createInsertTypes()

Build the array of java.sql.Types based on configuration and meta-data information.

Returns:int[]: the array of types to be used

getCatalogName	back to summary
public String getCatalogName() Get the name of the catalog for this context. Annotations @Nullable

getCatalogName

back to summary

public String getCatalogName()

Get the name of the catalog for this context.

Annotations

@Nullable

getSchemaName	back to summary
public String getSchemaName() Get the name of the schema for this context. Annotations @Nullable

getSchemaName

back to summary

public String getSchemaName()

Get the name of the schema for this context.

Annotations

@Nullable

getSimpleQueryForGetGeneratedKey back to summary

getSimpleQueryForGetGeneratedKey	back to summary
public String getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName) Get the simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported. Annotations @Nullable See Also `isGetGeneratedKeysSimulated()`

public String getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName)

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

Annotations

@Nullable

See Also

isGetGeneratedKeysSimulated()

getTableColumns	back to summary
public List<String> getTableColumns() Get a List of the table column names.

getTableName	back to summary
public String getTableName() Get the name of the table for this context. Annotations @Nullable

getTableName

back to summary

public String getTableName()

Get the name of the table for this context.

Annotations

@Nullable

isAccessTableColumnMetaData	back to summary
public boolean isAccessTableColumnMetaData() Are we accessing table meta-data?

isGeneratedKeysColumnNameArraySupported back to summary

isGeneratedKeysColumnNameArraySupported	back to summary
public boolean isGeneratedKeysColumnNameArraySupported() Does this database support a column name String array for retrieving generated keys? See Also `java.sql.Connection#createStruct(String, Object[])`

public boolean isGeneratedKeysColumnNameArraySupported()

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

See Also: java.sql.Connection#createStruct(String, Object[])

isGetGeneratedKeysSimulated back to summary

isGetGeneratedKeysSimulated	back to summary
public boolean isGetGeneratedKeysSimulated() Does this database support a simple query to retrieve generated keys when the JDBC feature for retrieving generated keys is not supported? See Also `isGetGeneratedKeysSupported()`, `getSimpleQueryForGetGeneratedKey(String, String)`

public boolean isGetGeneratedKeysSimulated()

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

See Also: isGetGeneratedKeysSupported(), getSimpleQueryForGetGeneratedKey(String, String)

isGetGeneratedKeysSupported back to summary

isGetGeneratedKeysSupported	back to summary
public boolean isGetGeneratedKeysSupported() Does this database support the JDBC feature for retrieving generated keys? See Also `java.sql.DatabaseMetaData#supportsGetGeneratedKeys()`

public boolean isGetGeneratedKeysSupported()

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

See Also: java.sql.DatabaseMetaData#supportsGetGeneratedKeys()

isOverrideIncludeSynonymsDefault	back to summary
public boolean isOverrideIncludeSynonymsDefault() Are we overriding include synonyms default?

isQuoteIdentifiers back to summary

isQuoteIdentifiers	back to summary
public boolean isQuoteIdentifiers() Are we quoting identifiers? Since 6.1 See Also `setQuoteIdentifiers(boolean)`

public boolean isQuoteIdentifiers()

Are we quoting identifiers?

Since: 6.1
See Also: setQuoteIdentifiers(boolean)

matchInParameterValuesWithInsertColumns	back to summary
public List<Object> matchInParameterValuesWithInsertColumns(SqlParameterSource parameterSource) Match the provided column names and values with the list of columns used. Parameters parameterSource:SqlParameterSource the parameter names and values

matchInParameterValuesWithInsertColumns

back to summary

public List<Object> matchInParameterValuesWithInsertColumns(SqlParameterSource parameterSource)

Match the provided column names and values with the list of columns used.

Parameters

parameterSource:SqlParameterSource: the parameter names and values

matchInParameterValuesWithInsertColumns	back to summary
public List<Object> matchInParameterValuesWithInsertColumns(Map<String, ?> inParameters) Match the provided column names and values with the list of columns used. Parameters inParameters:Map<String, ?> the parameter names and values

matchInParameterValuesWithInsertColumns

back to summary

public List<Object> matchInParameterValuesWithInsertColumns(Map<String, ?> inParameters)

Match the provided column names and values with the list of columns used.

Parameters

inParameters:Map<String, ?>: the parameter names and values

obtainMetaDataProvider	back to summary
private TableMetaDataProvider obtainMetaDataProvider()

processMetaData

back to summary

public void processMetaData(DataSource dataSource, List<String> declaredColumns, String[] generatedKeyNames)

Process the current meta-data with the provided configuration options.

Parameters

dataSource:DataSource: the DataSource being used
declaredColumns:List<String>: any columns that are declared
generatedKeyNames:String[]: name of generated keys

reconcileColumnsToUse	back to summary
protected List<String> reconcileColumnsToUse(List<String> declaredColumns, String[] generatedKeyNames) Compare columns created from meta-data with declared columns and return a reconciled list. Parameters declaredColumns:List<String> declared column names generatedKeyNames:String[] names of generated key columns

reconcileColumnsToUse

back to summary

protected List<String> reconcileColumnsToUse(List<String> declaredColumns, String[] generatedKeyNames)

Compare columns created from meta-data with declared columns and return a reconciled list.

Parameters

declaredColumns:List<String>: declared column names
generatedKeyNames:String[]: names of generated key columns

setAccessTableColumnMetaData	back to summary
public void setAccessTableColumnMetaData(boolean accessTableColumnMetaData) Specify whether we should access table column meta-data.

setCatalogName	back to summary
public void setCatalogName(String catalogName) Set the name of the catalog for this context.

setOverrideIncludeSynonymsDefault	back to summary
public void setOverrideIncludeSynonymsDefault(boolean override) Specify whether we should override default for accessing synonyms.

setQuoteIdentifiers back to summary

setQuoteIdentifiers	back to summary
public void setQuoteIdentifiers(boolean quoteIdentifiers) Specify whether we are quoting SQL identifiers. Defaults to `false`. If set to `true`, the identifier quote string for the underlying database will be used to quote SQL identifiers in generated SQL statements. Parameters quoteIdentifiers:boolean whether identifiers should be quoted Since 6.1 See Also `java.sql.DatabaseMetaData#getIdentifierQuoteString()`

public void setQuoteIdentifiers(boolean quoteIdentifiers)

Specify whether we are quoting SQL identifiers.

Defaults to false. If set to true, the identifier quote string for the underlying database will be used to quote SQL identifiers in generated SQL statements.

Parameters

quoteIdentifiers:boolean: whether identifiers should be quoted

Since

6.1

setSchemaName	back to summary
public void setSchemaName(String schemaName) Set the name of the schema for this context.

setTableName	back to summary
public void setTableName(String tableName) Set the name of the table for this context.

public Class TableMetaDataContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class TableMetaDataContext.QuoteHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final String	identifierQuoteString
private final boolean	quoting