Package com.microsoft.sqlserver.jdbc
Class SQLServerParameterMetaData
- java.lang.Object
-
- com.microsoft.sqlserver.jdbc.SQLServerParameterMetaData
-
- All Implemented Interfaces:
ParameterMetaData,Wrapper
public final class SQLServerParameterMetaData extends Object implements ParameterMetaData
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetParameterClassName(int param)intgetParameterCount()intgetParameterMode(int param)intgetParameterType(int param)StringgetParameterTypeName(int param)intgetPrecision(int param)intgetScale(int param)intisNullable(int param)booleanisSigned(int param)Returns if a supplied parameter index is valid.booleanisWrapperFor(Class<?> iface)StringtoString()Provides a helper function to provide an ID string suitable for tracing.<T> Tunwrap(Class<T> iface)
-
-
-
Method Detail
-
toString
public final String toString()
Provides a helper function to provide an ID string suitable for tracing.
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
- Specified by:
isWrapperForin interfaceWrapper- Throws:
SQLException
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
- Specified by:
unwrapin interfaceWrapper- Throws:
SQLException
-
getParameterClassName
public String getParameterClassName(int param) throws SQLServerException
- Specified by:
getParameterClassNamein interfaceParameterMetaData- Throws:
SQLServerException
-
getParameterCount
public int getParameterCount() throws SQLServerException- Specified by:
getParameterCountin interfaceParameterMetaData- Throws:
SQLServerException
-
getParameterMode
public int getParameterMode(int param) throws SQLServerException- Specified by:
getParameterModein interfaceParameterMetaData- Throws:
SQLServerException
-
getParameterType
public int getParameterType(int param) throws SQLServerException- Specified by:
getParameterTypein interfaceParameterMetaData- Throws:
SQLServerException
-
getParameterTypeName
public String getParameterTypeName(int param) throws SQLServerException
- Specified by:
getParameterTypeNamein interfaceParameterMetaData- Throws:
SQLServerException
-
getPrecision
public int getPrecision(int param) throws SQLServerException- Specified by:
getPrecisionin interfaceParameterMetaData- Throws:
SQLServerException
-
getScale
public int getScale(int param) throws SQLServerException- Specified by:
getScalein interfaceParameterMetaData- Throws:
SQLServerException
-
isNullable
public int isNullable(int param) throws SQLServerException- Specified by:
isNullablein interfaceParameterMetaData- Throws:
SQLServerException
-
isSigned
public boolean isSigned(int param) throws SQLServerExceptionReturns if a supplied parameter index is valid.- Specified by:
isSignedin interfaceParameterMetaData- Parameters:
param- the @param index- Returns:
- boolean
- Throws:
SQLServerException- when an error occurs
-
-