Module com.microsoft.sqlserver.jdbc
Package com.microsoft.sqlserver.jdbc
Class SQLServerParameterMetaData
java.lang.Object
com.microsoft.sqlserver.jdbc.SQLServerParameterMetaData
- All Implemented Interfaces:
ParameterMetaData
,Wrapper
Provides meta data for prepared statement parameters.
The API javadoc for JDBC API methods that this class implements are not repeated here. Please see Sun's JDBC API
interfaces javadoc for those details.
For SQL Servers versioned below SQL Server 2012, prepared statements are executed with SET FMT ONLY to retrieve
column meta data Callable statements : sp_sp_sproc_columns is called to retrieve names and meta data for the
procedures params.
For SQL Server 2012 and above, sp_describe_undeclared_parameter is used to retrieve parameter metadata.
-
Field Summary
Fields inherited from interface java.sql.ParameterMetaData
parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown
-
Method Summary
Modifier and TypeMethodDescriptiongetParameterClassName
(int param) int
int
getParameterMode
(int param) int
getParameterType
(int param) getParameterTypeName
(int param) int
getPrecision
(int param) int
getScale
(int param) int
isNullable
(int param) boolean
isSigned
(int param) Returns if a supplied parameter index is valid.boolean
isWrapperFor
(Class<?> iface) final String
toString()
Provides a helper function to provide an ID string suitable for tracing.<T> T
-
Method Details
-
toString
Provides a helper function to provide an ID string suitable for tracing. -
isWrapperFor
- Specified by:
isWrapperFor
in interfaceWrapper
- Throws:
SQLException
-
unwrap
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-
getParameterClassName
- Specified by:
getParameterClassName
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getParameterCount
- Specified by:
getParameterCount
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getParameterMode
- Specified by:
getParameterMode
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getParameterType
- Specified by:
getParameterType
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getParameterTypeName
- Specified by:
getParameterTypeName
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getPrecision
- Specified by:
getPrecision
in interfaceParameterMetaData
- Throws:
SQLServerException
-
getScale
- Specified by:
getScale
in interfaceParameterMetaData
- Throws:
SQLServerException
-
isNullable
- Specified by:
isNullable
in interfaceParameterMetaData
- Throws:
SQLServerException
-
isSigned
Returns if a supplied parameter index is valid.- Specified by:
isSigned
in interfaceParameterMetaData
- Parameters:
param
- the @param index- Returns:
- boolean
- Throws:
SQLServerException
- when an error occurs
-