OBJECTPROPERTY (Transact-SQL)

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse AnalyticsAnalytics Platform System (PDW)Ponto de extremidade de análise de SQL no Microsoft FabricDepósito no Microsoft FabricBanco de dados SQL no Microsoft Fabric

Retorna informações sobre objetos no escopo do esquema no banco de dados atual. Para obter uma lista de objetos no escopo do esquema, confira sys.objects (Transact-SQL). Essa função não pode ser usada por objetos que não sejam de escopo de esquema, como gatilhos DDL (linguagem de definição de dados) e notificações de eventos.

Convenções de sintaxe de Transact-SQL

Sintaxe

OBJECTPROPERTY ( ID , property )

Argumentos

ID

Expressão que representa a ID do objeto no banco de dados atual. A ID é int e supõe-se que seja um objeto com escopo de esquema no contexto atual do banco de dados.

property

Expressão que representa as informações a serem retornadas para o objeto especificado pela ID. a propriedade pode ser um dos seguintes valores.

Tipos de retorno

int

Exceções

Retorna NULL com erro ou se um chamador não tiver permissão para exibir o objeto.

Permissões

Um usuário só pode exibir metadados de protegíveis de sua propriedade ou para os quais recebeu permissão. Isso significa que as funções internas, emitindo metadados, como OBJECTPROPERTY retornar NULL se o usuário não tiver nenhuma permissão no objeto. Para obter mais informações, consulte a configuração de visibilidade de metadados.

Comentários

O Mecanismo de Banco de Dados supõe que object_id esteja no contexto do banco de dados atual. Uma consulta que faz referência a um object_id em outro banco de dados retorna NULL ou resultados incorretos. Por exemplo, na consulta a seguir, o contexto atual do banco de dados é o master banco de dados. O Mecanismo de Banco de Dados tenta retornar o valor da propriedade para o object_id especificado nesse banco de dados em vez do banco de dados especificado na consulta. A consulta retorna resultados incorretos porque a exibição vEmployee não está no master banco de dados.

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

OBJECTPROPERTY(view_id, 'IsIndexable') pode consumir recursos de computador significativos porque a avaliação da propriedade IsIndexable requer a análise da definição de exibição, da normalização e da otimização parcial. Embora a propriedade IsIndexable identifique tabelas ou exibições que podem ser indexadas, a criação atual do índice ainda poderá falhar se certos requisitos de chave de índice não forem atendidos. Para obter mais informações, veja CREATE INDEX (Transact-SQL).

OBJECTPROPERTY(table_id, 'TableHasActiveFulltextIndex') retorna um valor de 1 (true) quando pelo menos uma coluna de uma tabela é adicionada para indexação. A indexação de texto completo será ativada automaticamente para população assim que a primeira coluna for adicionada para indexação.

Quando uma tabela é criada, a opção QUOTED IDENTIFIER é sempre armazenada como ON nos metadados da tabela, mesmo que a opção esteja definida para OFF quando a tabela é criada. Portanto, OBJECTPROPERTY(table_id, 'IsQuotedIdentOn') sempre retorna um valor de 1 (true).

Exemplos

a. Verificar se um objeto é uma tabela

O exemplo a seguir testa se UnitMeasure é uma tabela no banco de dados AdventureWorks2025.

USE AdventureWorks2022;
GO
IF OBJECTPROPERTY (OBJECT_ID(N'Production.UnitMeasure'),'ISTABLE') = 1
   PRINT 'UnitMeasure is a table.'
ELSE IF OBJECTPROPERTY (OBJECT_ID(N'Production.UnitMeasure'),'ISTABLE') = 0
   PRINT 'UnitMeasure is not a table.'
ELSE IF OBJECTPROPERTY (OBJECT_ID(N'Production.UnitMeasure'),'ISTABLE') IS NULL
   PRINT 'ERROR: UnitMeasure is not a valid object.';
GO

B. Verifique se uma função definida pelo usuário com valor escalar é determinística

O exemplo a seguir testa se a função ufnGetProductDealerPrice de valor escalar definida pelo usuário, que retorna um valor de money é determinística.

USE AdventureWorks2022;
GO
SELECT OBJECTPROPERTY(OBJECT_ID('dbo.ufnGetProductDealerPrice'), 'IsDeterministic');
GO

O conjunto de resultados mostra que ufnGetProductDealerPrice não é uma função determinística.

-----
0

C: localizar as tabelas que pertencem a um esquema específico

O exemplo a seguir retorna todas as tabelas no dbo esquema.

-- Uses AdventureWorks

SELECT schema_name(o.schema_id), o.name, o.object_id, o.type_desc
FROM sys.objects AS o
WHERE OBJECTPROPERTY(o.object_id, N'SchemaId') = SCHEMA_ID(N'dbo')
ORDER BY o.type_desc, o.name;
GO

Exemplos: Azure Synapse Analytics e PDW (Analytics Platform System)

D: Verificando se um objeto é uma tabela

O exemplo a seguir testa se dbo.DimReseller é uma tabela no banco de dados AdventureWorksPDW2022.

-- Uses AdventureWorks

IF OBJECTPROPERTY (OBJECT_ID(N'dbo.DimReseller'),'ISTABLE') = 1
   SELECT 'DimReseller is a table.'
ELSE
   SELECT 'DimReseller is not a table.';
GO

Conteúdo relacionado

• PROPRIEDADE COLUMN (Transact-SQL)
• funções de metadados (Transact-SQL)
• OBJECTPROPERTYEX (Transact-SQL)
• ALTERAR AUTORIZAÇÃO (Transact-SQL)
• TYPEPROPERTY (Transact-SQL)
• sys.objects (Transact-SQL)