Метод getFunctionColumns (SQLServerDatabaseMetaData)

Статья
10/16/2024

Возвращает описание параметров и возвращаемого типа системной или пользовательской функции указанного каталога.

Синтаксис

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

Параметры

catalog

Значение типа String, содержащее имя каталога. Если это пустая строка, то результат включает функции, доступные без каталога. Если это значение NULL, то имя каталога не используется для поиска.

schemaPattern

Значение типа String, содержащее шаблон имени схемы. Если это пустая строка, то результат включает функции, доступные без схемы. Если это значение NULL, то имя схемы не используется для поиска.

functionNamePattern

Значение типа String, содержащее имя функции.

columnNamePattern

Значение типа String, содержащее имя параметра.

Возвращаемое значение

Объект SQLServerResultSet.

Исключения

SQLServerException

Замечания

Этот метод getFunctionColumns определен с помощью метода getFunctionColumns в интерфейсе java.sql.DatabaseMetaData.

Этот метод возвращает только те функции и параметры, которые соответствуют указанному имени@@@ схемы, имени функции, имени параметра в указанном каталоге

Каждая строка в результирующем наборе содержит следующие столбцы для описания параметра, описания столбца или возвращаемого типа.

Имя.	Тип	Описание
FUNCTION_CAT	String	Имя базы данных, в которой находится указанная функция.
FUNCTION_SCHEM	String	Имя@@@ схемы для функции.
FUNCTION_NAME	String	Имя функции.
COLUMN_NAME	String	Имя параметра или столбца.
COLUMN_TYPE	short	Тип столбца. Может иметь одно из следующих значений. functionColumnUnknown (0): неизвестный тип. functionColumnIn (1): входной параметр. functionColumnInOut (2): входной/выходной параметр. functionColumnOut (3): выходной параметр. functionReturn (4): значение, возвращаемое функцией. functionColumnResult (5): параметр или столбец представляет собой столбец в результирующем наборе.
DATA_TYPE	smallint	Значение типа данных SQL из Java.sql.Types.
TYPE_NAME	String	Имя типа данных.
PRECISION	int	Общее количество значащих цифр.
LENGTH	int	Длина данных в байтах.
МАСШТАБ	short	Количество цифр справа от десятичной запятой.
RADIX	short	Основание системы счисления для числовых типов.
NULLABLE	short	Показывает, может ли возвращаемое значение или параметр содержать значение NULL. Может быть одним из указанных далее значений. functionNoNulls (0): значение NULL недопустимо. functionNullable (1): значение NULL допустимо. functionNullableUnknown (2): неизвестно.
ПРИМЕЧАНИЯ	String	Примечания по параметру или столбцу.
COLUMN_DEF	String	Значение по умолчанию для столбца. Примечание. Эти сведения доступны в SQL Server и относятся к драйверу JDBC.
SQL_DATA_TYPE	smallint	Этот столбец содержит то же значение, что и столбец DATA_TYPE, за исключением типов данных datetime и ISO interval. Примечание. Эти сведения доступны в SQL Server и относятся к драйверу JDBC.
SQL_DATETIME_SUB	smallint	Дополнительный код datetime ISO interval, если значение SQL_DATA_TYPE равно SQL_DATETIME или SQL_INTERVAL. Для типов данных, отличных от datetime и interval в стандарте ISO, это поле имеет значение NULL. Примечание. Эти сведения доступны в SQL Server и относятся к драйверу JDBC.
CHAR_OCTET_LENGTH	int	Максимальная длина значений символьных и двоичных параметров или столбцов. Для остальных типов данных имеет значение равное NULL.
ORDINAL_POSITION	int	Для входных или выходных параметров представляет позицию начинающуюся с 1 Для результирующего набора столбцов представляет позицию столбца в результирующем наборе начинающуюся с 1. Для возвращаемого значения имеет значение равное 0.
IS_NULLABLE	String	Определяет допустимость значений NULL для параметра или столбца. Может иметь одно из следующих значений. YES: параметр или столбец могут содержать значения NULL. NO: параметр или столбец не могут содержать значения NULL. Пустая строка (""): неизвестно.
SS_TYPE_CATALOG_NAME	String	Имя каталога, содержащего определяемый пользователем тип.
SS_TYPE_SCHEMA_NAME	String	Имя схемы, содержащей определяемый пользователем тип.
SS_UDT_CATALOG_NAME	String	Определяемый пользователем тип с полным именем.
SS_UDT_SCHEMA_NAME	String	Имя каталога, в котором определено имя коллекции схем XML. Если не удается найти имя каталога, то эта переменная содержит пустую строку.
SS_UDT_ASSEMBLY_TYPE_NAME	String	Имя схемы, в которой определено имя коллекции схем XML. Если не удается найти имя схемы, значением является пустая строка.
SS_XML_SCHEMACOLLECTION_CATALOG_NAME	String	Имя коллекции схем XML. Если не удается найти имя, значением является пустая строка.
SS_XML_SCHEMACOLLECTION_SCHEMA_NAME	String	Имя каталога, содержащего определяемый пользователем тип.
SS_XML_SCHEMACOLLECTION_NAME	String	Имя схемы, содержащей определяемый пользователем тип.
SS_DATA_TYPE	tinyint	Тип данных SQL Server, используемый расширенными хранимыми процедурами. Дополнительные сведения о типах данных, возвращаемых SQL Server, см. в статье "Типы данных (Transact-SQL)" в электронной документации по SQL Server.

См. также

Элементы SQLServerDatabaseMetaData
Класс SQLServerDatabaseMetaData

Поделиться через