sqlcmd – Usar o utilitário

Artigo
07/20/2022
12 minutos para o fim da leitura

Aplica-se a:SQL Server (todas as versões compatíveis) Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure Azure Synapse Analytics Analytics Platform System (PDW)

O sqlcmd é um utilitário de linha de comando para execução interativa ad hoc dos scripts e instruções Transact-SQL, bem como para automatização das tarefas de script do Transact-SQL. Para usar sqlcmd de forma interativa ou para criar arquivos de script a serem executados com sqlcmd, os usuários devem entender sobre Transact-SQL. O utilitário sqlcmd normalmente é usado das seguintes maneiras:

Os usuários inserem instruções Transact-SQL de forma semelhante ao trabalho no prompt de comando. Os resultados são exibidos no prompt de comando. Para abrir uma janela de prompt de comando, digite “cmd” na caixa de pesquisa do Windows e clique em Prompt de comando para abrir. No prompt de comando, digite sqlcmd seguido por uma lista de opções que você deseja. Para obter uma lista completa das opções compatíveis com o sqlcmd, consulte Utilitário sqlcmd.
Os usuários enviam um trabalho sqlcmd especificando uma única instrução Transact-SQL a ser executada ou apontando o utilitário para um arquivo de texto que contenha instruções Transact-SQL a serem executadas. O resultado geralmente é dirigido a um arquivo de texto, mas também pode ser exibido no prompt de comando.
Modo SQLCMD no Editor de Consultas do SQL Server Management Studio.
SQL Server Management Objects (SMO)
Trabalhos do CmdExec do SQL Server Agent.

Opções sqlcmd normalmente usadas

A opção de servidor ( -S) identifica a instância do Microsoft SQL Server com a qual o sqlcmd se conecta.
As opções de autenticação ( -E, -Ue -P) especificam as credenciais que o sqlcmd usa para se conectar à instância do SQL Server. OBSERVAÇÃO: a opção -E é o padrão e não precisa ser especificada.
As opções de entrada ( -Q, -qe -i) identificam o local da entrada para sqlcmd.
A opção de saída ( -o) especifica o arquivo no qual o sqlcmd deve colocar a saída.

Conectar ao utilitário sqlcmd

Conectando-se a uma instância padrão usando a Autenticação do Windows para executar instruções Transact-SQL de forma interativa:
```
sqlcmd -S <ComputerName>  
```
OBSERVAÇÃO: no exemplo anterior, -E não é especificado porque é o padrão e o sqlcmd se conecta à instância padrão usando a Autenticação do Windows.
Conexão com uma instância nomeada usando a Autenticação do Windows para executar instruções Transact-SQL interativamente:
```
sqlcmd -S <ComputerName>\<InstanceName>  
```
ou
```
sqlcmd -S .\<InstanceName>  
```
Conectando-se com uma instância nomeada, usando a Autenticação do Windows e especificando arquivos de entrada e saída:
```
sqlcmd -S <ComputerName>\<InstanceName> -i <MyScript.sql> -o <MyOutput.rpt>  
```
Conectando-se à instância padrão no computador local usando a Autenticação do Windows, executando uma consulta e mantendo sqlcmd em execução até mesmo após a consulta ter sido concluída:
```
sqlcmd -q "SELECT * FROM AdventureWorks2012.Person.Person"  
```
Conectando-se a uma instância padrão no computador local usando a Autenticação do Windows, executando uma consulta, direcionando a saída para um arquivo e fazendo com que o sqlcmd feche após a conclusão da consulta:
```
sqlcmd -Q "SELECT * FROM AdventureWorks2012.Person.Person" -o MyOutput.txt  
```
Conectando-se a uma instância nomeada que usa a Autenticação do SQL Server para executar de forma interativa instruções Transact-SQL, com sqlcmd solicitando uma senha:
```
sqlcmd -U MyLogin -S <ComputerName>\<InstanceName>  
```
DICA! Para consultar uma lista das opções compatíveis com o utilitário sqlcmd , execute: sqlcmd -?.

Executar instruções Transact-SQL interativamente usando o sqlcmd

Você pode usar o utilitário sqlcmd interativamente para executar instruções Transact-SQL em uma janela de Prompt de Comando. Para executar interativamente instruções Transact-SQL usando sqlcmd, execute o utilitário sem usar as opções -Q, -q, -Z ou -i para especificar qualquer arquivo ou consulta de entrada. Por exemplo:

sqlcmd -S <ComputerName>\<InstanceName>

Quando o comando é executado sem arquivos ou consultas de entrada, o sqlcmd se conecta à instância especificada do SQL Server e, em seguida, exibe uma nova linha com um 1> seguido de um sublinhado intermitente, que é conhecido como o prompt do sqlcmd . O 1 significa que esta é a primeira linha de uma instrução Transact-SQL, e o prompt do sqlcmd é o ponto no qual a instrução Transact-SQL iniciará quando ela for digitada.

No prompt do sqlcmd, você pode digitar instruções Transact-SQL e comandos sqlcmd, como GO e EXIT. Cada instrução Transact-SQL é colocada em um buffer denominado cache de instrução. Essas instruções são enviadas ao SQL Server depois que você digita o comando GO e pressiona ENTER. Para sair do sqlcmd, digite EXIT ou QUIT no início de uma nova linha.

Para limpar o cache de instruções, digite :RESET. Digitar ^C encerra o sqlcmd . ^C também pode ser usado para interromper a execução do cache de instruções depois que um comando GO é emitido.

Instruções Transact-SQL inseridas em uma sessão interativa podem ser editadas digitando o comando :ED e o prompt do sqlcmd. O editor será aberto e, após a edição da instrução Transact-SQL e de fechamento do editor, a instrução Transact-SQL revisada aparecerá na janela de comando. Insira GO para executar a instrução Transact-SQL revisada.

Cadeia de caracteres entre aspas

Os caracteres entre aspas são usados sem nenhum pré-processamento adicional, a não ser quando as aspas podem ser inseridas em uma cadeia de caracteres através de duas aspas consecutivas. SQL Server trata esta sequência de caracteres como uma aspa. (Porém, a tradução acontece no servidor.) Não serão expandidas variáveis de script quando elas aparecerem dentro de uma cadeia de caracteres.

Por exemplo:

sqlcmd

PRINT "Length: 5"" 7'";

GO

Este é o conjunto de resultados.

Length: 5" 7'

Cadeias de caracteres que abrangem várias linhas

Osqlcmd é compatível com scripts que têm cadeias de caracteres que abrangem várias linhas. Por exemplo, a seguinte instrução SELECT estende diversas linhas, mas é uma única cadeia de caracteres executada ao pressionar a tecla ENTER, depois de digitar GO.

SELECT First line

FROM Second line

WHERE Third line;

GO

Exemplo interativo do sqlcmd

Este é um exemplo do que você vê ao executar o sqlcmd de modo interativo.

Ao abrir uma janela de prompt de comando, você verá uma linha semelhante a esta:

C:\> _

Isso significa que a pasta C:\ é a pasta atual, e se você especificar um nome de arquivo, o Windows vai procurar o arquivo nessa pasta.

Digite sqlcmd para se conectar à instância padrão do SQL Server no computador local, e o conteúdo da janela Prompt de Comando será:

C:\>sqlcmd

1> _

Isso significa que você se conectou com a instância do SQL Server e o sqlcmd agora está pronto para aceitar as instruções Transact-SQL e os comandos sqlcmd. O sublinhado intermitente que precede o 1> é o prompt sqlcmd que marca o local no qual as instruções e os comandos que você digita serão exibidos. Agora, digite USE AdventureWorks2012 e pressione ENTER; em seguida, digite GO e pressione ENTER. O conteúdo da janela de prompt de comando será:

sqlcmd

USE AdventureWorks2012;

GO

Este é o conjunto de resultados.

Changed database context to 'AdventureWorks2012'.

1> _

Pressionar ENTER depois de inserir USE AdventureWorks2012 sinaliza ao sqlcmd para iniciar uma linha nova. Ao pressionar ENTER após digitar GO, , você sinalizou o sqlcmd para enviar a instrução USE AdventureWorks2012 à instância do SQL Server. sqlcmd retornou uma mensagem para indicar que a instrução USE foi concluída com êxito e exibiu um novo prompt 1> como sinal para inserir uma nova instrução ou comando.

O exemplo a seguir mostra o conteúdo da janela de prompt de comando ao você digitar uma instrução SELECT , uma GO para executar o comando SELECT, e uma EXIT para fechar o sqlcmd:

sqlcmd

USE AdventureWorks2012;

GO

SELECT TOP (3) BusinessEntityID, FirstName, LastName

FROM Person.Person;

GO

Este é o conjunto de resultados.

BusinessEntityID FirstName LastName

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

1 Syed Abbas

2 Catherine Abel

3 Kim Abercrombie

(3 rows affected)

1> EXIT

C:\>

As linhas depois da linha 3> GO são a saída de uma instrução SELECT . Depois que você gerar a saída, o sqlcmd redefine o prompt sqlcmd e exibe 1>. Após digitar EXIT na linha 1>, a janela de prompt de comando exibe a mesma linha, como fez quando você a abriu primeiramente. Isto indica que o sqlcmd encerrou sua sessão. Agora você pode fechar a janela de prompt de comando digitando outro comando EXIT .

Executar arquivos de script Transact-SQL usando o sqlcmd

Você pode usar sqlcmd para executar arquivos de script do banco de dados. Os arquivos de script são arquivos de texto que contêm uma mistura de instruções Transact-SQL, comandos do sqlcmd e variáveis de script. Para obter mais informações sobre como usar variáveis de script, veja Usar sqlcmd com variáveis de script. Osqlcmd funciona com instruções, comandos e variáveis de script em um arquivo de script de modo semelhante ao modo como funciona com instruções e comandos inseridos interativamente. A principal diferença é que o sqlcmd faz a leitura por meio do arquivo de entrada sem pausa, em vez de esperar que um usuário insira as instruções, os comandos e as variáveis de script.

Existem maneiras diferentes de criar arquivos de script de banco de dados:

Você pode criar e depurar interativamente uma série de instruções Transact-SQL no SQL Server Management Studio e, em seguida, salvar o conteúdo da janela de consulta como arquivo de script.
Você pode criar um arquivo de texto que contém instruções Transact-SQL usando um editor de textos, como o Bloco de Notas.

Exemplos

a. Executando um script usando o sqlcmd

Iniciar o Bloco de Notas e digitar as seguintes instruções Transact-SQL:

USE AdventureWorks2012;

GO

SELECT TOP (3) BusinessEntityID, FirstName, LastName

FROM Person.Person;

GO

Criar uma pasta nomeada MyFolder e, em seguida, salvar o script como o arquivo MyScript.sql na pasta C:\MyFolder. Digite a sequência abaixo no prompt de comando para executar o script e colocar a saída em MyOutput.txt , em MyFolder:

sqlcmd -i C:\MyFolder\MyScript.sql -o C:\MyFolder\MyOutput.txt

Ao exibir os conteúdos de MyOutput.txt no Bloco de Notas, você verá o seguinte:

Changed database context to 'AdventureWorks2012'.

BusinessEntityID FirstName LastName

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

1 Syed Abbas

2 Catherine Abel

3 Kim Abercrombie

(3 rows affected)

B. Usando o sqlcmd com uma conexão administrativa dedicada

No exemplo a seguir, sqlcmd é usado para se conectar a um servidor que tem um problema de bloqueio utilizando a conexão de administrador dedicada (DAC).

C:\>sqlcmd -S ServerName -A

1> SELECT session_id, blocking_session_id FROM sys.dm_exec_requests WHERE blocking_session_id <> 0;

2> GO

Este é o conjunto de resultados.

session_id blocking_session_id

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

62 64

(1 rows affected)

Use o sqlcmd para finalizar o processo de bloqueio.

1> KILL 64;

2> GO

C. Usando o sqlcmd para executar um procedimento armazenado

O exemplo a seguir mostra como executar um procedimento armazenado usando o sqlcmd. Criar o seguinte procedimento armazenado.

USE AdventureWorks2012;

IF OBJECT_ID ( ' dbo.ContactEmailAddress, 'P' ) IS NOT NULL

DROP PROCEDURE dbo.ContactEmailAddress;

GO

CREATE PROCEDURE dbo.ContactEmailAddress

(

@FirstName nvarchar(50)

,@LastName nvarchar(50)

)

AS

SET NOCOUNT ON

SELECT EmailAddress

FROM Person.Person

WHERE FirstName = @FirstName

AND LastName = @LastName;

SET NOCOUNT OFF

No prompt sqlcmd , insira o seguinte:

C:\sqlcmd

1> :Setvar FirstName Gustavo

1> :Setvar LastName Achong

1> EXEC dbo.ContactEmailAddress $(FirstName),$(LastName)

2> GO

EmailAddress

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

gustavo0@adventure-works.com

D. Usando o sqlcmd para manutenção do banco de dados

O exemplo a seguir mostra como usar o sqlcmd para uma tarefa de manutenção de banco de dados. Crie C:\BackupTemplate.sql com o seguinte código.

USE master;

BACKUP DATABASE [$(db)] TO DISK='$(bakfile)';

No prompt sqlcmd , insira o seguinte:

C:\ >sqlcmd

1> :connect <server>

Sqlcmd: Successfully connected to server <server>.

1> :setvar db msdb

1> :setvar bakfile c:\msdb.bak

1> :r c:\BackupTemplate.sql

2> GO

Changed database context to 'master'.

Processed 688 pages for database 'msdb', file 'MSDBData' on file 2.

Processed 5 pages for database 'msdb', file 'MSDBLog' on file 2.

BACKUP DATABASE successfully processed 693 pages in 0.725 seconds (7.830 MB/sec)

E. Usando o sqlcmd para executar o código em diversas instâncias

O código a seguir em um arquivo exibe um script que conecta a duas instâncias. Note o GO antes da conexão com a segunda instância.

:CONNECT <server>\,<instance1>

EXEC dbo.SomeProcedure

GO

:CONNECT <server>\,<instance2>

EXEC dbo.SomeProcedure

GO

E. Retornando a saída XML

O exemplo a seguir mostra como a saída XML é retornada sem formatação, em um fluxo contínuo.

C:\>sqlcmd -d AdventureWorks2012

1> :XML ON

1> SELECT TOP 3 FirstName + ' ' + LastName + ', '

2> FROM Person.Person

3> GO

Syed Abbas, Catherine Abel, Kim Abercrombie,

F. Usando o sqlcmd em um arquivo de script do Windows

Um comando sqlcmd, como sqlcmd -i C:\InputFile.txt -o C:\OutputFile.txt, , pode ser executado em um arquivo .bat com o VBScript. Nesse caso, não use opções interativas. Osqlcmd deve ser instalado no computador que está executando o arquivo .bat.

Primeiro, crie os quatro arquivos a seguir:

C:\badscript.sql

SELECT batch_1_this_is_an_error  
GO  
SELECT 'batch #2'  
GO

C:\goodscript.sql

SELECT 'batch #1'  
GO  
SELECT 'batch #2'  
GO

C:\returnvalue.sql
```
:exit(select 100)  
```

C:\windowsscript.bat

@echo off  

echo Running badscript.sql  
sqlcmd -i badscript.sql -b -o out.log  
if not errorlevel 1 goto next1  
echo == An error occurred   

:next1  

echo Running goodscript.sql  
sqlcmd -i goodscript.sql -b -o out.log  
if not errorlevel 1 goto next2  
echo == An error occurred   

:next2  
echo Running returnvalue.sql  
sqlcmd -i returnvalue.sql -o out.log  
echo SQLCMD returned %errorlevel% to the command shell  

:exit

Em seguida, no prompt de comando, execute C:\windowsscript.bat:

C:\>windowsscript.bat

Running badscript.sql

== An error occurred

Running goodscript.sql

Running returnvalue.sql

SQLCMD returned 100 to the command shell

G. Usar sqlcmd para definir a criptografia no Bancos de Dados SQL do Azure

Um sqlcmdpode ser executado em uma conexão com os dados do Banco de Dados SQL para especificar a criptografia e a confiança do certificado. Duas opções do sqlcmdestão disponíveis:

A opção -N é usada pelo cliente para solicitar uma conexão criptografada. Essa opção é equivalente à opção ENCRYPT = truedo ADO.net.
A opção -C é usada pelo cliente para configurá-lo para confiar implicitamente no certificado do servidor e não validá-lo. Essa opção é equivalente à opção TRUSTSERVERCERTIFICATE = truedo ADO.net.

O serviço Banco de Dados SQL não dá suporte a todas as opções de SET disponíveis em uma instância do SQL Server. As opções a seguir emitem um erro quando a opção de SET correspondente é definida como ON ou OFF:

SET ANSI_DEFAULTS
SET ANSI_NULLS
SET REMOTE_PROC_TRANSACTIONS
SET ANSI_NULL_DEFAULT

As opções de SET a seguir não emitem exceções, mas não podem ser usadas. Elas são substituídas:

SET CONCAT_NULL_YIELDS_NULL
SET ANSI_PADDING
SET QUERY_GOVERNOR_COST_LIMIT

Sintaxe

Os exemplos a seguir fazem referência a casos em que as configurações do provedor SQL Server Native Client incluem: ForceProtocolEncryption = False, Trust Server Certificate = No

Conectar usando credenciais do Windows e comunicação criptografada:

SQLCMD -E -N

Conectar usando credenciais do Windows e certificado do servidor confiável:

SQLCMD -E -C