OBJECTPROPERTYEX (Transact-SQL)

Область применения: SQL Server База данных SQL Azure Управляемый экземпляр SQL Azure конечной точке аналитики платформы Аналитики Azure Synapse Analytics (PDW) в Microsoft Fabric Хранилище в Microsoft Fabric

Возвращает данные об объектах области схемы в текущей базе данных. Список этих объектов см. в разделе sys.objects (Transact-SQL). Функция OBJECTPROPERTYEX не может применяться к объектам, недоступным в области, например: триггерам DDL и уведомлениям о событиях.

Соглашения о синтаксисе Transact-SQL

Синтаксис

OBJECTPROPERTYEX ( id , property )  

Аргументы

id
Выражение, которое представляет идентификатор объекта в текущей базе данных. Аргумент id имеет тип int. Предполагается, что он представляет объект области схемы в текущем контексте базы данных.

свойство
Выражение, содержащее сведения, возвращаемые для объекта, указанного идентификатором. Тип возвращаемого значения — sql_variant. В следующей таблице перечислены базовые типы данных для каждого из свойств.

Типы возвращаемых данных

sql_variant

Исключения

Возвращает значение NULL в случае ошибки или если участник не имеет разрешений для просмотра объекта.

Пользователь может просматривать только метаданные защищаемых объектов, которыми он владеет или на которые пользователю были предоставлены разрешения. Это значит, что встроенные функции, создающие метаданные (например, OBJECTPROPERTYEX), могут возвращать значение NULL, если у пользователя нет разрешения на доступ к объекту. Дополнительные сведения см. в разделе Metadata Visibility Configuration.

Замечания

В ядро СУБД предполагается, что object_id находится в текущем контексте базы данных. Запрос, который ссылается на object_id в другой базе данных, вернет значение NULL или неверный результат. Например, в приведенном ниже запросе контекст текущий базы данных — база данных master. Ядро СУБД попытается вернуть значение свойства заданного object_id в этой базе данных, а не в указанной в запросе базе данных. Запрос возвращает неверные результаты, потому что представление vEmployee не содержится в базе данных master.

USE master;  
GO  
SELECT OBJECTPROPERTYEX(OBJECT_ID(N'AdventureWorks2022.HumanResources.vEmployee'), 'IsView');  
GO  

OBJECTPROPERTYEX(view_id, 'IsIndexable') может потреблять значительное количество ресурсов компьютера, так как для оценки свойства IsIndexable необходимы синтаксический анализ определения представления, нормализация и частичная оптимизация. Даже если свойство IsIndexable определяет, что таблицы или представления могут быть проиндексированы, фактическое создание индекса может завершиться ошибкой, если не выполняются требования к ключу индекса. Дополнительные сведения см. в статье CREATE INDEX (Transact-SQL).

Вызов OBJECTPROPERTYEX (table_id, 'TableHasActiveFulltextIndex') вернет значение 1 (True), если хотя бы один из столбцов таблицы был добавлен для индексирования. Заполнение полнотекстового индекса становится активным, как только для индексирования добавлен хотя бы один столбец.

К результирующему набору применяются ограничения на видимость метаданных. Дополнительные сведения см. в разделе Metadata Visibility Configuration.

Примеры

А. Определение базового типа объекта

В следующем примере производится создание синонима MyEmployeeTable для таблицы Employee в базе данных AdventureWorks2022, а затем для него определяется базовый тип.

USE AdventureWorks2022;  
GO  
CREATE SYNONYM MyEmployeeTable FOR HumanResources.Employee;  
GO  
SELECT OBJECTPROPERTYEX ( object_id(N'MyEmployeeTable'), N'BaseType')AS [Base Type];  
GO  

Результирующий набор показывает, что базовым типом соответствующего объекта, таблицы Employee, является пользовательская таблица.

Base Type 
--------  
U

B. Получение значения свойства

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

USE AdventureWorks2022;  
GO  
SELECT OBJECTPROPERTYEX(OBJECT_ID(N'HumanResources.Employee'), N'TABLEUPDATETRIGGERCOUNT');  
GO  

C. Поиск таблиц с ограничением FOREIGN KEY

В следующих примерах для возврата всех таблиц с ограничением внешнего ключа используется свойство TableHasForeignKey.

USE AdventureWorks2022;  
GO  
SELECT name, object_id, schema_id, type_desc  
FROM sys.objects   
WHERE OBJECTPROPERTYEX(object_id, N'TableHasForeignKey') = 1  
ORDER BY name;  
GO  

Примеры: Azure Synapse Analytics и система платформы аналитики (PDW)

Г. Определение базового типа объекта

В представленном ниже примере возвращается базовый тип объекта dbo.DimReseller.

-- Uses AdventureWorks  
  
SELECT OBJECTPROPERTYEX ( object_id(N'dbo.DimReseller'), N'BaseType')AS BaseType;  

Результирующий набор показывает, что базовым типом соответствующего объекта, таблицы dbo.DimReseller, является пользовательская таблица.

BaseType   
--------   
U   

См. также

CREATE SYNONYM (Transact-SQL)
Функции метаданных (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL)
OBJECT_ID (Transact-SQL)
OBJECT_NAME (Transact-SQL)
sys.objects (Transact-SQL)
ALTER AUTHORIZATION (Transact-SQL)
TYPEPROPERTY (Transact-SQL)