Utilitário sqlcmd

O utilitário sqlcmd permite digitar instruções Transact-SQL, procedimentos do sistema e arquivos de script no prompt de comando, no Editor de Consultas em modo SQLCMD, em um arquivo de script do Windows ou em uma etapa de trabalho do sistema operacional (Cmd.exe) de um trabalho do SQL Server Agent. Esse utilitário usa ODBC para executar lotes Transact-SQL.

Importante

SQL Server Management Studio usa o Microsoft .NET Framework SqlClient para execução em modo normal e SQLCMD no Editor de consultas. Quando sqlcmd é executado na linha de comando, sqlcmd usa o driver ODBC. Devido às diversas opções padrão que podem ser aplicadas, é possível observar um comportamento diferente ao executar a mesma consulta no SQL Server Management Studio no Modo SQLCMD e no utilitário sqlcmd.

Atualmente, sqlcmd não requer um espaço entre a opção de linha de comando e o valor. Porém, em uma versão futura, um espaço pode ser necessário entre a opção de linha de comando e o valor.

Sintaxe

sqlcmd  
   -a packet_size 
   -A (dedicated administrator connection)
   -b (terminate batch job if there is an error)
   -c batch_terminator 
   -C (trust the server certificate)
   -d db_name 
   -e (echo input)
   -E (use trusted connection)
   -f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]
   -h rows_per_header 
   -H workstation_name 
   -i input_file 
   -I (enable quoted identifiers)
   -k[1 | 2] (remove or replace control characters)
   -K application_intent 
   -l login_timeout 
   -L[c] (list servers, optional clean output)
   -m error_level 
   -M multisubnet_failover 
   -N (encrypt connection)
   -o output_file 
   -p[1] (print statistics, optional colon format)
   -P password 
   -q "cmdline query" 
   -Q "cmdline query" (and exit)
   -r[0 | 1] (msgs to stderr)
   -R (use client regional settings)
   -s col_separator 
   -S [protocol:]server[\instance_name][,port]
   -t query_timeout 
   -u (unicode output file)
   -U login_id 
   -v var = "value" 
   -V error_severity_level 
   -w column_width 
   -W (remove trailing spaces)
   -x (disable variable substitution)
   -X[1] (disable commands, startup script, environment variables and optional exit)
   -y variable_length_type_display_width 
   -Y fixed_length_type_display_width 
   -z new_password  
   -Z new_password (and exit)

   -? (usage)

Opções de linha de comando

• Opções relacionadas a logon

• -A
  Fazer logon no SQL Server com uma DAC (conexão de administrador dedicada). Esse tipo de conexão é usado para solucionar um problema no servidor. Isso funcionará apenas com computadores servidor que oferecem suporte para DAC. Se a DAC não estiver disponível, o sqlcmd gerará uma mensagem de erro e será encerrado. Para obter mais informações sobre DAC, consulte Conexão de diagnóstico para administradores de banco de dados.

• -C
  Essa opção é usada pelo cliente para configurá-lo para confiar implicitamente no certificado do servidor sem validação. Essa opção é equivalente à opção TRUSTSERVERCERTIFICATE = true do ADO.NET.

• -d db_name
  Emite uma instrução USE db_name ao iniciar o sqlcmd. Essa opção define a variável de script SQLCMDDBNAME do sqlcmd. Isso especifica o banco de dados inicial. O padrão é a propriedade do banco de dados padrão de seu logon. Se o banco de dados não existir, será gerada uma mensagem de erro e o sqlcmd é encerrado.

• -l login_timeout
  Especifica o número de segundos antes que um logon do sqlcmd para o driver ODBC expire, ao tentar conectar a um servidor. Essa opção define a variável de script SQLCMDLOGINTIMEOUT do sqlcmd. O tempo limite padrão de logon do sqlcmd é de oito segundos. O tempo limite do logon deve ser um número entre 0 e 65534. O sqlcmd irá gerar uma mensagem de erro se o valor fornecido não for numérico ou não estiver nesse intervalo. Um valor de 0 especifica o tempo limite como infinito.

• -E
  Usa uma conexão confiável em vez de um nome de usuário e senha para fazer logon no SQL Server. Por padrão, sem a especificação de -E, sqlcmd usa a opção de conexão confiável.

  A opção -E ignora possíveis definições de variável de ambiente de nome de usuário e senha como SQLCMDPASSWORD. Se a opção -E for usada com -U ou -P, uma mensagem de erro será gerada.

• -H workstation_name
  Um nome de estação de trabalho. Essa opção define a variável de script SQLCMDWORKSTATION do sqlcmd. O nome da estação de trabalho é listado na coluna hostname da exibição de catálogo sys.processes e pode ser retornado usando-se o procedimento armazenado sp_who. Se essa opção não for especificada, o padrão será o nome do computador atual. Esse nome pode ser usado para identificar sessões sqlcmd diferentes.

• -K application_intent
  Declara o tipo de carga de trabalho de aplicativo ao conectar-se a um servidor. O único valor com suporte no momento é ReadOnly. Se -K não for especificado, o utilitário sqlcmd não oferecerá suporte à conectividade com uma réplica secundária em um grupo de disponibilidade AlwaysOn. Para obter mais informações, consulte Secundárias ativas: réplicas secundárias legíveis (Grupos de Disponibilidade AlwaysOn).

• -M multisubnet_failover
  Sempre especifique -M ao conectar-se ao ouvinte de um grupo de disponibilidade do SQL Server 2012 ou de uma instância de cluster de failover do SQL Server 2012. -M proporciona a detecção mais rápida e a conexão com o servidor (atualmente) ativo. Se –M não for especificada, -M ficará desativada. Para obter mais informações sobre o Grupos de Disponibilidade AlwaysOn, consulte Ouvintes de grupo de disponibilidade, conectividade de cliente e failover de aplicativo (SQL Server), Criação e configuração de grupos de disponibilidade (SQL Server), Clustering de failover e Grupos de Disponibilidade AlwaysOn (SQL Server) e Secundárias ativas: réplicas secundárias legíveis (Grupos de Disponibilidade AlwaysOn).

• -N
  Essa opção é usada pelo cliente para solicitar uma conexão criptografada.

• -P password
  É uma senha especificada pelo usuário. Senhas diferenciam maiúsculas de minúsculas. Se for usada a opção -U e a opção -P não for usada e a variável de ambiente SQLCMDPASSWORD não tiver sido definida, o sqlcmd solicita uma senha ao usuário. Se a opção -P for usada ao término do prompt de comando sem uma senha, o sqlcmd usará a senha padrão (NULL).

  Observação sobre segurança
  Não use uma senha em branco. Use uma senha forte. Para obter mais informações, consulte Senhas fortes.

  O prompt de senha é exibido por meio da impressão do prompt de senha no console, como a seguir: Password:

  A entrada do usuário está oculta. Isso significa que nada é exibido e o cursor fica em posição.

  A variável de ambiente SQLCMDPASSWORD lhe permite definir uma senha padrão para a sessão atual. Assim, senhas não têm de ser hard-coded em arquivos em lote.

  O exemplo a seguir define, em primeiro lugar, a variável SQLCMDPASSWORD no prompt de comando e acessa o utilitário sqlcmd. No prompt de comando, digite:

  SET SQLCMDPASSWORD= p@a$$w0rd

  Observação sobre segurança
  A senha estará visível para qualquer um que tiver acesso ao monitor do seu computador.

  No prompt de comando a seguir, digite:

  sqlcmd

  Se a combinação de nome de usuário e senha estiver incorreta, uma mensagem de erro será gerada.

  Observação
  A variável de ambiente OSQLPASSWORD foi mantida para compatibilidade com versões anteriores. A variável de ambiente SQLCMDPASSWORD tem precedência em relação à variável de ambiente OSQLPASSWORD; o que significa que sqlcmd e osql podem ser usados próximos um do outro sem interferência e que scripts antigos continuarão funcionado.

  Será gerada uma mensagem de erro se a opção -P for usada com a opção -E.

  Será gerada uma mensagem de erro se a opção -P for seguida por mais de um argumento e o programa será encerrado.

• -S [protocol:]server[**\instance_name][,**port]
  Especifica uma instância do SQL Server à qual se conectar. Define a variável de script SQLCMDSERVER do sqlcmd.

  Especifica server_name para conexão com a instância padrão do SQL Server naquele computador servidor. Especifica server_name [ **\**instance_name ] para conexão com uma instância nomeada do SQL Server naquele computador servidor. Se nenhum servidor for especificado, o sqlcmd irá se conectar à instância padrão do SQL Server no computador local. Essa opção é necessária quando se executa o sqlcmd de um computador remoto na rede.

  protocol pode ser tcp (TCP/IP), lpc (memória compartilhada) ou np (pipes nomeados).

  Se você não especificar um server_name [ **\**instance_name ] ao iniciar o sqlcmd, o SQL Server fará a verificação e usará a variável de ambiente SQLCMDSERVER.

  Observação
  A variável de ambiente OSQLSERVER foi mantida para compatibilidade com versões anteriores. A variável de ambiente SQLCMDSERVER tem precedência em relação à variável de ambiente OSQLSERVER; o que significa que o sqlcmd e osql podem ser usados próximos um do outro sem interferência e que scripts antigos continuarão funcionado.

• -U login_id
  É a identificação de logon do usuário.

  Observação
  A variável de ambiente OSQLUSER está disponível para compatibilidade com versões anteriores. A variável de ambiente SQLCMDUSER tem precedência em relação à variável de ambiente OSQLUSER. Isso significa que sqlcmd e osql podem ser usados próximos um do outro sem interferência. Significa também que scripts osql existentes continuarão funcionando.

  Se não forem especificadas as opções -U ou -P, o sqlcmd tenta conectar-se usando o modo de Autenticação do Microsoft Windows. A autenticação baseia-se na conta do Windows do usuário que está executando o sqlcmd.

  Uma mensagem de erro será gerada se a opção -U for usada com a opção -E (descrita posteriormente neste tópico). Será gerada uma mensagem de erro se a opção –U for seguida por mais de um argumento e o programa será encerrado.

• -z new_password
  Alterar senha:

  sqlcmd -U someuser -P s0mep@ssword -z a_new_p@a$$w0rd

• -Z new_password
  Alterar senha e sair:

  sqlcmd -U someuser -P s0mep@ssword -Z a_new_p@a$$w0rd

• Input/Output Options

• -f codepage | **i:codepage[,o:**codepage] | **o:codepage[,i:**codepage]
  Especifica as páginas de código de entrada e saída. O número da página de código é um valor numérico que especifica um código de página instalada do Windows.

  Regras de conversão de página de código:

  • Se não for especificada nenhuma página de código, o sqlcmd usará a página de código atual para arquivos de entrada e de saída, a menos que o arquivo de entrada seja um arquivo Unicode, para o qual não é necessária nenhuma conversão.

  • O sqlcmd reconhece automaticamente arquivos de entrada Unicode big-endian e little-endian. Se for especificada a opção -u, a saída será sempre Unicode little-endian.

  • Se não for especificado nenhum arquivo de saída, a página de código de saída será a página de código de console. Isso habilita a saída a ser exibida corretamente no console.

  • Assume-se que arquivos de entrada múltiplos tenham a mesma página de código. Arquivos de entrada Unicode e não Unicode podem ser misturados.

  Digite chcp no prompt de comando para verificar a página de código de Cmd.exe.

• -i input_file[**,**input_file2...]
  Identifica o arquivo que contém um lote de instruções SQL ou procedimentos armazenados. Poderão ser especificados vários arquivos para serem lidos e processados em ordem. Não use espaço entre nomes de arquivos. sqlcmd verificará primeiramente se todos os arquivos especificados existem. Se um ou mais arquivos não existirem, o sqlcmd será encerrado. As opções -i e Q/-q são mutuamente exclusivas.

  Exemplos de caminho:

  -i C:\<nomedoarquivo>

  -i \\<Servidor>\<Compartilhamento$>\<nomedoarquivo>

  -i "C:\Alguma pasta\<nome do arquivo>"

  Os nomes de caminhos que contêm espaços deverão ficar entre aspas.

  Esta opção pode ser usada mais de uma vez: -i input_file -I I input_file.

• -o output_file
  Identifica o arquivo que recebe a saída do sqlcmd.

  Se for especificado -u, o output_file será armazenado em formato Unicode. Se o nome do arquivo for inválido, uma mensagem de erro será gerada e o sqlcmd será encerrado. O sqlcmd não oferece suporte à gravação simultânea de vários processos sqlcmd no mesmo arquivo. A saída de arquivo será corrompida ou incorreta. Consulte a opção -f para obter mais informações sobre formatos de arquivos. Caso não exista, esse arquivo será criado. Será substituído um arquivo com o mesmo nome de uma sessão sqlcmd anterior. O arquivo aqui especificado não é o arquivo stdout. Se for especificado um arquivo stdout este arquivo não será usado.

  Exemplos de caminho:

  -o C:\< nomedoarquivo>

  -o \\<Servidor>\<Compartilhamento$>\<nomedoarquivo>

  **-o "**C:\Alguma pasta\<nome do arquivo>"

  Os nomes de caminhos que contêm espaços deverão ficar entre aspas.

• -r[0 | 1]
  Redireciona a saída da mensagem de erro para a tela (stderr). Se você não especificar um parâmetro ou se especificar 0, serão redirecionadas somente mensagens de erro com nível de severidade 11 ou acima disso. Se você especificar 1, serão redirecionadas todas as saídas de mensagens de erro inclusive PRINT. Não tem nenhum efeito se você usar -o. Por padrão, mensagens são envidadas para stdout.

• -R
  Faz com que o sqlcmd localize colunas numéricas, de moeda, data e hora recuperadas do SQL Server com base na localidade do cliente. Por padrão, essas colunas são exibidas usando as configurações regionais do servidor.

• -u
  Especifica que output_file está armazenado em formato Unicode, independentemente do formato de input_file.

• Opções de execução de consultas

• -e
  Grava scripts de entrada no dispositivo de saída padrão (stdout).

• -I
  Define a opção de conexão SET QUOTED_IDENTIFIER como ON. Por padrão, ela é definida como OFF. Para obter mais informações, consulte SET QUOTED_IDENTIFIER (Transact-SQL).

• -q" cmdline query "
  Executa uma consulta quando sqlcmd é iniciado, mas não encerra sqlcmd quando a consulta for concluída. Podem ser executadas consultas delimitadas por vários ponto e vírgula. Use aspas na consulta, conforme o exemplo a seguir.

  No prompt de comando, digite:

  sqlcmd -d AdventureWorks2012 -q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

  sqlcmd -d AdventureWorks2012 -q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

  Importante
  Não use o terminador GO na consulta.

  Se for especificado -b juntamente com essa opção, sqlcmd será encerrado com erro. -b é descrita posteriormente neste tópico.

• -Q" cmdline query "
  Executa uma consulta quando sqlcmd é iniciado e imediatamente encerra sqlcmd. Podem ser executadas consultas delimitadas por vários ponto e vírgula.

  Use aspas na consulta, conforme o exemplo a seguir.

  No prompt de comando, digite:

  sqlcmd -d AdventureWorks2012 -Q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

  sqlcmd -d AdventureWorks2012 -Q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

  Importante
  Não use o terminador GO na consulta.

  Se for especificado -b juntamente com essa opção, sqlcmd será encerrado com erro. -b é descrita posteriormente neste tópico.

• -t query_timeout
  Especifica quanto segundos faltam para que um comando (ou instrução SQL) expire. Essa opção define a variável de script SQLCMDSTATTIMEOUT do sqlcmd. Se não for especificado um valor time_out, o comando não expira. O query time_out deve ser um número entre 1 e 65534. O sqlcmd irá gerar uma mensagem de erro se o valor fornecido não for numérico ou não estiver nesse intervalo.

  Observação
  O valor de expiração atual pode ter uma variação de vários segundos em relação ao valor time_out especificado.

• -vvar = value[ var = value...]
  Cria uma variável de script sqlcmdque pode ser usada em um script sqlcmd. Se o valor contiver espaços, mantenha-o entre aspas. Podem ser especificados vários valores var="values". Se houver erros em quaisquer dos valores especificados, o sqlcmd irá gerar uma mensagem de erro e então será encerrado.

  sqlcmd -v MyVar1=something MyVar2="some thing"

  sqlcmd -v MyVar1=something -v MyVar2="some thing"

• -x
  Faz com que o sqlcmd ignore variáveis de script. Isso é útil quando um script tiver muitas instruções INSERT que podem conter cadeias de caracteres com o mesmo formato de variáveis regulares, como, por exemplo, $(variable_name).

• Opções de formatação

• -h headers
  Especifica o número de linhas a imprimir entre os títulos da coluna. O padrão é imprimir títulos uma vez para cada conjunto de resultados de consulta. Essa opção define a variável de script SQLCMDHEADERS do sqlcmd. Use -1 para especificar que os títulos não precisam ser impressos. Qualquer valor inválido faz com que o sqlcmd gere uma mensagem de erro e então seja encerrado.

• -k [1 | 2]
  Remove todos os caracteres de controle, como tabulações e caracteres de nova linha, da saída. Isso preserva a formatação de coluna quando os dados são retornados. Se for especificado 1, os caracteres de controle serão substituídos por um único espaço. Se for especificado 2, os caracteres de controle consecutivos serão substituídos por um único espaço. -k é o mesmo que -k1.

• -s col_separator
  Especifica o caractere do separador de coluna. O padrão é um espaço em branco. Essa opção define a variável de script SQLCMDCOLSEP do sqlcmd. Para usar caracteres com um significado especial para o sistema operacional como, por exemplo, E comercial (&) ou ponto e vírgula (;), use-os entre aspas ("). O separador de coluna pode ser qualquer caractere de 8 bits.

• -w column_width
  Especifica a largura de tela para saída. Essa opção define a variável de script SQLCMDCOLWIDTH do sqlcmd. A largura da coluna deve ser um número maior que 8 e menor que 65536. Se a largura da coluna especificada não estiver nesse intervalo, o sqlcmd irá gerar uma mensagem de erro. A largura padrão é 80 caracteres. Quando uma linha de saída excede a largura de coluna especificada, ela inclui a próxima linha.

• -W
  Essa opção remove espaços à direita de uma coluna. Use essa opção juntamente com a opção -s ao preparar dados a serem exportados para outro aplicativo. Ela não pode ser usada com as opções -y ou -Y.

• -y variable_length_type_display_width
  Define a variável de script SQLCMDMAXFIXEDTYPEWIDTH do sqlcmd. O padrão é 256. Ele limita o número de caracteres retornados para os tipos de dados com comprimento variável grande:

  • varchar(max)

  • nvarchar(max)

  • varbinary(max)

  • xml

  • UDT (user-defined data types)

  • text

  • ntext

  • image

  Observação
  UDTs podem ter comprimento fixo dependendo da implementação. Se esse comprimento de UDT de comprimento fixo for mais curto que display_width, o valor do UDT retornado não será afetado. Porém, se o comprimento for mais longo que display_width, a saída será truncada.

  Se display_width for 0, a saída será truncada a 1 MB.

  Importante
  Use a opção -y 0 com muito cuidado porque isso pode levar a graves problemas de desempenho tanto no servidor quanto na rede, dependendo do tamanho dos dados retornados.

• -Y fixed_length_type_display_width
  Define a variável de script SQLCMDMAXVARTYPEWIDTH do sqlcmd. O padrão é 0 (ilimitado). Limita o número de caracteres retornado para os tipos de dados a seguir:

  • char(n), onde 1<=n<=8000

  • nchar(nn), onde 1<=n<=4000

  • varchar(nn), onde 1<=n<=8000

  • nvarchar(nn), onde 1<=n<=4000

  • varbinary(nn), onde 1<=n<=4000

  • variant

• Opções de relatório de erro

• -b
  Especifica que o sqlcmd é encerrado e retorna um valor DOS ERRORLEVEL em caso de erro. O valor que é retornado à variável DOS ERRORLEVEL é 1 quando a mensagem de erro SQL Server tiver um nível de severidade maior do que 10; caso contrário, o valor retornado é 0. Se a opção -V tiver sido definida além de -b, o sqlcmd não relatará um erro se o nível de severidade for inferior aos valores definidos usando -V. Arquivos em lote do prompt de comando podem testar o valor de ERRORLEVEL e tratar o erro adequadamente. sqlcmd não relata erros para nível de severidade 10 (mensagens informativas).

  Se o script sqlcmd tiver um comentário incorreto, erro de sintaxe, ou se estiver faltando uma variável de script, ERRORLEVEL retorna 1.

• -m error_level
  Controla quais mensagens de erro são enviadas a stdout. Mensagens com um nível de severidade maior ou igual a esse nível são enviadas. Quando esse valor for definido como -1, todas as mensagens que incluem mensagens informativas serão enviadas. Não são permitidos espaços entre -m e -1. Por exemplo, -m-1 é válido e -m -1 não é.

  Essa opção também define a variável de script SQLCMDERRORLEVEL do sqlcmd. Essa variável tem um padrão de 0.

• -V error_severity_level
  Controla o nível de severidade usado para definir a variável ERRORLEVEL. Mensagens de erro com níveis de severidade maiores ou iguais a esse valor definem ERRORLEVEL. Valores menores que 0 são reportados como 0. Podem ser usados arquivos de lote e CMD para testar o valor da variável ERRORLEVEL.

• Opções diversas

• -a packet_size
  Exige um pacote de tamanho diferente. Essa opção define a variável de script SQLCMDPACKETSIZE do sqlcmd. packet_size deve ser um valor entre 512 e 32767. O padrão = 4096. Um tamanho de pacote maior pode melhorar o desempenho da execução de scripts que tenham muitas instruções SQL entre comandos GO. Pode-se solicitar um tamanho de pacote maior. Porém, se a solicitação for negada, o sqlcmd usará o padrão de servidor para tamanho de pacote.

• -c batch_terminator
  Especifica o terminador de lote. Por padrão, comandos são finalizados e enviados para o SQL Server digitando-se apenas a palavra "GO" em uma linha. Ao redefinir o terminador de lote, não use palavras-chave reservadas do Transact-SQL ou caracteres que tenham um significado especial para o sistema operacional, mesmo que sejam precedidas por uma barra invertida.

• -L[c]
  Lista os computadores servidor localmente configurados e os nomes dos computadores servidor que estão transmitindo na rede. Esse parâmetro não pode ser usado em combinação com outros parâmetros. O número máximo de computadores servidores que pode ser listado é 3000. Se a lista de servidores ficar truncada devido ao tamanho do buffer, será exibida uma mensagem de aviso.

  Observação
  Devido à natureza da transmissão em redes, o sqlcmd pode não receber a tempo uma resposta de todos os servidores. Assim, a lista de servidores retornada pode variar para cada invocação dessa opção.

  Se for especificado o parâmetro opcional c, a saída aparecerá sem os servidores: linha de cabeçalho e cada linha de servidor será listada sem espaços à esquerda. Isso é chamado de saída normal. A saída normal melhora o desempenho de processamento das linguagens dos scripts.

• -p[1]
  Imprime estatísticas de desempenho para cada conjunto de resultados. O exemplo a seguir mostra o formato para estatísticas de desempenho:

  Network packet size (bytes): n

  x xact[s]:

  Clock Time (ms.): total t1 avg t2 (t3 xacts per sec.)

  Onde:

  x = Número de transações processadas pelo SQL Server.

  t1 = Tempo total para todas as transações.

  t2 = Tempo médio para uma única transação.

  t3 = Número médio de transações por segundo.

  Todos os tempos estão em milissegundos.

  Se for especificado o parâmetro opcional 1, o formato de saída das estatísticas estará em formato separado por dois pontos, que pode ser facilmente importado para uma planilha ou processado por um script.

  Se o parâmetro opcional for qualquer valor diferente de 1, será gerado um erro e o sqlcmd será encerrado.

• -X[1]
  Desabilita comandos que podem comprometer a segurança do sistema quando o sqlcmd é executado a partir de um arquivo em lote. Os comandos desabilitados ainda são reconhecidos; o sqlcmd emite uma mensagem de aviso e continua. Se for especificado o parâmetro opcional 1, o sqlcmd gera uma mensagem de erro e é encerrado. Os comandos a seguir são desabilitados quando for usada a opção -X:

  • ED

  • !! command

  Se for especificada a opção -X, isso evita que variáveis de ambiente sejam transmitidas para o sqlcmd. Evita também que o script de inicialização especificado, usando a variável de script SQLCMDINI, seja executado. Para obter mais informações sobre variáveis de script, consulte sqlcmd e Usar sqlcmd com variáveis de script.

• -?
  Exibe o resumo de sintaxe de opções do sqlcmd.

Comentários

As opções não precisam ser usadas na ordem mostrada na seção de sintaxe.

Quando são retornados vários resultados, o sqlcmd imprime uma linha em branco entre cada conjunto de resultados em um lote. Além disso, a mensagem "<x> linhas afetadas" não aparece quando não se aplica à instrução executada.

Para usar o sqlcmd interativamente, digite sqlcmd no prompt de comando com uma ou mais das opções descritas anteriormente neste tópico. Para obter mais informações, consulte Usar o utilitário sqlcmd

Observação
As opções -L, -Q, -Z ou -i fazem com que o sqlcmd seja encerrado depois da execução.

O comprimento total da linha de comando sqlcmd no ambiente de comando (Cmd.exe), incluindo todos os argumentos e variáveis expandidas, é aquele determinado pelo sistema operacional para Cmd.exe.

Precedência de variável (baixa para alta)

1. Variáveis ambientais do nível de sistema.

2. Variáveis ambientais do nível de usuário.

3. Shell de comando (SET X=Y) definido no prompt de comando antes da execução do sqlcmd.

4. sqlcmd -v X=Y

5. :Setvar X Y

Observação
Para exibir as variáveis ambientais, no Painel de controle, abra Sistema e então clique na guia Avançado.

Variáveis de script do sqlcmd

Variável	Opção relacionada	R/W	Padrão
SQLCMDUSER	-U	R	""
SQLCMDPASSWORD	-P	--	""
SQLCMDSERVER	-S	R	"DefaultLocalInstance"
SQLCMDWORKSTATION	-H	R	"ComputerName"
SQLCMDDBNAME	-d	R	""
SQLCMDLOGINTIMEOUT	-l	R/W	"8" (segundos)
SQLCMDSTATTIMEOUT	-t	R/W	"0" = espere indefinidamente
SQLCMDHEADERS	-h	R/W	"0"
SQLCMDCOLSEP	-s	R/W	" "
SQLCMDCOLWIDTH	-w	R/W	"0"
SQLCMDPACKETSIZE	-a	R	"4096"
SQLCMDERRORLEVEL	-m	R/W	0
SQLCMDMAXVARTYPEWIDTH	-y	R/W	"256"
SQLCMDMAXFIXEDTYPEWIDTH	-Y	R/W	"0" = ilimitado
SQLCMDEDITOR		R/W	"edit.com"
SQLCMDINI		R	""

SQLCMDUSER, SQLCMDPASSWORD e SQLCMDSERVER são definidos quando :Connect

é usado.

R indica que o valor pode ser definido apenas uma vez durante a inicialização do programa.

R/W indica que o valor pode ser modificado usando o comando setvar e que comandos subsequentes serão influenciados pelo valor novo.

Comandos sqlcmd

Além das instruções do Transact-SQL no sqlcmd, também estão disponíveis os comandos a seguir:

GO [count]	:List
[:] RESET	:Error
[:] ED	:Out
[:] !!	:Perftrace
[:] QUIT	:Connect
[:] EXIT	:On Error
:r	:Help
:ServerList	:XML [ON | OFF]
:Setvar	:Listvar

Lembre-se do seguinte ao usar comandos do sqlcmd:

• Todos os comandos do sqlcmd, exceto GO, devem ser antecedidos de dois pontos (:).

  Importante
  Para manter a compatibilidade com versões anteriores de scripts osql existentes, alguns dos comandos serão reconhecidos sem os dois pontos. Isso é indicado por [:].

• Os comandos do sqlcmd serão reconhecidos apenas se aparecerem no início de uma linha.

• Todos os comandos do sqlcmd não diferenciam maiúsculas de minúsculas.

• Cada comando deve estar em uma linha separada. Um comando não pode ser seguido por uma instrução do Transact-SQL ou por outro comando.

• Comandos são executados imediatamente. Eles não são colocados no buffer de execução como as instruções Transact-SQL.

• Editando comandos

• [:] ED
  Inicie o editor de textos. Esse editor pode ser usado para editar o lote atual do Transact-SQL ou o último lote executado. Para editar o último lote executado, o comando ED deve ser digitado imediatamente depois da execução do último lote.

  O editor de textos é definido pela variável de ambiente SQLCMDEDITOR. O editor padrão é 'Editar.' Para alterar o editor, defina a variável de ambiente SQLCMDEDITOR. Por exemplo, para definir o editor como Microsoft Notepad, no prompt de comando, digite:

  SET SQLCMDEDITOR=notepad

• [:] RESET
  Desmarca o cache de instruções.

• :List
  Imprime o conteúdo do cache de instrução.

• Variáveis

• :Setvar <var> [ "value" ]
  Define as variáveis de script do sqlcmd. Variáveis de script têm o seguinte formato: $(VARNAME).

  Nomes de variáveis não diferenciam maiúsculas de minúsculas.

  Variáveis de script podem ser definidas da seguinte forma:

  • Usando-se implicitamente uma opção de linha de comando. Por exemplo, a opção -l define a variável SQLCMDLOGINTIMEOUT sqlcmd.

  • Explicitamente, usando o comando :Setvar.

  • Definindo uma variável de ambiente antes de executar o sqlcmd.

  Observação
  A opção -X evita que variáveis de ambiente sejam passadas para o sqlcmd.

  Se uma variável definida com :Setvar e uma variável de ambiente tiverem o mesmo nome, a variável definida com :Setvar terá precedência.

  Nomes de variáveis não devem conter caracteres de espaço em branco.

  Nomes de variáveis não podem ter a mesma forma que uma expressão variável, como $ (var).

  Se o valor da cadeia de caracteres da variável de script tiver espaços em branco, use aspas. Se não for especificado um valor para uma variável de script, a variável de script será descartada.

• :Listvar
  Exibe uma lista das variáveis de script definidas atualmente.

  Observação
  Serão exibidas somente variáveis de script definidas pelo sqlcmd e aquelas definidas usando o comando :Setvar.

• Comandos de saída

• :Error < filename **>|STDERR|STDOUT
  Redireciona toda a saída de erro para o arquivo especificado por file name, para stderr ou para stdout. O comando Error pode aparecer várias vezes em um script. Por padrão, saída de erro é enviada para stderr.

  • file name
    Cria e abre um arquivo que receberá a saída. Se o arquivo já existir, será truncado para zero bytes. Se o arquivo não estiver disponível devido a permissões ou outras razões, a saída não será alternada e será enviada ao último destino especificado ou ao destino padrão.

  • STDERR
    Alterna a saída de erro para o fluxo stderr. Se houver redirecionamento, o destino para o qual o fluxo foi redirecionado receberá a saída de erro.

  • STDOUT
    Alterna a saída de erro para o fluxo stdout. Se houver redirecionamento, o destino para o qual o fluxo foi redirecionado receberá a saída de erro.

• :Out < filename >| STDERR| STDOUT
  Cria e redireciona todos os resultados de consulta para o arquivo especificado por file name, para stderr ou para stdout. Por padrão, a saída é enviada para stdout. Se o arquivo já existir, será truncado para zero bytes. O comando Out pode aparecer várias vezes em um script.

• :Perftrace < filename >| STDERR| STDOUT
  Cria e redireciona todas as informações de rastreamento de desempenho para o arquivo especificado por file name, para stderr ou para stdout. Por padrão a saída de rastreamento de desempenho é enviada para stdout. Se o arquivo já existir, será truncado para zero bytes. O comando Perftrace pode aparecer várias vezes em um script.

• Comandos de controle de execução

• :On Error[ exit | ignore]
  Define a ação a ser executada no caso de um erro durante a execução de script ou em lote.

  Quando a opção exit é usada, o sqlcmd é fechado com o valor de erro adequado.

  Quando é usada a opção ignore, o sqlcmd ignora o erro e continua executando o lote ou script. Por padrão, será impressa uma mensagem de erro.

• [:] QUIT
  Faz com que o sqlcmd seja encerrado.

• [:] EXIT[ (statement) ]
  Permite usar o resultado de uma instrução SELECT como o valor de retorno do sqlcmd. Se numérico, a primeira coluna da última linha do resultado será convertida em um inteiro de 4 bytes (longo). O MS-DOS transmite o byte baixo para o processo pai ou nível de erro do sistema operacional. O Windows 200x passa todo o número inteiro de 4 bytes. A sintaxe é:

  :EXIT(query)

  Por exemplo:

  :EXIT(SELECT @@ROWCOUNT)

  É possível incluir também o parâmetro EXIT como parte de um arquivo em lote. Por exemplo, no prompt de comando, digite:

  sqlcmd -Q "EXIT(SELECT COUNT(*) FROM '%1')"

  O utilitário sqlcmd envia tudo entre os parênteses ( ) para o servidor. Se um procedimento armazenado de sistema selecionar um conjunto e retornar um valor, somente a seleção será retornada. A instrução EXIT**(** ) com nada entre os parênteses executa tudo antes dela no lote e então é encerrada sem um valor de retorno.

  Quando é especificada uma consulta incorreta, o sqlcmd é encerrado sem um valor de retorno.

  Eis uma lista de formatos EXIT:

  • :EXIT

  Não executa o lote e então sai imediatamente e não retorna valor algum.

  • :EXIT( )

  Executa o lote e então sai imediatamente e não retorna valor algum.

  • :EXIT(query)

  Executa o lote que inclui a consulta, e então sai depois de retornar os resultados da consulta.

  Se for usado RAISERROR em um script sqlcmd e ocorrer um estado 127, o sqlcmd sairá e retornará a ID da mensagem para o cliente. Por exemplo:

  RAISERROR(50001, 10, 127)

  Esse erro fará com que o script do sqlcmd seja encerrado e retorne a ID de mensagem 50001 ao cliente.

  Os valores de retorno -1 a -99 são reservados pelo SQL Server; sqlcmd define os seguintes valores de retorno adicionais:

  Valores de retorno	Descrição
  -100	Erro encontrado antes da seleção do valor de retorno.
  -101	Nenhuma linha encontrada ao se selecionar o valor de retorno.
  -102	Erro de conversão ao selecionar valor de retorno.

• GO [count]
  GO sinaliza tanto o término de um lote quanto a execução de qualquer instrução de cachê do Transact-SQL. Ao especificar um valor para count, serão executadas as instruções de cache count vezes, como um único lote.

• Comandos diversos

• :r < filename >
  Analisa instruções Transact-SQL adicionais e comandos do sqlcmd do arquivo especificado por <filename>* *no cache de instruções.

  Se o arquivo contiver instruções Transact-SQL que não são seguidas por GO, digite GO na linha que segue :r.

  Observação
  <filename> é lido em relação ao diretório de inicialização no qual o sqlcmd foi executado.

  O arquivo será lido e executado depois que for encontrado um terminador de lote. Podem ser emitidos vários comandos :r. O arquivo pode incluir qualquer comando sqlcmd. Isso inclui o terminador de lote GO.

  Observação
  A contagem de linha que é exibida em modo interativo será aumentada em um para cada comando :r encontrado. O comando :r aparecerá na saída do comando de lista.

• :Serverlist
  Lista os servidores configurados localmente e os nomes dos servidores que estão transmitindo na rede.

• :Connect server_name[**\**instance_name] [-l timeout] [-U user_name [-P password]]
  Conecta-se a uma instância do SQL Server. Além disso fecha a conexão atual.

  Opções de tempo limite:

  0	esperar
  n>0	esperar por n segundos

  A variável de script SQLCMDSERVER refletirá a conexão ativa atual.

  Se não for especificado timeout, o valor da variável SQLCMDLOGINTIMEOUT será o padrão.

  Se for especificado apenas user_name (como opção, ou como uma variável de ambiente), o usuário será solicitado a digitar uma senha. Isso não ocorre se as variáveis de ambiente SQLCMDUSER ou SQLCMDPASSWORD tiverem sido definidas. Se as opções e as variáveis de ambiente não forem fornecidas, o modo de Autenticação do Windows será usado para fazer logon. Por exemplo, para conectar-se a uma instância, instance1, do SQL Server, myserver, usando segurança integrada você usaria o seguinte:

  :connect myserver\instance1

  Para conectar-se à instância padrão do myserver usando variáveis de script, você usaria o seguinte:

  :setvar myusername test

  :setvar myservername myserver

  :connect $(myservername) $(myusername)

• [:] !!< command>
  Executa comandos de sistema operacional. Para executar um comando do sistema operacional, inicie uma linha com dois pontos de exclamação (!!) seguida pelo comando do sistema operacional. Por exemplo:

  :!! Dir

  Observação
  O comando é executado no computador no qual o sqlcmd está sendo executado.

• :XML [ON | OFF]
  Para obter mais informações, consulte "XML Output Format", posteriormente neste tópico.

• :Help
  Lista comandos do sqlcmd juntamente com uma breve descrição de cada comando.

Nomes de arquivos sqlcmd

Podem ser especificados arquivos de entrada do sqlcmd com a opção -i ou o comando :r. Podem ser especificados arquivos de saída com a opção -o ou com os comandos :Error, :Out e :Perftrace. A seguir algumas diretrizes sobre como trabalhar com esses arquivos:

• :Error, :Out e :Perftrace devem usar <filename> separados. Se for usado o mesmo <filename>, as entradas dos comandos poderão ser misturadas.

• Se for chamado um arquivo de entrada em um servidor remoto do sqlcmd em um computador local e o arquivo tiver um caminho de arquivo de unidade como: c:\OutputFile.txt. O arquivo de saída será criado no computador local e não no servidor remoto.

• Os caminhos de arquivo válidos incluem: C:\<filename>, \\<Servidor>\<Compartilhamento$>\<filename> e "C:\Alguma pasta\<file name>". Se houver um espaço no caminho, use aspas.

• Cada nova sessão do sqlcmd substituirá arquivos existentes que tenham os mesmos nomes.

Mensagens informativas

O sqlcmd imprime qualquer mensagem informativa enviada pelo servidor. No exemplo a seguir, depois que as instruções do Transact-SQL são executadas, é impressa uma mensagem informativa.

No prompt de comando, digite o seguinte:

sqlcmd

At the sqlcmd prompt type:

USE AdventureWorks2012;

GO

Ao pressionar ENTER, será impressa a seguinte mensagem informativa: "Contexto de banco de dados alterado para 'AdventureWorks2012'."

Formato de saída do Transact-SQL Queries

O sqlcmd imprime, em primeiro lugar, um cabeçalho de coluna com os nomes de coluna especificados na lista de seleção. Os nomes de coluna são separados usando-se o caractere SQLCMDCOLSEP. Por padrão, esse é um espaço. Se o nome de coluna for mais curto do que a largura de coluna, a saída será preenchida com espaços até a coluna seguinte.

Essa linha será seguida por uma linha divisória formada por uma série de tracejados. A saída a seguir mostra um exemplo.

Inicie o sqlcmd. No prompt de comando do sqlcmd, digite o seguinte:

USE AdventureWorks2012;

SELECT TOP (2) BusinessEntityID, FirstName, LastName

FROM Person.Person;

GO

Ao pressionar ENTER, o seguinte conjunto de resultados é reajustado.

BusinessEntityID FirstName    LastName

---------------- ------------ ----------

285              Syed         Abbas

293              Catherine    Abel

(2 row(s) affected)

Embora a coluna BusinessEntityID tenha apenas 4 caracteres de largura, ela foi expandida para acomodar o nome de coluna mais longo. Por padrão, a saída é finalizada com 80 caracteres. Isso pode ser alterado usando a opção -w, ou definindo a variável de script SQLCMDCOLWIDTH.

Formato de saída XML

Saída XML é o resultado de uma cláusula FOR XML, não formatada, em um fluxo contínuo.

Quando você esperar uma saída XML, use o seguinte comando: :XML ON.

Observação
O sqlcmd retorna mensagens de erro no formato habitual. Observe que as mensagens de erro também são produzidas no fluxo de texto XML em formato XML. Usando :XML ON, o sqlcmd não exibe mensagens informativas.

Para definir XML em modo off, use o seguinte comando: :XML OFF.

O comando GO não deve aparecer antes de o comando XML OFF ser emitido porque o comando XML OFF retorna o sqlcmd para a saída orientada por linhas.

Dados XML (em fluxo) e dados de conjunto de linhas não podem ser misturados. Se o comando XML ON não tiver sido emitido antes da execução de uma instrução do Transact-SQL que gera protocolos XML, a saída será adulterada. Se o comando XML ON tiver sido emitido, não será possível executar instruções do Transact-SQL que gerem conjuntos de linhas normais.

Observação
O comando :XML não oferece suporte para a instrução SET STATISTICS XML.

Práticas recomendadas sqlcmd

Use as seguintes práticas para ajudar a maximizar a segurança e a eficiência.

• Use segurança integrada.

• Use -X em ambientes automatizados.

• Proteja arquivos de entrada e de saída usando permissões adequadas de sistema de arquivos NTFS.

• Para aumentar o desempenho, faça o máximo possível em uma sessão sqlcmd, em vez de usar uma série de sessões.

• Defina valores mais altos de tempo limite para execução em lote ou de consulta do que você imagina que levará para a execução em lote ou de consulta.

Consulte também

Tarefas

Iniciar o utilitário sqlcmd

Executar arquivos de script Transact-SQL usando sqlcmd

Conectar-se ao Mecanismo de Banco de Dados com sqlcmd

Conceitos

Usar o utilitário sqlcmd

Usar sqlcmd com variáveis de script

Editar scripts SQLCMD com o Editor de Consultas

Gerenciar etapas de trabalho

Criar uma etapa de trabalho CmdExec