| java.sql.ParameterMetaData
| ParameterMetaData | | public interface ParameterMetaData extends Wrapper(Code) | | 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 |
| Method Summary | |
| String | getParameterClassName(int param)
Retrieves the fully-qualified name of the Java class whose instances
should be passed to the method PreparedStatement.setObject.
Parameters:
param - the first parameter is 1, the second is 2, ... | | int | getParameterCount()
Retrieves the number of parameters in the PreparedStatement
object for which this ParameterMetaData object contains
information. | | int | getParameterMode(int param)
Retrieves the designated parameter's mode.
Parameters:
param - the first parameter is 1, the second is 2, ... | | int | getParameterType(int param)
Retrieves the designated parameter's SQL type.
Parameters:
param - the first parameter is 1, the second is 2, ... | | String | getParameterTypeName(int param)
Retrieves the designated parameter's database-specific type name.
Parameters:
param - the first parameter is 1, the second is 2, ... | | int | getPrecision(int param)
Retrieves the designated parameter's specified column size.
The returned value represents the maximum column size for the given parameter. | | int | getScale(int param)
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 - the first parameter is 1, the second is 2, ... | | int | isNullable(int param)
Retrieves whether null values are allowed in the designated parameter.
Parameters:
param - the first parameter is 1, the second is 2, ... | | boolean | isSigned(int param)
Retrieves whether values for the designated parameter can be signed numbers.
Parameters:
param - the first parameter is 1, the second is 2, ... |
| parameterModeIn | | int parameterModeIn(Code) | | The constant indicating that the parameter's mode is IN.
|
| parameterModeInOut | | int parameterModeInOut(Code) | | The constant indicating that the parameter's mode is INOUT.
|
| parameterModeOut | | int parameterModeOut(Code) | | The constant indicating that the parameter's mode is OUT.
|
| parameterModeUnknown | | int parameterModeUnknown(Code) | | The constant indicating that the mode of the parameter is unknown.
|
| parameterNoNulls | | int parameterNoNulls(Code) | | The constant indicating that a
parameter will not allow NULL values.
|
| parameterNullable | | int parameterNullable(Code) | | The constant indicating that a
parameter will allow NULL values.
|
| parameterNullableUnknown | | int parameterNullableUnknown(Code) | | The constant indicating that the
nullability of a parameter is unknown.
|
| getParameterClassName | | String getParameterClassName(int param) throws SQLException(Code) | | Retrieves the fully-qualified name of the Java class whose instances
should be passed to the method PreparedStatement.setObject.
Parameters:
param - the first parameter is 1, the second is 2, ... the fully-qualified name of the class in the Java programminglanguage 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.
exception:
SQLException - if a database access error occurs
since:
1.4 |
| getParameterCount | | int getParameterCount() throws SQLException(Code) | | Retrieves the number of parameters in the PreparedStatement
object for which this ParameterMetaData object contains
information.
the number of parameters
exception:
SQLException - if a database access error occurs
since:
1.4 |
| getParameterMode | | int getParameterMode(int param) throws SQLException(Code) | | Retrieves the designated parameter's mode.
Parameters:
param - the first parameter is 1, the second is 2, ... mode of the parameter; one of ParameterMetaData.parameterModeIn,ParameterMetaData.parameterModeOut, orParameterMetaData.parameterModeInOutParameterMetaData.parameterModeUnknown.
exception:
SQLException - if a database access error occurs
since:
1.4 |
| getParameterType | | int getParameterType(int param) throws SQLException(Code) | | Retrieves the designated parameter's SQL type.
Parameters:
param - the first parameter is 1, the second is 2, ... SQL type from java.sql.Types
exception:
SQLException - if a database access error occurs
since:
1.4
See Also: Types |
| getParameterTypeName | | String getParameterTypeName(int param) throws SQLException(Code) | | Retrieves the designated parameter's database-specific type name.
Parameters:
param - the first parameter is 1, the second is 2, ... type the name used by the database. If the parameter type isa user-defined type, then a fully-qualified type name is returned.
exception:
SQLException - if a database access error occurs
since:
1.4 |
| getPrecision | | int getPrecision(int param) throws SQLException(Code) | | 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 - the first parameter is 1, the second is 2, ... precision
exception:
SQLException - if a database access error occurs
since:
1.4 |
| getScale | | int getScale(int param) throws SQLException(Code) | | 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 - the first parameter is 1, the second is 2, ... scale
exception:
SQLException - if a database access error occurs
since:
1.4 |
| isNullable | | int isNullable(int param) throws SQLException(Code) | | Retrieves whether null values are allowed in the designated parameter.
Parameters:
param - the first parameter is 1, the second is 2, ... the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown
exception:
SQLException - if a database access error occurs
since:
1.4 |
| isSigned | | boolean isSigned(int param) throws SQLException(Code) | | Retrieves whether values for the designated parameter can be signed numbers.
Parameters:
param - the first parameter is 1, the second is 2, ... true if so; false otherwise
exception:
SQLException - if a database access error occurs
since:
1.4 |
|
|