OpenJDK 27 · java.sql.ParameterMetaData · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	parameterModeIn The constant indicating that the parameter's mode is IN.
public static final int	parameterModeInOut The constant indicating that the parameter's mode is INOUT.
public static final int	parameterModeOut The constant indicating that the parameter's mode is OUT.
public static final int	parameterModeUnknown The constant indicating that the mode of the parameter is unknown.
public static final int	parameterNoNulls The constant indicating that a parameter will not allow `NULL` values.
public static final int	parameterNullable The constant indicating that a parameter will allow `NULL` values.
public static final int	parameterNullableUnknown The constant indicating that the nullability of a parameter is unknown.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the fully-qualified name of the class in the Java programming language that would be used by the method `PreparedStatement.setObject` to set the value in the specified parameter. This is the class name used for custom mapping. getParameterClassName(int the first parameter is 1, the second is 2, ... param) Retrieves the fully-qualified name of the Java class whose instances should be passed to the method `PreparedStatement.setObject`.
public int	Returns: the number of parameters getParameterCount() Retrieves the number of parameters in the `PreparedStatement` object for which this `ParameterMetaData` object contains information.
public int	Returns: mode of the parameter; one of `ParameterMetaData.parameterModeIn`, `ParameterMetaData.parameterModeOut`, or `ParameterMetaData.parameterModeInOut` `ParameterMetaData.parameterModeUnknown`. getParameterMode(int the first parameter is 1, the second is 2, ... param) Retrieves the designated parameter's mode.
public int	Returns: SQL type from `java.sql.Types` getParameterType(int the first parameter is 1, the second is 2, ... param) Retrieves the designated parameter's SQL type.
public String	Returns: type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned. getParameterTypeName(int the first parameter is 1, the second is 2, ... param) Retrieves the designated parameter's database-specific type name.
public int	Returns: precision getPrecision(int the first parameter is 1, the second is 2, ... param) Retrieves the designated parameter's specified column size.
public int	Returns: scale getScale(int the first parameter is 1, the second is 2, ... param) Retrieves the designated parameter's number of digits to right of the decimal point.
public int	Returns: the nullability status of the given parameter; one of `ParameterMetaData.parameterNoNulls`, `ParameterMetaData.parameterNullable`, or `ParameterMetaData.parameterNullableUnknown` isNullable(int the first parameter is 1, the second is 2, ... param) Retrieves whether null values are allowed in the designated parameter.
public boolean	Returns: `true` if so; `false` otherwise isSigned(int the first parameter is 1, the second is 2, ... param) Retrieves whether values for the designated parameter can be signed numbers.

Inherited from java.sql.Wrapper:: isWrapperFor unwrap

Field Detail

parameterModeIn	back to summary
public static final int parameterModeIn The constant indicating that the parameter's mode is IN.

parameterModeInOut	back to summary
public static final int parameterModeInOut The constant indicating that the parameter's mode is INOUT.

parameterModeOut	back to summary
public static final int parameterModeOut The constant indicating that the parameter's mode is OUT.

parameterModeUnknown	back to summary
public static final int parameterModeUnknown The constant indicating that the mode of the parameter is unknown.

parameterNoNulls	back to summary
public static final int parameterNoNulls The constant indicating that a parameter will not allow `NULL` values.

parameterNullable	back to summary
public static final int parameterNullable The constant indicating that a parameter will allow `NULL` values.

parameterNullableUnknown	back to summary
public static final int parameterNullableUnknown The constant indicating that the nullability of a parameter is unknown.

Method Detail

getParameterClassName back to summary

getParameterClassName	back to summary
public String getParameterClassName(int param) throws SQLException Retrieves the fully-qualified name of the Java class whose instances should be passed to the method `PreparedStatement.setObject`. Parameters param:int the first parameter is 1, the second is 2, ... Returns:String the fully-qualified name of the class in the Java programming language that would be used by the method `PreparedStatement.setObject` to set the value in the specified parameter. This is the class name used for custom mapping. Exceptions SQLException: if a database access error occurs Since 1.4

public String getParameterClassName(int param) throws SQLException

Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:String

the fully-qualified name of the class in the Java programming language that would be used by the method PreparedStatement.setObject to set the value in the specified parameter. This is the class name used for custom mapping.

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getParameterCount back to summary

getParameterCount	back to summary
public int getParameterCount() throws SQLException Retrieves the number of parameters in the `PreparedStatement` object for which this `ParameterMetaData` object contains information. Returns:int the number of parameters Exceptions SQLException: if a database access error occurs Since 1.4

public int getParameterCount() throws SQLException

Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.

Returns:int

the number of parameters

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getParameterMode back to summary

getParameterMode	back to summary
public int getParameterMode(int param) throws SQLException Retrieves the designated parameter's mode. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int mode of the parameter; one of `ParameterMetaData.parameterModeIn`, `ParameterMetaData.parameterModeOut`, or `ParameterMetaData.parameterModeInOut` `ParameterMetaData.parameterModeUnknown`. Exceptions SQLException: if a database access error occurs Since 1.4

public int getParameterMode(int param) throws SQLException

Retrieves the designated parameter's mode.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getParameterType back to summary

getParameterType	back to summary
public int getParameterType(int param) throws SQLException Retrieves the designated parameter's SQL type. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int SQL type from `java.sql.Types` Exceptions SQLException: if a database access error occurs Since 1.4 See Also `Types`

public int getParameterType(int param) throws SQLException

Retrieves the designated parameter's SQL type.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

SQL type from java.sql.Types

Exceptions

SQLException:: if a database access error occurs

Since

1.4

See Also

Types

getParameterTypeName	back to summary
public String getParameterTypeName(int param) throws SQLException Retrieves the designated parameter's database-specific type name. Parameters param:int the first parameter is 1, the second is 2, ... Returns:String type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned. Exceptions SQLException: if a database access error occurs Since 1.4

getParameterTypeName

back to summary

public String getParameterTypeName(int param) throws SQLException

Retrieves the designated parameter's database-specific type name.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:String

type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned.

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getPrecision	back to summary
public int getPrecision(int param) throws SQLException Retrieves the designated parameter's specified column size. The returned value represents the maximum column size for the given parameter. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int precision Exceptions SQLException: if a database access error occurs Since 1.4

getPrecision

back to summary

public int getPrecision(int param) throws SQLException

Retrieves the designated parameter's specified column size.

The returned value represents the maximum column size for the given parameter. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

precision

Exceptions

SQLException:: if a database access error occurs

Since

1.4

getScale	back to summary
public int getScale(int param) throws SQLException Retrieves the designated parameter's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int scale Exceptions SQLException: if a database access error occurs Since 1.4

getScale

back to summary

public int getScale(int param) throws SQLException

Retrieves the designated parameter's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

scale

Exceptions

SQLException:: if a database access error occurs

Since

1.4

isNullable back to summary

isNullable	back to summary
public int isNullable(int param) throws SQLException Retrieves whether null values are allowed in the designated parameter. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int the nullability status of the given parameter; one of `ParameterMetaData.parameterNoNulls`, `ParameterMetaData.parameterNullable`, or `ParameterMetaData.parameterNullableUnknown` Exceptions SQLException: if a database access error occurs Since 1.4

public int isNullable(int param) throws SQLException

Retrieves whether null values are allowed in the designated parameter.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown

Exceptions

SQLException:: if a database access error occurs

Since

1.4

isSigned back to summary

isSigned	back to summary
public boolean isSigned(int param) throws SQLException Retrieves whether values for the designated parameter can be signed numbers. Parameters param:int the first parameter is 1, the second is 2, ... Returns:boolean `true` if so; `false` otherwise Exceptions SQLException: if a database access error occurs Since 1.4

public boolean isSigned(int param) throws SQLException

Retrieves whether values for the designated parameter can be signed numbers.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions

SQLException:: if a database access error occurs

Since

1.4

public Interface ParameterMetaData

Field Summary

Method Summary

Field Detail

Method Detail