Skip to content

getprocedures-method-sqlserverdatabasemetadata.md

Latest commit

 

History

History
97 lines (74 loc) · 4 KB

getprocedures-method-sqlserverdatabasemetadata.md

File metadata and controls

97 lines (74 loc) · 4 KB
title getProcedures Method (SQLServerDatabaseMetaData)
description getProcedures Method (SQLServerDatabaseMetaData)
author David-Engel
ms.author davidengel
ms.date 01/19/2017
ms.service sql
ms.subservice connectivity
ms.topic reference
apilocation sqljdbc.jar
apiname SQLServerDatabaseMetaData.getProcedures
apitype Assembly

getProcedures Method (SQLServerDatabaseMetaData)

[!INCLUDEDriver_JDBC_Download]

Retrieves a description of the stored procedures that are available in the given catalog, schema, or stored procedure name pattern.

Syntax

  
public java.sql.ResultSet getProcedures(java.lang.String sCatalog,  
                                        java.lang.String sSchema,  
                                        java.lang.String proc)

Parameters

sCatalog

A String that contains the catalog name. Providing a null to this parameter indicates that the catalog name does not need to be used.

sSchema

A String that contains the schema name pattern. Providing a null to this parameter indicates that the schema name does not need to be used.

proc

A String that contains the procedure name pattern.

Return Value

A SQLServerResultSet object.

Exceptions

SQLServerException

Remarks

This getProcedures method is specified by the getProcedures method in the java.sql.DatabaseMetaData interface.

The result set returned by the getProcedures method will contain the following information:

Name Type Description
PROCEDURE_CAT String The name of the database in which the specified stored procedure resides.
PROCEDURE_SCHEM String The schema for the stored procedure.
PROCEDURE_NAME String The name of the stored procedure.
NUM_INPUT_PARAMS int Reserved for future use, currently returns a -1 value.
NUM_OUTPUT_PARAMS int Reserved for future use, currently returns a -1 value.
NUM_RESULT_SETS int Reserved for future use, currently returns a -1 value.
REMARKS String The description of the procedure column.



Note: [!INCLUDEssNoVersion] does not return a value for this column.
PROCEDURE_TYPE smallint The type of stored procedure. It can be one of the following values:

SQL_PT_UNKNOWN (0)

SQL_PT_PROCEDURE (1)

SQL_PT_FUNCTION (2)

Note

For more information about the data returned by the getProcedures method, see "sp_stored_procedures (Transact-SQL)" in [!INCLUDEssNoVersion] Books Online.

Example

The following example demonstrates how to use the getProcedures method to return information about the uspGetBillOfMaterials stored procedure in the [!INCLUDEssSampleDBnormal] sample database.

public static void executeGetProcedures(Connection con) {  
   try {  
      DatabaseMetaData dbmd = con.getMetaData();  
      ResultSet rs = dbmd.getProcedures(null, null, "uspGetBillOfMaterials");  
      ResultSetMetaData rsmd = rs.getMetaData();  
  
      // Display the result set data.  
      int cols = rsmd.getColumnCount();  
      while(rs.next()) {  
         for (int i = 1; i <= cols; i++) {  
            System.out.println(rs.getString(i));  
         }  
      }  
      rs.close();  
   }   
  
   catch (Exception e) {  
      e.printStackTrace();  
   }  
}

See Also

SQLServerDatabaseMetaData Methods
SQLServerDatabaseMetaData Members
SQLServerDatabaseMetaData Class