public interface ParameterMetaData extends Wrapper
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.
Modifier and Type | Field and Description |
---|---|
static int |
parameterModeIn
The constant indicating that the parameter's mode is IN.
|
static int |
parameterModeInOut
The constant indicating that the parameter's mode is INOUT.
|
static int |
parameterModeOut
The constant indicating that the parameter's mode is OUT.
|
static int |
parameterModeUnknown
The constant indicating that the mode of the parameter is unknown.
|
static int |
parameterNoNulls
The constant indicating that a
parameter will not allow
NULL values. |
static int |
parameterNullable
The constant indicating that a
parameter will allow
NULL values. |
static int |
parameterNullableUnknown
The constant indicating that the
nullability of a parameter is unknown.
|
Modifier and Type | Method and Description |
---|---|
String |
getParameterClassName(int param)
Retrieves the fully-qualified name of the Java class whose instances
should be passed to the method
PreparedStatement.setObject . |
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.
|
int |
getParameterType(int param)
Retrieves the designated parameter's SQL type.
|
String |
getParameterTypeName(int param)
Retrieves the designated parameter's database-specific type name.
|
int |
getPrecision(int param)
Retrieves the designated parameter's specified column size.
|
int |
getScale(int param)
Retrieves the designated parameter's number of digits to right of the decimal point.
|
int |
isNullable(int param)
Retrieves whether null values are allowed in the designated parameter.
|
boolean |
isSigned(int param)
Retrieves whether values for the designated parameter can be signed numbers.
|
isWrapperFor, unwrap
static final int parameterNoNulls
NULL
values.static final int parameterNullable
NULL
values.static final int parameterNullableUnknown
static final int parameterModeUnknown
static final int parameterModeIn
static final int parameterModeInOut
static final int parameterModeOut
int getParameterCount() throws SQLException
PreparedStatement
object for which this ParameterMetaData
object contains
information.SQLException
- if a database access error occursint isNullable(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...ParameterMetaData.parameterNoNulls
,
ParameterMetaData.parameterNullable
, or
ParameterMetaData.parameterNullableUnknown
SQLException
- if a database access error occursboolean isSigned(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...true
if so; false
otherwiseSQLException
- if a database access error occursint getPrecision(int param) throws SQLException
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, ...SQLException
- if a database access error occursint getScale(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...SQLException
- if a database access error occursint getParameterType(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...java.sql.Types
SQLException
- if a database access error occursTypes
String getParameterTypeName(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...SQLException
- if a database access error occursString getParameterClassName(int param) throws SQLException
PreparedStatement.setObject
.param
- the first parameter is 1, the second is 2, ...PreparedStatement.setObject
to set the value
in the specified parameter. This is the class name used
for custom mapping.SQLException
- if a database access error occursint getParameterMode(int param) throws SQLException
param
- the first parameter is 1, the second is 2, ...ParameterMetaData.parameterModeIn
,
ParameterMetaData.parameterModeOut
, or
ParameterMetaData.parameterModeInOut
ParameterMetaData.parameterModeUnknown
.SQLException
- if a database access error occurs Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138