Package org.mariadb.jdbc

Class CallableParameterMetaData

java.lang.Object
org.mariadb.jdbc.CallableParameterMetaData
All Implemented Interfaces:
ParameterMetaData, Wrapper
public class CallableParameterMetaData extends Object implements ParameterMetaData
Callable parameter metadata. Server doesn't give detailled information about parameter, so even if driver return those information, they are not completely accurate.

  • Constructor Details

    • CallableParameterMetaData

      public CallableParameterMetaData(ResultSet rs, boolean isFunction) throws SQLException
      Constructor
      Parameters:
      rs - parameter result-set
      isFunction - is command a function or a stored procedure
      Throws:
      SQLException - if any error occurs

  • Method Details

    • getParameterCount

      public int getParameterCount()
      Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
      Specified by:
      getParameterCount in interface ParameterMetaData
      Returns:
      the number of parameters
      Since:
      1.4

    • isNullable

      public int isNullable(int index) throws SQLException
      Retrieves whether null values are allowed in the designated parameter.
      Specified by:
      isNullable in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable , or ParameterMetaData.parameterNullableUnknown
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • isSigned

      public boolean isSigned(int index) throws SQLException
      Retrieves whether values for the designated parameter can be signed numbers.
      Specified by:
      isSigned in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      true if so; false otherwise
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • getPrecision

      public int getPrecision(int index) throws SQLException
      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.

      Specified by:
      getPrecision in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      precision
      Throws:
      SQLException - if a database access error occurs

    • getScale

      public int getScale(int index) throws SQLException
      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.
      Specified by:
      getScale in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      scale
      Throws:
      SQLException - if a database access error occurs

    • getParameterName

      public String getParameterName(int index) throws SQLException
      Return the parameter name corresponding to index.
      Parameters:
      index - index
      Returns:
      parameter name
      Throws:
      SQLException - if wrong index

    • getParameterType

      public int getParameterType(int index) throws SQLException
      Retrieves the designated parameter's SQL type.
      Specified by:
      getParameterType in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      SQL types from java.sql.Types
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4
      See Also:

    • getParameterTypeName

      public String getParameterTypeName(int index) throws SQLException
      Retrieves the designated parameter's database-specific type name.
      Specified by:
      getParameterTypeName in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      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.
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • getParameterClassName

      public String getParameterClassName(int index) throws SQLException
      Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
      Specified by:
      getParameterClassName in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      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.
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • getParameterMode

      public int getParameterMode(int index) throws SQLException
      Retrieves the designated parameter's mode.
      Specified by:
      getParameterMode in interface ParameterMetaData
      Parameters:
      index - the first parameter is 1, the second is 2, ...
      Returns:
      mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
      Throws:
      SQLException - if a database access error occurs
      Since:
      1.4

    • unwrap

      public <T> T unwrap(Class<T> iface) throws SQLException
      Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

      If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise, return the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

      Specified by:
      unwrap in interface Wrapper
      Parameters:
      iface - A Class defining an interface that the result must implement.
      Returns:
      an object that implements the interface. Maybe a proxy for the actual implementing object.
      Throws:
      SQLException - If no object found that implements the interface
      Since:
      1.6

    • isWrapperFor

      public boolean isWrapperFor(Class<?> iface)
      Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.
      Specified by:
      isWrapperFor in interface Wrapper
      Parameters:
      iface - a Class defining an interface.
      Returns:
      true if this implements the interface or directly or indirectly wraps an object that does.
      Since:
      1.6