Artigo
04/01/2012

sp_tableoption (Transact-SQL)

Define valores de opção para tabelas definidas pelo usuário. Use sp_tableoption para controlar o comportamento em linha de tabelas com varchar(max), nvarchar(max), varbinary(max), xml, text, ntext, image ou grandes colunas de tipo definidas pelo usuário.

Importante
O recurso text in row será removido em uma versão futura do SQL Server. Para armazenar dados de valor grande, recomendamos usar tipos de dados varchar(max), nvarchar(max) e varbinary(max).

Ícone de vínculo de tópico Convenções de sintaxe Transact-SQL

Sintaxe

sp_tableoption [ @TableNamePattern = ] 'table' 
          , [ @OptionName = ] 'option_name' 
          ,[ @OptionValue =] 'value'

Argumentos

[ @TableNamePattern =] 'table'
É o nome qualificado ou não qualificado de uma tabela de banco de dados definida pelo usuário. Se um nome de tabela totalmente qualificado, incluindo um nome de banco de dados, for fornecido, o nome de banco de dados deve ser o nome do banco de dados atual. Não se pode definir opções de tabela para várias tabelas ao mesmo tempo. table é nvarchar(776), sem padrão.

[ @OptionName = ] 'option_name'
É um nome de opção de tabela. option_name é varchar(35), sem padrão de NULL. option_name pode ser um dos valores a seguir.

Valor	Descrição
table lock on bulk load	Quando desabilitado (o padrão), faz com que o processo de carregamento em massa em tabelas definidas pelo usuário obtenha bloqueio de linhas. Quando habilitado, faz com que os processos de carregamento em massa em tabelas definidas pelo usuário obtenham um bloqueio de atualização em massa.
insert row lock	Não há suporte no SQL Server 2008. A estratégia de bloqueio do SQL Server é bloqueio de linha com possível promoção para bloqueio de página ou de tabela. Esta opção não tem nenhum efeito no comportamento de bloqueio do SQL Server e só é incluída para a compatibilidade de scripts e procedimentos existentes.
text in row	Quando OFF ou 0 (desabilitado, o padrão), não altera o comportamento atual e não há nenhum BLOB na linha. Quando especificado e @ OptionValue está ON (habilitado) ou um valor inteiro de 24 a 7000, novas cadeias de caracteres text, ntext ou image são armazenadas diretamente na linha de dados. Todos os BLOB existentes (objetos binários grande: dados text, ntext ou image) serão alterados para texto em formato de linha quando o valor do BLOB for atualizado. Para obter mais informações, consulte Comentários.
large value types out of row	1 = Colunas varchar(max), nvarchar(max), varbinary(max), xml e grandes colunas de tipos definidos pelo usuário na tabela são armazenadas fora de linha, com um ponteiro de 16 bytes para a raiz. 0 = Valores varchar(max), nvarchar(max), varbinary(max), xml e grandes valores de tipos definidos pelo usuário são armazenados diretamente na linha de dados, até um limite de 8000 bytes e contanto que o valor possa se ajustar no registro. Se o valor não se ajustar ao registro, um ponteiro será armazenado em linha e o resto será armazenado fora da linha no espaço de armazenamento de LOB. 0 é o valor padrão.
vardecimal storage format	Quando TRUE, ON ou 1, a tabela designada é habilitada para o formato de armazenamento vardecimal. Quando FALSE, OFF ou 0, a tabela designada não é habilitada para o formato de armazenamento vardecimal. Para habilitar o formato de armazenamento vardecimal é necessário habilitar o banco de dados para esse formato usando sp_db_vardecimal_storage_format. Para obter informações sobre formato de armazenamento de vardecimal, consulte Armazenando dados decimais como comprimento variável. Esta opção requer o SQL Server 2005 Service Pack 2. O formato de armazenamento Vardecimal só está disponível nas edições Enterprise, Developer e Evaluation do SQL Server. No SQL Server 2008 e versões posteriores, todos os bancos de dados são habilitados para o formato de armazenamento vardecimal. No SQL Server 2008 e versões posteriores, o formato de armazenamento vardecimal é preterido. Em vez disso, use compactação ROW. Para obter mais informações, consulte Criando tabelas e índices compactados. 0 é o valor padrão.

[@ OptionValue = ] 'value'
Indica se option_name está habilitado (TRUE, ON ou 1) ou desabilitado (FALSE, OFF ou 0). value é varchar(12), sem padrão. value não diferencia maiúsculas de minúsculas.

Para a opção text in row, valores válidos são 0, ON, OFF ou um inteiro de 24 a 7000. Quando value está ON, o limite padrão é 256 bytes.

Valores de código de retorno

0 (êxito) ou um número de erro (falha)

Comentários

Use sp_tableoption apenas para definir valores de opção para tabelas definidas pelo usuário. Para exibir propriedades de tabela, use OBJECTPROPERTY.

A opção text in row em sp_tableoption só pode ser habilitada ou desabilitada em tabelas que contêm colunas de texto. Se a tabela não tiver uma coluna de texto, o SQL Server gerará um erro.

Quando a opção text in row é habilitada, o parâmetro @ OptionValue permite aos usuários especificar o tamanho máximo a ser armazenado em uma linha para um BLOB. O padrão é 256 bytes, mas valores podem variar de 24 a 7000 bytes.

As cadeias de caracteres text, ntext ou image serão armazenados na linha de dados se as seguintes condições se aplicarem:

A opção texto em linha está habilitada.
O comprimento da cadeia de caracteres é mais curto que o limite especificado em @ OptionValue
Há bastante espaço disponível na linha de dados.

Quando cadeias BLOB são armazenadas na linha de dados, a leitura e gravação das cadeias text, ntext ou image pode ser tão rápida quanto a leitura ou gravação cadeias binárias ou de caracteres. O SQL Server não tem que acessar páginas separadas para ler ou escrever a cadeia BLOB.

Se uma cadeia de caracteres text, ntext ou image for maior que o limite especificado ou o espaço disponível na linha, no lugar delas serão armazenados ponteiros linha. As condições para armazenar as cadeias de caracteres BLOB na linha ainda assim se aplicam: deve haver espaço suficiente na linha de dados para conter os ponteiros.

As cadeias e ponteiros BLOB armazenados na linha de uma tabela são tratados de modo semelhante a cadeias de comprimento variável. O SQL Server usa só o número de bytes exigido para armazenar a cadeia de caracteres ou o ponteiro.

As cadeias BLOB existentes não são convertidas imediatamente, quando text in row é habilitada pela primeira vez. As cadeias só são convertidas quando são atualizadas. Igualmente, quando o limite da opção text in row é aumentado, as cadeias de caracteres text, ntext ou image já existentes na linha de dados não serão convertidas para aderir ao limite novo até a hora em que são atualizados.

Observação
Desabilitar a opção text in row ou reduzir o limite da opção exigirá a conversão de todas as BLOBs; assim, o processo pode ser longo, dependendo do número de cadeias BLOB que devem ser convertidas. A tabela é bloqueada durante o processo de conversão.

Uma variável de tabela, incluindo uma função que retorna uma variável de tabela, tem a opção text in row automaticamente habilitada com um limite padrão embutido de 256. Essa opção não pode ser alterada.

A opção text in row oferece suporte para as funções TEXTPTR, WRITETEXT, UPDATETEXT e READTEX. Os usuários podem ler partes de um BLOB com a função SUBSTRING(), mas devem se lembrar de que os ponteiros de texto na linha têm limites de número e duração diferentes de outros ponteiros de texto. Para obter mais informações, consulte Gerenciando dados ntext, texto e imagem.

Para alterar uma tabela de formato de armazenamento vardecimal de volta ao formato de armazenamento decimal normal, o banco de dados deve estar em modo de recuperação SIMPLE. Alterar o modo de recuperação quebrará a cadeia de logs para efeito de backup, portanto, é preciso criar um backup de banco de dados completo, depois de remover o formato de armazenamento vardecimal de uma tabela.

Permissões

Para executar sp_tableoption é necessário ter permissão ALTER na tabela.

Exemplos

A. Armazenando dados xml fora da linha

O exemplo a seguir especifica que os dados xml na tabela HumanResources.JobCandidate sejam armazenados fora da linha.

USE AdventureWorks2008R2;
GO
EXEC sp_tableoption 'HumanResources.JobCandidate', 'large value types out of row', 1;

B. Habilitando o formato de armazenamento vardecimal em uma tabela

O exemplo a seguir modifica a tabela Production.WorkOrderRouting para armazenar o tipo de dado decimal no vardecimalstorage format.

USE master;
GO
-- The database must be enabled for vardecimal storage format
-- before a table can be enabled for vardecimal storage format
EXEC sp_db_vardecimal_storage_format 'AdventureWorks2008R2', 'ON';
GO
USE AdventureWorks2008R2;
GO
EXEC sp_tableoption 'Production.WorkOrderRouting', 
   'vardecimal storage format', 'ON';