Compartilhar via

Método getProcedureColumns (SQLServerDatabaseMetaData)

  • Artigo

Baixar o JDBC Driver

Recupera uma descrição dos parâmetros de procedimento armazenado e das colunas de resultado.

Sintaxe

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

Parâmetros

sCatalog

Uma String que contém o nome do catálogo. Fornecer um nulo a esse parâmetro indica que o nome do catálogo não precisa ser usado.

sSchema

Uma String que contém o padrão de nome do esquema. Fornecer um nulo a esse parâmetro indica que o nome de esquema não precisa ser usado.

proc

Uma String que contém o padrão de nome do procedimento.

col

Uma String que contém o nome da coluna. Fornecer um nulo a este parâmetro retorna uma linha para cada coluna.

Valor retornado

Um objeto SQLServerResultSet.

Exceções

SQLServerException

Comentários

Esse método getProcedureColumns é especificado pelo método getProcedureColumns na interface java.sql.DatabaseMetaData.

O conjunto de resultados retornado pelo método getProcedureColumns conterá as seguintes informações:

Nome Tipo Descrição
PROCEDURE_CAT Cadeia de caracteres O nome do banco de dados no qual o procedimento armazenado especificado reside.
PROCEDURE_SCHEM Cadeia de caracteres O esquema para o procedimento armazenado.
PROCEDURE_NAME Cadeia de caracteres O nome do procedimento armazenado.
COLUMN_NAME Cadeia de caracteres O nome da coluna.
COLUMN_TYPE short O tipo da coluna. Pode ser um dos seguintes valores:

procedureColumnUnknown (0)

procedureColumnIn (1)

procedureColumnInOut (2)

procedureColumnOut (4)

procedureColumnReturn (5)

procedureColumnResult (3)
DATA_TYPE smallint O tipo de dados SQL de java.sql.Types.
TYPE_NAME Cadeia de caracteres O nome do tipo de dados.
PRECISION int O número total de dígitos significativos.
LENGTH int O comprimento dos dados em bytes.
SCALE short O número de dígitos à direita da vírgula decimal.
RADIX short A base para tipos numéricos.
NULLABLE short Indica se a coluna pode conter um valor nulo. Pode ser um dos seguintes valores:

procedureNoNulls (0)

procedureNullable (1)

procedureNullableUnknown (2)
COMENTÁRIOS Cadeia de caracteres A descrição da coluna de procedimento.



Observação: o SQL Server não retorna um valor para essa coluna.
COLUMN_DEF Cadeia de caracteres O valor padrão da coluna.
SQL_DATA_TYPE smallint Esta coluna é igual à coluna DATA_TYPE, com exceção dos tipos de dados datetime e interval ISO.
SQL_DATETIME_SUB smallint O subcódigo de interval ISO de datetime, se o valor de SQL_DATA_TYPE for SQL_DATETIME ou SQL_INTERVAL. Para tipos de dados diferentes de datetime e intervalo ISO, essa coluna é NULL.
CHAR_OCTET_LENGTH int O número máximo de bytes na coluna.
ORDINAL_POSITION int O índice da coluna na tabela.
IS_NULLABLE Cadeia de caracteres Indica se a coluna permite valores nulos.
SS_TYPE_CATALOG_NAME Cadeia de caracteres O nome do catálogo que contém o UDT (tipo definido pelo usuário).
SS_TYPE_SCHEMA_NAME Cadeia de caracteres O nome do esquema que contém o UDT (tipo definido pelo usuário).
SS_UDT_CATALOG_NAME Cadeia de caracteres O UDT (tipo definido pelo usuário) do nome totalmente qualificado.
SS_UDT_SCHEMA_NAME Cadeia de caracteres O nome do catálogo em que é definido um nome da coleção de esquemas XML. Se não for possível localizar o nome do catálogo, essa variável conterá uma cadeia de caracteres vazia.
SS_UDT_ASSEMBLY_TYPE_NAME Cadeia de caracteres O nome do esquema no qual é definido um nome da coleção de esquemas XML. Se não for possível localizar o nome do esquema, essa cadeia de caracteres estará vazia.
SS_XML_SCHEMACOLLECTION_CATALOG_NAME Cadeia de caracteres O nome de uma coleção de esquemas XML. Se não for possível localizar o nome, essa cadeia de caracteres estará vazia.
SS_XML_SCHEMACOLLECTION_SCHEMA_NAME Cadeia de caracteres O nome do catálogo que contém o UDT (tipo definido pelo usuário).
SS_XML_SCHEMACOLLECTION_NAME Cadeia de caracteres O nome do esquema que contém o UDT (tipo definido pelo usuário).
SS_DATA_TYPE tinyint O tipo de dados do SQL Server usado por procedimentos armazenados estendidos.



Observação: para obter mais informações sobre os tipos de dados retornados pelo SQL Server, confira "Tipos de dados (Transact-SQL)" nos Manuais Online do SQL Server.

Observação

Para obter mais informações sobre os dados retornados pelo método getProcedureColumns, confira "sp_sproc_columns (Transact-SQL)" nos Manuais Online do SQL Server.

Exemplo

O exemplo a seguir demonstra como usar o método getProceduresColumns para retornar informações sobre o procedimento armazenado uspGetBillOfMaterials no banco de dados de exemplo AdventureWorks2022.

public static void executeGetProcedureColumns(Connection con) {  
   try {  
      DatabaseMetaData dbmd = con.getMetaData();  
      ResultSet rs = dbmd.getProcedureColumns(null, null, "uspGetBillOfMaterials", null);  
      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();  
   }  
}

Consulte Também

Membros SQLServerDatabaseMetaData
Classe SQLServerDatabaseMetaData