Método getFunctionColumns (SQLServerDatabaseMetaData)

Artigo
06/02/2023

Recupera uma descrição do sistema do catálogo especificado - ou parâmetros de função do usuário e tipo de retorno.

Sintaxe

  
public ResultSet getFunctionColumns(java.lang.String catalog,  
                       java.lang.String schemaPattern,  
                       java.lang.String functionNamePattern  
                       java.lang.String columnNamePattern)

parâmetros

catalog

Uma String que contém o nome do catálogo. Se for uma cadeia de caracteres vazia "", o resultado incluirá as funções sem um catálogo. Se for null, o nome do catálogo não será usado para pesquisa.

schemaPattern

Uma String que contém o padrão de nome do esquema. Se for uma cadeia de caracteres vazia "", o resultado incluirá as funções sem um esquema. Se for null, o nome do esquema não será usado para pesquisa.

functionNamePattern

Uma String que contém o nome de uma função.

columnNamePattern

Uma String que contém o nome de um parâmetro.

Valor retornado

Um objeto SQLServerResultSet.

Exceções

SQLServerException

Comentários

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

Esse método retorna apenas as funções e os parâmetros correspondentes ao nome do esquema e da função especificados, além do nome do parâmetro dentro do catálogo especificado.

Todas as linhas do conjunto de resultados incluem as seguintes colunas para uma descrição de parâmetro, uma descrição de coluna ou um tipo de retorno:

Nome	Type	Descrição
FUNCTION_CAT	Cadeia de caracteres	O nome do banco de dados no qual a função reside.
FUNCTION_SCHEM	Cadeia de caracteres	O esquema da função.
FUNCTION_NAME	Cadeia de caracteres	O nome da função.
COLUMN_NAME	Cadeia de caracteres	O nome de um parâmetro ou coluna.
COLUMN_TYPE	short	O tipo da coluna. Pode ser um dos seguintes valores: functionColumnUnknown (0): Tipo desconhecido. functionColumnIn (1): parâmetro de entrada. functionColumnInOut (2): parâmetro de entrada/saída. functionColumnOut (3): parâmetro de saída. functionReturn (4): valor retornado da função. functionColumnResult (5): um parâmetro ou uma coluna é uma coluna no conjunto de resultados.
DATA_TYPE	smallint	O valor de 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 o parâmetro ou o valor retornado pode conter um valor null. Pode ser um dos seguintes valores: functionNoNulls (0): o valor NULL não é permitido. functionNullable (1): o valor NULL é permitido. functionNullableUnknown (2): Desconhecida.
COMENTÁRIOS	Cadeia de caracteres	Os comentários sobre uma coluna ou um parâmetro.
COLUMN_DEF	Cadeia de caracteres	O valor padrão da coluna. Observação: essas informações estão disponíveis com o SQL Server, sendo específicas do driver JDBC.
SQL_DATA_TYPE	smallint	Esta coluna é igual à coluna DATA_TYPE, com exceção dos tipos de dados datetime e interval ISO. Observação: essas informações estão disponíveis com o SQL Server, sendo específicas do driver JDBC.
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. Observação: essas informações estão disponíveis com o SQL Server, sendo específicas do driver JDBC.
CHAR_OCTET_LENGTH	int	O tamanho máximo dos parâmetros ou colunas binários ou baseados em caractere. Para outros tipos de dados, ele é NULL.
ORDINAL_POSITION	int	Para parâmetros de entrada e saída, ele representa a posição começando em 1. Para colunas do conjunto de resultados, é a posição da coluna no conjunto de resultados começando em 1. Para o valor de retorno, é 0.
IS_NULLABLE	Cadeia de caracteres	Determina a nulidade de um parâmetro ou de uma coluna. Pode ser um dos seguintes valores: YES: o parâmetro ou coluna pode incluir valores NULL. NO: o parâmetro ou coluna não pode incluir valores NULL. Cadeia de caracteres vazia (""): Desconhecida.
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 saber mais sobre os tipos de dados retornados pelo SQL Server, veja "Tipos de dados (Transact-SQL)" nos Manuais Online do SQL Server.

Consulte Também

Membros SQLServerDatabaseMetaData
Classe SQLServerDatabaseMetaData

Compartilhar via