Usando propriedades estendidas em objetos de banco de dados

Definindo as propriedades estendidas

Cada propriedade estendida tem um nome e valor definido pelo usuário. O valor de uma propriedade estendida é um valor sql_variant que pode conter até 7.500 bytes de dados. Várias propriedades estendidas podem ser adicionadas a um único objeto.

Para especificar as propriedades estendidas, os objetos em um banco de dados SQL Server são classificados em três níveis, 0, 1 e 2. O nível 0 é o nível mais alto e está definido como objetos que são contidos no escopo do banco de dados. Objetos de nível 1 são contidos em um esquema ou escopo do usuário e os objetos de nível 2 são contido pelos objetos de nível 1 As propriedades estendidas podem ser definidas para os objetos em qualquer um desses níveis.

As referências a um objeto, em um nível, precisam ser qualificadas com nomes de objetos de um nível superior no qual estejam contidos . Por exemplo, quando adicionar uma propriedade estendida à coluna de tabela, do nível 2, é preciso também especificar o nome da tabela, do nível 1, que contém a coluna e o esquema do nível 0, que contém a tabela.

No exemplo a seguir, o valor de propriedade estendida 'Minimum inventory quantity.' é adicionado à coluna SafetyStockLevel na tabela Product que está contida no esquema Production .

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Minimum inventory quantity.', 
@level0type = N'SCHEMA', @level0name = Production, 
@level1type = N'TABLE',  @level1name = Product,
@level2type = N'COLUMN', @level2name = SafetyStockLevel;
GO

Adicionando propriedades estendidas a objetos

As tabelas a seguir listam os objetos aos quais você pode adicionar propriedades estendidas. Os objetos nível 0, nível 1 e nível 2 estão listados e também as permissões necessárias para adicionar, cancelar ou exibir as propriedades estendidas.

Agregação

Chave assimétrica

Assembly

Certificado

Contrato (Service Broker)

Banco de dados

Exemplo

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'AdventureWorks Sample OLTP Database';
GO

Padrão

Notificações de eventos

Grupo de arquivos ou nome de arquivo

Exemplo

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Primary filegroup for the AdventureWorks sample database.', 
@level0type = N'FILEGROUP', @level0name = [PRIMARY];
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Primary data file for the AdventureWorks sample database.', 
@level0type = N'FILEGROUP', @level0name = [PRIMARY],
@level1type = N'Logical File Name', @level1name = AdventureWorks_Data;
GO

Função

Exemplo

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Scalar function returning the quantity of inventory for a specified ProductID.', 
@level0type = N'SCHEMA', @level0name = [dbo],
@level1type = N'FUNCTION', @level1name = ufnGetStock;
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Input parameter. Enter a valid ProductID.', 
@level0type = N'SCHEMA', @level0name = [dbo],
@level1type = N'FUNCTION', @level1name = ufnGetStock,
@level2type = N'PARAMETER', @level2name ='@ProductID';
GO

Tipo de mensagem

Função de partição

Esquema de partição

Guia de plano

O exemplo a seguir adicionou uma propriedade estendida ao guia de plano TemplateGuide1.

USE AdventureWorks;
GO
EXECUTE sp_addextendedproperty @name=N'PlanGuideGroup', @value = N'MyTest', 
@level0type = N'Plan Guide', @level0name = 'TemplateGuide1';

Procedimento

Nível	Tipo de nível	Permissões necessárias para adicionar ou descartar uma propriedade estendida	Permissões necessárias para exibir uma propriedade estendida	Comentários
0	SCHEMA ou USER			SCHEMA deve ser usado em vez de USER. Consulte "Esquema versus usuário" mais adiante neste tópico.
1	PROCEDURE	ALTER em OBJECT de procedimento Observação Só os membros da função de servidor fixa sysadmin podem adicionar propriedades estendidas aos procedimentos armazenados estendidos.	Qualquer em OBJECT	Aplica-se a esses procedimentos armazenados definidos pelo usuário: CLR Transact-SQL Filtro de replicação Se um tipo de nível 2 não for especificado, a propriedade se aplica ao próprio procedimento.
2	PARAMETER	ALTER em OBJECT de procedimento	Qualquer em OBJECT

Fila (Service Broker)

Associação de serviço remoto (Service Broker)

Rota (Service Broker)

Regra

Esquema ou usuário

Nível	Tipo de nível	Permissões necessárias para adicionar ou descartar uma propriedade estendida	Permissões necessárias para exibir uma propriedade estendida	Comentários
0	SCHEMA ou USER	ALTER em SCHEMA ou ALTER em USER	Qualquer em APPLICATION ROLE Ou Qualquer em ROLE Ou Qualquer em USER	Se um tipo de nível 1 não for especificado, a propriedade se aplicará ao próprio esquema ou usuário. USER pode ser uma destas opções: Função de aplicativo Função de banco de dados Usuário SQL Server Grupo do Windows Usuário do Windows USER só deve ser usado quando você adicionar uma propriedade estendida a um usuário. Importante USER definido como nível 0, nos tipos de objetos de nível 1 ou 2 será removido em uma versão futura do SQL Server. Evite usar esse recurso em desenvolvimentos novos e planeje modificar os aplicativos que atualmente o utilizam. Em vez disso use SCHEMA como o nível 0.
1	Varia
2	Varia

Serviço

Chave simétrica

Sinônimo

Tabela

Exemplo

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_Description', 
@value = N'Street address information for customers, employees, and vendors.', 
@level0type = N'SCHEMA', @level0name = Person, 
@level1type = N'TABLE',  @level1name = Address;
GO

USE AdventureWorks;
GO
EXEC sys.sp_addextendedproperty 
@name = N'MS_DescriptionExample', 
@value = N'Nonclustered index on StateProvinceID.', 
@level0type = N'SCHEMA', @level0name = Person, 
@level1type = N'TABLE',  @level1name = Address,
@level2type = N'INDEX',  @level2name = IX_Address_StateProvinceID;
GO

Gatilho

Tipo

Tipo

Exibição

Coleção de esquema XML

Objetos que não oferecem suporte às propriedades estendidas

Não podem ser definidas propriedades estendidas nestes objetos:

• Objetos do escopo de banco de dados não listados nas tabelas anteriores. Isso inclui objetos de texto completo

• Objetos fora do escopo de banco de dados como pontos finais HTTP.

• Objetos sem nomes como parâmetros de função de partição.

• Certificados, chaves simétricas, chaves assimétricas e credenciais.

• Objetos definidos pelo sistema como tabelas do sistema, exibições do catálogo e procedimentos armazenados do sistema.

Esquema versus usuário

Em versões anteriores do SQL Server, os usuários tinham objetos de banco de dados como tabelas, exibições e gatilhos. Por isso, era permitido adicionar uma propriedade estendida a um desses objetos e especificar um nome de usuário como o nível 0. Os objetos de banco de dados agora são contidos em esquemas independentes dos usuários que tenham os esquemas.

Se você especificar um USER como nível 0, quando aplicar uma propriedade estendida ao objeto de banco de dados , isso poderá criar ambigüidade na resolução de nome. Por exemplo, imagine que o usuário Mary tenha dois esquemas, Mary e MySchema e esses esquemas contenham ambos uma tabela chamada MyTable. Se Mary adicionar uma propriedade estendida à tabela MyTable e especificar @level0type = N'USER', @level0name = Mary, não assegura para qual tabela a propriedade estendida foi aplicada. Para manter compatibilidade com versões anteriores, o SQL Server aplicará a propriedade à tabela contida no esquema chamado Mary. Para obter mais informações sobre usuários e esquemas, consulte Separação do esquema de usuário.

Usando máscaras de entrada versus restrições CHECK

As restrições CHECK e as propriedades estendidas que fornecem as máscaras de entrada podem ser usadas para especificar o padrão de dados esperado para a tabela ou para a exibição de colunas . A maioria dos sites escolhe um ou o outro, exceto se ocorrer um dos seguintes casos:

• As restrições CHECK foram usadas como uma medida temporária até que todos os programas que trabalhavam com esta tabela pudessem ser alterados para usar as propriedades da máscara de entrada.

• O site também oferece suporte a usuários que atualizam os dados através de ferramentas ad hoc que não lêem as propriedades estendidas.

A vantagem da máscara de entrada sobre a restrição CHECK é que, a lógica se aplica aos aplicativos. Esses podem gerar mais erros informativos se um usuário fornecer dados formatados incorretamente. A desvantagem da máscara de entrada é que ela necessita de uma chamada separada para fn_listextendedproperty ou sys.extended_properties para obter a propriedade e a lógica para aplicar a máscara deve ser adicionada em todos os programas.

Replicando propriedades estendidas

As propriedades estendidas são replicadas apenas na sincronização inicial entre o Publicador e o Assinante. Se você adicionar ou modifica uma propriedade estendida depois da sincronização inicial, a alteração não será replicada. Para obter mais informações sobre a replicação de objetos de banco de dados, consulte Publicando dados e objetos de banco de dados.

Usando as propriedades estendidas em aplicativos

As propriedades estendidas fornecem apenas um local nomeado para armazenar dados. Todos os aplicativos devem ser codificados para consultar a propriedade e executar a ação adequada. Por exemplo, adicionar uma propriedade de legenda a uma coluna não cria uma legenda que possa ser exibida por um aplicativo. Cada aplicativo deve ser codificado para ler a legenda e exibi-la corretamente.

Para adicionar uma propriedade estendida

• sp_addextendedproperty (Transact-SQL)

Para atualizar uma propriedade estendida

• sp_updateextendedproperty (Transact-SQL)

Para excluir uma propriedade estendida

• sp_dropextendedproperty (Transact-SQL)

Para exibir uma propriedade estendida

• fn_listextendedproperty (Transact-SQL)

• sys.extended_properties (Transact-SQL)

Consulte também

Referência

Conceitos

Outros recursos