SQLServerParameterMetaData Class

Package:

com.microsoft.sqlserver.jdbc

Maven Artifact:

com.microsoft.sqlserver:mssql-jdbc:8.2.0.jre11

• java.lang.Object
• • com.microsoft.sqlserver.jdbc.SQLServerParameterMetaData

Implements

java.sql.ParameterMetaData

public final class SQLServerParameterMetaData
implements java.sql.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. 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.

Field Summary

Modifier and Type	Field and Description
protected boolean	procedureIsFound

Method Summary

Modifier and Type	Method and Description
T	unwrap(Class<T> iface)
java.lang.String	getParameterClassName(int param)
int	getParameterCount()
int	getParameterMode(int param)
int	getParameterType(int param)
java.lang.String	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 java.lang.String	toString() Provides a helper function to provide an ID string suitable for tracing.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Field Details

procedureIsFound

protected boolean procedureIsFound

Method Details

unwrap

public T unwrap(Class iface)

Parameters:

iface

Throws:

java.sql.SQLException

getParameterClassName

public String getParameterClassName(int param)

Parameters:

param

Throws:

SQLServerException

getParameterCount

public int getParameterCount()

Throws:

SQLServerException

getParameterMode

public int getParameterMode(int param)

Parameters:

param

Throws:

SQLServerException

getParameterType

public int getParameterType(int param)

Parameters:

param

Throws:

SQLServerException

getParameterTypeName

public String getParameterTypeName(int param)

Parameters:

param

Throws:

SQLServerException

getPrecision

public int getPrecision(int param)

Parameters:

param

Throws:

SQLServerException

getScale

public int getScale(int param)

Parameters:

param

Throws:

SQLServerException

isNullable

public int isNullable(int param)

Parameters:

param

Throws:

SQLServerException

isSigned

public boolean isSigned(int param)

Returns if a supplied parameter index is valid.

Parameters:

param - the @param index

Returns:

boolean

Throws:

SQLServerException - when an error occurs

isWrapperFor

public boolean isWrapperFor(Class iface)

Parameters:

iface

Throws:

java.sql.SQLException

toString

public final String toString()

Provides a helper function to provide an ID string suitable for tracing.

Overrides:

SQLServerParameterMetaData.toString()

Returns:

traceID string