JDBC Tutorials - Herong's Tutorial Notes
Dr. Herong Yang, Version 2.11

Listing All Stored Procedures - getProcedures()

This section describes how to get a list of all stored procedures in the current database on the SQL Server through the DatabaseMetaData object.

If you want to list all stored procedures in the current database, you can use the DatabaseMetaData method: getProcedures(). Input parameters are:

  • catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
  • schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
  • procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database

The output is captured in a ResultSet object with the following fields:

  • PROCEDURE_CAT String => table catalog (may be null)
  • PROCEDURE_SCHEM String => table schema (may be null)
  • PROCEDURE_NAME String => procedure name

The following sample program displays all columns in the fyi_links table:

/**
 * ListProcedures.java
 * Copyright (c) 2007 by Dr. Herong Yang. All rights reserved.
 */
import java.sql.*;
public class ListProcedures {
  public static void main(String [] args) {
    Connection con = null;
    try {

      Class.forName(
        "com.microsoft.sqlserver.jdbc.SQLServerDriver");
      con = DriverManager.getConnection(
          "jdbc:sqlserver://localhost:1269;"
        + "user=sa;password=HerongYang;"
        + "database=AdventureWorksLT");

      DatabaseMetaData meta = con.getMetaData();
      ResultSet res = meta.getProcedures(null, null, null); 
      System.out.println("List of procedures: "); 
      while (res.next()) {
         System.out.println(
            "   "+res.getString("PROCEDURE_CAT") 
           + ", "+res.getString("PROCEDURE_SCHEM")
           + ", "+res.getString("PROCEDURE_NAME"));
      }
      res.close();

      con.close();
    } catch (java.lang.ClassNotFoundException e) {
      System.err.println("ClassNotFoundException: "
        +e.getMessage());
    } catch (SQLException e) {
      System.err.println("SQLException: "
        +e.getMessage());
    }
  }
}

If you run this program, you will get:

List of procedures: 
   AdventureWorksLT, dbo, ufnGetAllCategories;0
   AdventureWorksLT, dbo, ufnGetCustomerInformation;0
   AdventureWorksLT, dbo, ufnGetSalesOrderStatusText;0
   AdventureWorksLT, dbo, uspLogError;1
   AdventureWorksLT, dbo, uspPrintError;1
   AdventureWorksLT, sys, dm_db_index_operational_stats;0
   AdventureWorksLT, sys, dm_db_index_physical_stats;0
   AdventureWorksLT, sys, dm_db_missing_index_columns;0
   AdventureWorksLT, sys, dm_exec_cached_plan_dependent_objects;0
   ...

Table of Contents

 About This Book

 JDBC (Java Database Connectivity) Introduction

 Downloading and Installing JDK - Java SE

 Installing and Running Java DB - Derby

 Derby (Java DB) JDBC Driver

 Derby (Java DB) JDBC DataSource Objects

 Java DB (Derby) - DML Statements

 Java DB (Derby) - ResultSet Objects of Queries

 Java DB (Derby) - PreparedStatement

 MySQL Installation on Windows

 MySQL JDBC Driver (MySQL Connector/J)

 MySQL - PreparedStatement

 MySQL - Reference Implementation of JdbcRowSet

 MySQL - JBDC CallableStatement

 MySQL CLOB (Character Large Object) - TEXT

 MySQL BLOB (Binary Large Object) - BLOB

 Oracle Express Edition Installation on Windows

 Oracle JDBC Drivers

 Oracle - Reference Implementation of JdbcRowSet

 Oracle - PreparedStatement

 Oracle - JBDC CallableStatement

 Oracle CLOB (Character Large Object) - TEXT

 Oracle BLOB (Binary Large Object) - BLOB

 Microsoft SQL Server 2005 Express Edition

 Microsoft JDBC Driver for SQL Server - sqljdbc.jar

 Microsoft JDBC Driver - Query Statements and Result Sets

Microsoft JDBC Driver - DatabaseMetaData Object

 Commonly Used DatabaseMetaData Methods

 Getting Database Server and Driver Info

 Listing All Databases - getCatalogs()

 Listing All Schemas - getSchemas()

 Listing All Tables - getTables()

 Listing All Culumns - getColumns()

Listing All Stored Procedures - getProcedures()

 Microsoft JDBC Driver - DDL Statements

 Microsoft JDBC Driver - DML Statements

 SQL Server - PreparedStatement

 SQL Server CLOB (Character Large Object) - TEXT

 SQL Server BLOB (Binary Large Object) - BLOB

 JDBC-ODBC Bridge Driver - sun.jdbc.odbc.JdbcOdbcDriver

 JDBC-ODBC Bridge Driver - Flat Text Files

 JDBC-ODBC Bridge Driver - MS Access

 JDBC-ODBC Bridge Driver - MS SQL Server

 Summary of JDBC Drivers and Database Servers

 Additional Tutorial Notes to Be Added

 References

 PDF Printing Version

Dr. Herong Yang, updated in 2007
Listing All Stored Procedures - getProcedures()