utilitário sqlcmd

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse AnalyticsPDW (Analytics Platform System)Banco de Dados SQL no Microsoft Fabric

O utilitário do sqlcmd permite que você insira as instruções Transact-SQL, os procedimentos do sistema e os arquivos de script usando vários modos:

• No prompt de comando.
• No Editor de Consulta no modo SQLCMD.
• Em um arquivo de script do Windows.
• Em uma etapa de trabalho do sistema operacional (cmd.exe) de um trabalho do SQL Server Agent.

Variantes do sqlcmd

Há duas variantes de sqlcmd:

• sqlcmd (Go): o go-mssqldb-based sqlcmd, às vezes chamado de go-sqlcmd. Esta versão é uma ferramenta autônoma que você pode baixar independentemente do SQL Server. Ele é executado no Windows, macOS, Linux e em contêineres.

• sqlcmd (ODBC): o sqlcmd alinhado à plataforma, baseado em ODBC, disponível com o SQL Server ou os Utilitários de Linha de Comando da Microsoft e parte do mssql-tools pacote no Linux. Ele também é executado no Windows, macOS, Linux e em contêineres.

Para descobrir qual variante e versão do sqlcmd está instalada em seu sistema, confira a versão instalada do utilitário sqlcmd.

Para obter informações sobre como obter sqlcmd, consulte Baixar e instalar o utilitário sqlcmd.

Suporte a TDS 8.0

A versão prévia do SQL Server 2025 (17.x) apresenta suporte ao TDS 8.0 para o utilitário sqlcmd .

Sintaxe

Usage:
  sqlcmd [flags]
  sqlcmd [command]

Examples:
# Install/Create, Query, Uninstall SQL Server
  sqlcmd create mssql --accept-eula --using https://aka.ms/AdventureWorksLT.bak
  sqlcmd open ads
  sqlcmd query "SELECT @@version"
  sqlcmd delete
# View configuration information and connection strings
  sqlcmd config view
  sqlcmd config cs

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      Modify sqlconfig files using subcommands like "sqlcmd config use-context mssql"
  create      Install/Create SQL Server, Azure SQL, and Tools
  delete      Uninstall/Delete the current context
  help        Help about any command
  open        Open tools (e.g ADS) for current context
  query       Run a query against the current context
  start       Start current context
  stop        Stop current context

Flags:
  -?, --?                  help for backwards compatibility flags (-S, -U, -E etc.)
  -h, --help               help for sqlcmd
      --sqlconfig string   configuration file (default "/Users/<currentUser>/.sqlcmd/sqlconfig")
      --verbosity int      log level, error=0, warn=1, info=2, debug=3, trace=4 (default 2)
      --version            print version of sqlcmd

Use "sqlcmd [command] --help" for more information about a command.

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
   -D
   -e (echo input)
   -E (use trusted connection)
   -f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]
   -g (enable column encryption)
   -G (use Azure Active Directory for authentication)
   -h rows_per_header
   -H workstation_name
   -i input_file
   -I (enable quoted identifiers)
   -j (Print raw error messages)
   -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 screen_width
   -W (remove trailing spaces)
   -x (disable variable substitution)
   -X[1] (disable commands, startup script, environment variables, 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

A tabela a seguir lista as opções de linha de comando disponíveis no sqlcmd e quais sistemas operacionais eles dão suporte.

Opções relacionadas a logon

-A

Aplica-se a: Somente Windows. Não há suporte para Linux e macOS.

Entre no SQL Server com uma DAC (conexão de administrador dedicada). Esse tipo de conexão é usado para solucionar um problema no servidor. Essa conexão funciona apenas com computadores servidor compatíveis com 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 o DAC, consulte a conexão de diagnóstico para administradores de banco de dados. A opção -A não é compatível com a opção -G. Ao se conectar ao Banco de Dados SQL do Azure usando -A, você precisa ser um administrador no SQL Server lógico. O DAC não está disponível para um administrador do Microsoft Entra.

-c

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

Para o utilitário sqlcmd (Go), as seguintes condições também se aplicam:

• Se -N e -C não forem fornecidos, o sqlcmd negociará a autenticação com o servidor sem validar o certificado do servidor.
• Se -N é fornecido, mas -C não é, o sqlcmd requer a validação do certificado do servidor. Um valor false para criptografia ainda pode levar à criptografia do pacote de login.
• Se forem fornecidos -N e -C, o sqlcmd usará seus valores para negociação de criptografia.

-d db_name

Emite uma instrução USE <db_name> ao iniciar o sqlcmd. Essa opção define a variável de script do sqlcmdSQLCMDDBNAME. Esse parâmetro 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 será encerrado.

-d

Interpreta o nome do servidor fornecido para -S como um DSN em vez de um nome de host. Para obter mais informações, consulte o suporte de DSN no sqlcmd e bcp.

-l login_timeout

Especifica o número de segundos antes que um logon do sqlcmd no driver ODBC expire quando você tentar se conectar a um servidor. Essa opção define a variável de script do sqlcmdSQLCMDLOGINTIMEOUT. O tempo limite padrão de logon do sqlcmd é de oito segundos. Ao usar a opção -G para se conectar ao Banco de Dados SQL do Azure ou ao Azure Synapse Analytics e autenticar usando a ID do Microsoft Entra, é recomendável um valor de tempo limite de pelo menos 30 segundos. O tempo limite do logon precisa ser um número entre 0 e 65534. Se o valor fornecido não for numérico ou não estiver nesse intervalo, o sqlcmd vai gerar uma mensagem de erro. 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 uma senha para entrar no SQL Server. Por padrão, sem a especificação de -E , o 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 a opção -U ou -P, uma mensagem de erro será gerada.

-g

Define a configuração de Criptografia de Coluna como Enabled. Para obter mais informações, consulte Always Encrypted. Há suporte apenas para as chaves mestras armazenadas no Repositório de Certificados do Windows. A opção -g exige, no mínimo, o sqlcmd versão 13.1. Para determinar a versão, execute sqlcmd -?.

- G

Essa opção é usada pelo cliente ao se conectar ao Banco de Dados SQL do Azure ou ao Azure Synapse Analytics, para especificar que o usuário está autenticado com a autenticação do Microsoft Entra. Essa opção define a variável de script do sqlcmdSQLCMDUSEAAD = true. A opção -G exige, no mínimo, o sqlcmd versão 13.1. Para determinar a versão, execute sqlcmd -?. Para obter mais informações, consulte Microsoft Entra autenticação para Azure SQL. A opção -A não é compatível com a opção -G.

A opção -G só se aplica ao Banco de Dados SQL do Azure e ao Azure Synapse Analytics.

A Autenticação interativa do Microsoft Entra não tem suporte no Linux nem no macOS. A autenticação integrada do Microsoft Entra requer baixar o Driver ODBC para SQL Server versão 17.6.1 ou superior e um ambiente Kerberos configurado corretamente.

Para obter mais informações sobre a autenticação do Microsoft Entra, consulte Authenticate with Microsoft Entra ID in sqlcmd.

-H workstation_name

Um nome de estação de trabalho. Essa opção define a variável de script do sqlcmdSQLCMDWORKSTATION. O nome da estação de trabalho é listado na coluna hostname da exibição de catálogo sys.sysprocesses e pode ser retornado usando 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 diferentes sessões do sqlcmd .

-j

Imprime mensagens de erro brutas na tela.

-K intenção_do_aplicativo

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 sqlcmd não dará suporte à conectividade com uma réplica secundária em um grupo de disponibilidade. Para obter mais informações, consulte Descarregar carga de trabalho somente leitura para a réplica secundária de um grupo de disponibilidade Always On.

Para obter mais informações, consulte Alta disponibilidade e recuperação de desastre no Linux e no macOS.

-M multisubnet_failover

Sempre especifique -M ao se conectar ao ouvinte do grupo de disponibilidade de um grupo de disponibilidade do SQL Server ou a uma instância de cluster de failover do SQL Server. -M proporciona a detecção mais rápida e a conexão com o servidor (atualmente) ativo. Se -M não estiver especificado, -M estará desativado.

Para obter mais informações, consulte:

• Conectar-se a um ouvinte do grupo de disponibilidade Always On
• Referência para a criação e a configuração de grupos de disponibilidade Always On
• Clustering de Failover e grupos de disponibilidade Always On (SQL Server)
• Descarregar a carga de trabalho somente leitura na réplica secundária de um grupo de disponibilidade Always On

Para obter mais informações, consulte Alta disponibilidade e recuperação de desastre no Linux e no macOS.

-n

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

Para o utilitário sqlcmd (Go), -N usa um valor de cadeia de caracteres que pode ser de true, falseou disable para especificar a opção de criptografia. (default é o mesmo que omitir o parâmetro):

• Se -N e -C não forem fornecidos, o sqlcmd negociará a autenticação com o servidor sem validar o certificado do servidor.

• Se -N é fornecido, mas -C não é, o sqlcmd requer a validação do certificado do servidor. Um valor false para criptografia ainda pode levar à criptografia do pacote de login.

• Se forem fornecidos -N e -C, o sqlcmd usará seus valores para negociação de criptografia.

• No sqlcmd (ODBC), use -F para especificar o nome do host no certificado. Por exemplo:

  sqlcmd -S server01 -Q "SELECT TOP 100 * FROM WideWorldImporters.Sales.Orders" -A -Ns -F server01.adventure-works.com
  

  Observação

  Isso é diferente da chave -F para sqlcmd (Go), que é usada para imprimir resultados usando um formato vertical.

-P senha

Uma senha especificada pelo usuário. As senhas diferenciam maiúsculas de minúsculas. Se a opção -U for usada, a opção -P não será usada e a SQLCMDPASSWORD variável de ambiente não estiver definida, o sqlcmd solicitará uma senha ao usuário. Não recomendamos o uso da senha nula (em branco), mas você pode especificar a senha nula usando um par de aspas duplas contíguas para o valor do parâmetro ("").

Recomendamos usar uma senha forte.

A solicitação de senha é exibida ao imprimir a solicitação 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 permite que você defina uma senha padrão para a sessão atual. Assim, senhas não precisam ser embutidas em código nos arquivos em lote. O exemplo a seguir define primeiro a variável SQLCMDPASSWORD no prompt de comando e acessa o utilitário sqlcmd.

No terminal de comando, digite o seguinte comando. Substitua <password> por uma senha válida.

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

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

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 acompanhada de mais de um argumento e o programa será encerrado.

Uma senha contendo caracteres especiais pode gerar uma mensagem de erro. Você deve fazer o escape de caracteres especiais ao usar -P ou usar a variável de ambiente SQLCMDPASSWORD como alternativa.

No Linux e no macOS, quando usado com a opção -G sem -U, -P especifica um arquivo que contém um token de acesso (v17.8+). O arquivo de token deve estar no formato UTF-16LE (sem BOM).

Tokens de acesso podem ser obtidos por meio de vários métodos. Você deve garantir que o token de acesso esteja correto byte para byte, pois ele é enviado as-is. A seguir está um comando de exemplo que obtém um token de acesso. O comando usa os comandos da CLI do Azure e Linux e salva-os em um arquivo no formato adequado. Se a codificação padrão do sistema ou terminal não for ASCII ou UTF-8, talvez seja necessário ajustar as iconv opções. Garanta a proteção cuidadosa do arquivo resultante e exclua-o quando não for mais necessário.

az account get-access-token --resource https://database.windows.net --output tsv | cut -f 1 | tr -d '\n' | iconv -f ascii -t UTF-16LE > /tmp/tokenFile

-S [protocolo:]servidor[\nome_instância][,porta]

Especifica a instância do SQL Server à qual você deseja se conectar. Ele define a variável de script do sqlcmdSQLCMDSERVER.

Especifique server_name para conectar-se à instância padrão do SQL Server nesse computador servidor. Especifique server_name[\instance_name] para conectar-se a uma instância nomeada do SQL Server nesse computador do servidor. Se nenhum servidor for especificado, o sqlcmd se conectará à instância padrão do SQL Server no computador local. Essa opção é necessária quando você executa o sqlcmd em um computador remoto na rede.

Oprotocolo 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 verifica se há uma variável de ambiente SQLCMDSERVER e usa-a.

O driver ODBC no Linux e no macOS requer -S. O único valor de protocolo válido é tcp.

-U login_id

O nome de logon ou o nome de usuário de banco de dados independente. Para usuários de banco de dados independente, é necessário fornecer a opção de nome de banco de dados (-d).

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

Se a opção -U for usada com a opção -E (descrita adiante neste artigo), uma mensagem de erro será gerada. Será gerada uma mensagem de erro se a opção -U for acompanhada de mais de um argumento e o programa será encerrado.

-z new_password

Altere a senha. Substitua <oldpassword> pela senha antiga e <newpassword> pela nova senha.

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

-Z new_password

Altere a senha e saia. Substitua <oldpassword> pela senha antiga e <newpassword> pela nova senha.

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

Opções de entrada/saída

-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 uma página de código instalada no Windows.

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

• Se nenhuma página de código for especificada, 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 nenhuma conversão é necessária.

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

• Se nenhum arquivo de saída for especificado, a página de código de saída será a página de código de console. Essa abordagem 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.

Insira 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 Transact-SQL ou procedimentos armazenados. Vários arquivos podem ser especificados que são lidos e processados em ordem. Não use espaço entre nomes de arquivos. O sqlcmd verificará primeiro 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 mutualmente exclusivas.

Exemplos de caminho:

-i C:\<filename>
-i \\<Server>\<Share$>\<filename>
-i "C:\Some Folder\<file name>"

Os caminhos de arquivos que contêm espaços devem estar entre aspas.

Essa opção pode ser usada mais de uma vez:

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

-o output_file

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

Se -u for especificado, output_file será armazenado no formato Unicode. Se o nome do arquivo não for válido, uma mensagem de erro será gerada e o sqlcmd será encerrado. O sqlcmd não dá suporte à gravação simultânea de vários processos sqlcmd no mesmo arquivo. A saída de arquivo está corrompida ou é incorreta. A opção -f também é relevante para formatos de arquivo. Esse arquivo será criado se não existir. Um arquivo com o mesmo nome de uma sessão sqlcmd anterior será substituído. O arquivo aqui especificado não é o arquivo stdout. Se um arquivo stdout for especificado, esse arquivo não será usado.

Exemplos de caminho:

-o C:< filename>
-o \\<Server>\<Share$>\<filename>
-o "C:\Some Folder\<file name>"

Os caminhos de arquivos que contêm espaços devem estar 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. Essa opção não terá efeito se você usar -o. Por padrão, mensagens são enviadas para stdout.

-R

Aplicável a: ODBC sqlcmd apenas.

Faz com que o sqlcmd localize colunas numéricas, de moeda, de data e de 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 se output_file é armazenado no 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).

-Eu

Aplicável a: ODBC sqlcmd apenas.

Define a opção de conexão SET QUOTED_IDENTIFIER como ON. A configuração padrão é OFF. Para saber mais, confira SET QUOTED_IDENTIFIER.

-q "consulta de linha de comando"

Executa uma consulta quando o sqlcmd é iniciado, mas não sai do sqlcmd quando a consulta é concluída. Várias consultas delimitadas por ponto-e-vírgula podem ser executadas. Use aspas na consulta, conforme o exemplo a seguir.

No prompt de comando, digite:

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

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

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

Se -b for especificado junto com esta opção, sqlcmd encerra em caso de erro. -b é descrito em outro lugar neste artigo.

-Q "consulta da linha de comando"

Executa uma consulta quando o sqlcmd é iniciado e fecha o sqlcmdimediatamente. Podem ser executadas consultas separadas por múltiplos pontos e vírgulas.

Use aspas na consulta, conforme o exemplo a seguir.

No prompt de comando, digite:

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

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

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

Se -b for especificado junto com esta opção, sqlcmd encerra em caso de erro. -b é descrito em outro lugar neste artigo.

-t query_timeout

Especifica quanto segundos faltam para que um comando (ou instrução Transact-SQL) atinja o tempo limite. Essa opção define a variável de script do sqlcmdSQLCMDSTATTIMEOUT. Se um valor de query_timeout não for especificado, o comando não atingiu o tempo limite. O query_timeout deve ser um número entre 1 e 65534. Se o valor fornecido não for numérico ou não estiver nesse intervalo, o sqlcmd gerará uma mensagem de erro.

-v var = valor [ var = valor... ]

Aplica-se a: Somente Windows. Não há suporte para Linux e macOS.

Cria uma variável de script do sqlcmd que possa ser usada em um script do sqlcmd.

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

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

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

:setvar ColumnName object_id
:setvar TableName sys.objects

SELECT $(ColumnName) FROM $(TableName)

cat a.sql > c.sql
cat b.sql >> c.sql

sqlcmd -S<...> -P<..> -U<..> -I c.sql

-X

Faz com que o sqlcmd ignore variáveis de script. Esse parâmetro é útil quando um script contém muitas instruções INSERT que podem conter cadeias de caracteres que têm o mesmo formato que variáveis regulares, como $(<variable_name>).

Opções de formato

-h headers

Especifica o número de linhas a imprimir entre os cabeçalhos de 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 do sqlcmdSQLCMDHEADERS. Use -1 para especificar que os cabeçalhos não sejam impressos. Qualquer valor inválido faz com que o sqlcmd gere uma mensagem de erro e seja encerrado.

-k [1 | 2]

Remove todos os caracteres de controle, como tabulações e caracteres de nova linha, da saída. Esse parâmetro preserva a formatação de coluna quando os dados são retornados.

• -k remove caracteres de controle.
• -k1 substitui cada caractere de controle por um espaço.
• -k2 substitui caracteres de controle consecutivos por um único espaço.

-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 do sqlcmdSQLCMDCOLSEP. 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 screen_width

Especifica a largura de tela para saída. Essa opção define a variável de script do sqlcmdSQLCMDCOLWIDTH. A largura da coluna precisa ser um número maior que 8 e menor que 65536. Se a largura da coluna especificada não estiver nesse intervalo, o sqlcmd vai 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. Não é possível usar com as opções -y ou -Y.

-y variable_length_type_display_width

Define a variável de script sqlcmdSQLCMDMAXVARTYPEWIDTH. 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
• UDTs (tipos de dados definidos pelo usuário)
• Texto
• ntext
• imagem

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

-Y fixed_length_type_display_width

Define a variável de script sqlcmdSQLCMDMAXFIXEDTYPEWIDTH. O padrão é 0 (ilimitado). Limita o número de caracteres retornado para os tipos de dados a seguir:

• char(n), em que 1 <= n<= 8000
• nchar(n), em que 1 <= n<= 4000
• varchar(n), em que 1 <= n<= 8000
• nvarchar(n), em que 1 <= n<= 4000
• varbinary(n), em que 1 <= n<= 4000
• sql_variant

Opções de relatório de erros

-b

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

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

-m nível_de_erro

Controla quais mensagens de erro são enviadas para 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, incluindo 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 é inválido.

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

-V nível_de_gravidade_do_erro

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 este valor definido por 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 do sqlcmdSQLCMDPACKETSIZE. packet_size precisa 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 Transact-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, os comandos são encerrados e enviados para o SQL Server ao digitar a palavra GO sozinha 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 elas sejam precedidas por uma barra invertida.

-L[c]

Aplica-se a: Somente Windows. Não há suporte para Linux e macOS.

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.

Se o parâmetro opcional c for especificado, a saída aparecerá sem a linha de cabeçalho Servers:, e cada linha de servidor será listada sem espaços à esquerda. Esta apresentação é conhecida como saída limpa. A saída limpa melhora o desempenho de processamento das linguagens de script.

-p[1]

Imprime estatísticas de desempenho para cada conjunto de resultados. A tela a seguir é um exemplo do formato das estatísticas de desempenho:

Network packet size (bytes): n

x xact[s]:

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

Em que:

• x = Número de transações processadas pelo SQL Server.
• t1 = Tempo total para todas as transações.
• t2 = Tempo médio de uma única transação.
• t3 = Número médio de transações por segundo.

Todos os tempos estão em milissegundos.

Se o parâmetro opcional 1 for especificado, o formato de saída das estatísticas estará em formato separado por dois pontos, que poderá 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 os comandos que podem comprometer a segurança do sistema quando o sqlcmd é executado em um arquivo em lotes. 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 vai gerar uma mensagem de erro e será encerrado. Os comandos a seguir são desabilitados quando for usada a opção -X:

• ED
• !!comando

Se for especificada a opção -X, isso impedirá que as variáveis de ambiente sejam transmitidas para o sqlcmd. Isso 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 as variáveis de script do sqlcmd, confira sqlcmd – Usar o sqlcmd com variáveis de script.

-?

Exibe a versão do sqlcmd e um resumo da sintaxe das 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> rows affected não é exibida 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 artigo. Para obter mais informações, consulte Usar sqlcmd.

O tamanho total da linha de comando do sqlcmd no ambiente de comando (por exemplo, cmd.exe ou bash), incluindo todos os argumentos e variáveis expandidas, é aquele determinado pelo sistema operacional subjacente.

Suporte para DSN no sqlcmd e no bcp

Você pode especificar um DSN (nome da fonte de dados) em vez de um nome de servidor no sqlcmd ou bcp -S opção (ou sqlcmd :Connect comando) se especificar -D. -D faz com que sqlcmd ou o bcp conecte-se ao servidor especificado no DSN pela opção -S.

Os DSNs do sistema são armazenados no odbc.ini arquivo no diretório ODBC SysConfigDir (/etc/odbc.ini em instalações padrão). Os DSNs de usuário são armazenados no arquivo .odbc.ini no diretório base do usuário (~/.odbc.ini).

Em sistemas Windows, os DSNs do Sistema e do Usuário são armazenados no registro e gerenciados por meio de odbcad32.exe. bcp e sqlcmd não dão suporte a DSNs de arquivo.

Confira Atributos e palavras-chave de cadeia de conexão e DSN para ver a lista de entradas com suporte do driver.

Em um DSN, somente a DRIVER entrada é necessária, mas para se conectar a um servidor remoto, o sqlcmd ou bcp precisa de um valor no SERVER elemento. Se o SERVER elemento estiver vazio ou não estiver presente no DSN, sqlcmd e bcp tentarão se conectar à instância padrão no sistema local.

Quando você usa bcp em sistemas Windows, o SQL Server 2017 (14.x) e versões anteriores exigem o driver SQL Native Client 11 (sqlncli11.dll), enquanto o SQL Server 2019 (15.x) e versões posteriores exigem o driver do Microsoft ODBC Driver 17 para SQL Server (msodbcsql17.dll).

Se a mesma opção for especificada no DSN e na linha de comando sqlcmd ou bcp , a opção de linha de comando substituirá o valor usado no DSN. Por exemplo, se o DSN tiver uma DATABASE entrada e a linha de comando do sqlcmd incluir -d, o valor passado para -d será usado. Se Trusted_Connection=yes for especificado no DSN, a autenticação Kerberos será usada; o nome de usuário (-U) e a senha (-P), se fornecido, serão ignorados.

Os scripts existentes que invocam isql podem ser modificados para usar o sqlcmd definindo o seguinte alias: alias isql="sqlcmd -D".

Práticas recomendadas do sqlcmd

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

• Use segurança integrada.

• Use -X[1] em ambientes automatizados.

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

• 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 de tempo limite para execução em lote ou consulta maior do que você espera que seja necessário para executar o lote ou a consulta.

Use as seguintes práticas para ajudar a maximizar a exatidão:

• Use o -V 16 para registrar quaisquer mensagens de nível de gravidade 16. As mensagens de gravidade 16 indicam erros gerais que podem ser corrigidos pelo usuário.

• Verifique o código de saída e DOS ERRORLEVEL a variável após a saída do processo. O sqlcmd retorna 0 normalmente, caso contrário ele define o ERRORLEVEL conforme definido por -V. Em outras palavras, ERRORLEVEL não deve ser o mesmo valor que o número de erro relatado pelo SQL Server. O número de erro é um valor específico do SQL Server correspondente à função do sistema @@ERROR. ERRORLEVEL é um valor específico do sqlcmd para indicar porque o sqlcmd foi encerrado e o valor é influenciado pelo argumento da linha de comando -b especificado.

Usar o -V 16 em combinação com a verificação do código de saída e DOS ERRORLEVEL pode ajudar a detectar erros em ambientes automatizados, especialmente portões de qualidade antes de uma versão de produção.

Conteúdo relacionado

• Verificar a versão instalada do utilitário sqlcmd
• Baixar e instalar o utilitário sqlcmd
• Comandos no utilitário sqlcmd
• Usar sqlcmd com variáveis de script
• Início Rápido: Executar imagens de contêiner do SQL Server Linux com o Docker
• Iniciar o utilitário sqlcmd
• Executar o T-SQL de um arquivo de script com sqlcmd
• Usar sqlcmd
• Conectar-se ao SQL Server com sqlcmd
• Editar scripts SQLCMD com o Editor de Consultas
• Criar uma etapa de trabalho CmdExec