java.sql.ParameterMetaData

public interface java.sql

ParameterMetaData

Java SE 6

Implements: Wrapper

An object that can be used to get information about the types and properties for each parameter marker in a PreparedStatement object. For some queries and driver implementations, the data that would be returned by a ParameterMetaData object may not be available until the PreparedStatement has been executed.

Some driver implementations may not be able to provide information about the types and properties for each parameter marker in a CallableStatement object.

since 1.4

Fields

final public static int

parameterNoNulls
The constant indicating that a parameter will not allow NULL values.

final public static int

parameterNullable
The constant indicating that a parameter will allow NULL values.

final public static int

parameterNullableUnknown
The constant indicating that the nullability of a parameter is unknown.

final public static int

parameterModeUnknown
The constant indicating that the mode of the parameter is unknown.

final public static int

parameterModeIn
The constant indicating that the parameter's mode is IN.

final public static int

parameterModeInOut
The constant indicating that the parameter's mode is INOUT.

final public static int

parameterModeOut
The constant indicating that the parameter's mode is OUT.

Properties

public int

isNullable(int param) throws SQLException Details

Retrieves whether null values are allowed in the designated parameter.

param	the first parameter is 1, the second is 2, ...
return	the nullability status of the given parameter; one of `ParameterMetaData.parameterNoNulls`, `ParameterMetaData.parameterNullable`, or `ParameterMetaData.parameterNullableUnknown`
Throws	SQLException: if a database access error occurs
since	1.4

public String

getParameterClassName(int param) throws SQLException Details

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

param	the first parameter is 1, the second is 2, ...
return	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.
Throws	SQLException: if a database access error occurs
since	1.4

public int

getParameterCount() throws SQLException Details

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

return	the number of parameters
Throws	SQLException: if a database access error occurs
since	1.4

public int

getParameterMode(int param) throws SQLException Details

Retrieves the designated parameter's mode.

param	the first parameter is 1, the second is 2, ...
return	mode of the parameter; one of `ParameterMetaData.parameterModeIn`, `ParameterMetaData.parameterModeOut`, or `ParameterMetaData.parameterModeInOut` `ParameterMetaData.parameterModeUnknown`.
Throws	SQLException: if a database access error occurs
since	1.4

public int

getParameterType(int param) throws SQLException Details

Retrieves the designated parameter's SQL type.

param	the first parameter is 1, the second is 2, ...
return	SQL type from `java.sql.Types`
Throws	SQLException: if a database access error occurs
since	1.4
See also	java.sql.Types

public String

getParameterTypeName(int param) throws SQLException Details

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

param	the first parameter is 1, the second is 2, ...
return	type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned.
Throws	SQLException: if a database access error occurs
since	1.4

public int

getPrecision(int param) throws SQLException Details

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.

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

return precision

Throws SQLException: if a database access error occurs

since 1.4

public int

getScale(int param) throws SQLException Details

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.

param	the first parameter is 1, the second is 2, ...
return	scale
Throws	SQLException: if a database access error occurs
since	1.4

public boolean

isSigned(int param) throws SQLException Details

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

param	the first parameter is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs
since	1.4

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6