Top Description Fields Constructors Methods
org.springframework.jdbc.core.metadata

public Class PostgresCallMetaDataProvider

extends GenericCallMetaDataProvider
Class Inheritance
Imports
java.sql.DatabaseMetaData, .SQLException, .Types, org.springframework.jdbc.core.ColumnMapRowMapper, .SqlOutParameter, .SqlParameter, org.springframework.lang.Nullable
Postgres-specific implementation for the CallMetaDataProvider interface. This class is intended for internal use by the Simple JDBC classes.
Authors
Thomas Risberg, Juergen Hoeller
Since
2.5

Field Summary

Modifier and TypeField and Description
private static final String
RETURN_VALUE_NAME

private final String
schemaName

Inherited from org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider:
logger

Constructor Summary

AccessConstructor and Description
public
PostgresCallMetaDataProvider(DatabaseMetaData databaseMetaData)

Method Summary

Modifier and TypeMethod and Description
public boolean
byPassReturnParameter(String parameterName)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.byPassReturnParameter.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.byPassReturnParameter.

Should we bypass the return parameter with the specified name?
public SqlParameter
createDefaultOutParameter(String
the name of the parameter
parameterName, CallParameterMetaData
meta-data used for this call
meta)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.createDefaultOutParameter.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.createDefaultOutParameter.

Create a default out parameter based on the provided meta-data.
public int
getRefCursorSqlType()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.getRefCursorSqlType.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.getRefCursorSqlType.

Get the java.sql.Types type for columns that return ResultSets as ref cursors if this feature is supported.
public boolean
isRefCursorSupported()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.isRefCursorSupported.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.isRefCursorSupported.

Does this database support returning ResultSets as ref cursors to be retrieved with java.sql.CallableStatement#getObject(int) for the specified column?
public boolean
isReturnResultSetSupported()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.isReturnResultSetSupported.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.isReturnResultSetSupported.

Does this database support returning ResultSets that should be retrieved with the JDBC call: java.sql.Statement#getResultSet()?
public String
metaDataSchemaNameToUse(String schemaName)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.metaDataSchemaNameToUse.

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

Provide any modification of the schema name passed in to match the meta-data currently used.
Inherited from org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider:
catalogNameToUsecreateDefaultInOutParametercreateDefaultInParametergetCallParameterMetaDatagetUserNameinitializeWithMetaDatainitializeWithProcedureColumnMetaDataisProcedureColumnMetaDataUsedisStoresLowerCaseIdentifiersisStoresUpperCaseIdentifiersisSupportsCatalogsInProcedureCallsisSupportsSchemasInProcedureCallsmetaDataCatalogNameToUsenamedParameterBindingToUseparameterNameToUseprocedureNameToUseschemaNameToUsesetStoresLowerCaseIdentifierssetStoresUpperCaseIdentifierssetSupportsCatalogsInProcedureCallssetSupportsSchemasInProcedureCalls

Field Detail

RETURN_VALUE_NAMEback to summary
private static final String RETURN_VALUE_NAME
schemaNameback to summary
private final String schemaName

Constructor Detail

PostgresCallMetaDataProviderback to summary
public PostgresCallMetaDataProvider(DatabaseMetaData databaseMetaData) throws SQLException

Method Detail

byPassReturnParameterback to summary
public boolean byPassReturnParameter(String parameterName)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.byPassReturnParameter.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.byPassReturnParameter.

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.byPassReturnParameter.

Should we bypass the return parameter with the specified name?

This allows the database specific implementation to skip the processing for specific results returned by the database call.

Annotations
@Override
createDefaultOutParameterback to summary
public SqlParameter createDefaultOutParameter(String parameterName, CallParameterMetaData meta)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.createDefaultOutParameter.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.createDefaultOutParameter.

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.createDefaultOutParameter.

Create a default out parameter based on the provided meta-data.

This is used when no explicit parameter declaration has been made.

Parameters
parameterName:String

the name of the parameter

meta:CallParameterMetaData

meta-data used for this call

Returns:SqlParameter

the configured SqlOutParameter

Annotations
@Override
getRefCursorSqlTypeback to summary
public int getRefCursorSqlType()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.getRefCursorSqlType.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.getRefCursorSqlType.

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.getRefCursorSqlType.

Get the java.sql.Types type for columns that return ResultSets as ref cursors if this feature is supported.

Annotations
@Override
isRefCursorSupportedback to summary
public boolean isRefCursorSupported()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.isRefCursorSupported.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.isRefCursorSupported.

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.isRefCursorSupported.

Does this database support returning ResultSets as ref cursors to be retrieved with java.sql.CallableStatement#getObject(int) for the specified column?

Annotations
@Override
isReturnResultSetSupportedback to summary
public boolean isReturnResultSetSupported()

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.isReturnResultSetSupported.

Implements org.springframework.jdbc.core.metadata.CallMetaDataProvider.isReturnResultSetSupported.

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.isReturnResultSetSupported.

Does this database support returning ResultSets that should be retrieved with the JDBC call: java.sql.Statement#getResultSet()?

Annotations
@Override
metaDataSchemaNameToUseback to summary
public String metaDataSchemaNameToUse(String schemaName)

Overrides org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider.metaDataSchemaNameToUse.

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

Doc from org.springframework.jdbc.core.metadata.CallMetaDataProvider.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