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.
Type parameters
- F
-
The effect type
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- 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.
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
Attributes
- Returns
-
the number of parameters
Retrieves the designated parameter's mode.
Retrieves the designated parameter's mode.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
Retrieves the designated parameter's SQL type.
Retrieves the designated parameter's SQL type.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
SQL type from ldbc.core.JdbcType
Retrieves the designated parameter's database-specific type name.
Retrieves the designated parameter's database-specific type name.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- 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.
Retrieves the designated parameter's specified column size.
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.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
precision
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.
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.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
scale
Retrieves whether null values are allowed in the designated parameter.
Retrieves whether null values are allowed in the designated parameter.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown
Retrieves whether values for the designated parameter can be signed numbers.
Retrieves whether values for the designated parameter can be signed numbers.
Value parameters
- param
-
the first parameter is 1, the second is 2, ...
Attributes
- Returns
-
true if so; false otherwise