使用 sqlcmd 公用程式
更新: 2006 年 7 月 17 日
sqlcmd 公用程式是一個 Microsoft Win32 命令提示字元公用程式,可用來執行特定的互動式 Transact-SQL 陳述式與指令碼,以及用於自動化 Transact-SQL 指令碼工作。若要以互動的方式使用 sqlcmd,或是要建立透過 sqlcmd 執行的指令碼檔案,使用者必須先瞭解 Transact-SQL。sqlcmd 公用程式通常的使用方式如下:
- 使用者可以像是在命令提示字元中工作一般,以互動的方式輸入 Transact-SQL 陳述式。結果會顯示在命令提示字元視窗中。若要開啟 [命令提示字元] 視窗,請按一下 [開始]、按一下 [所有程式]、指向 [附屬應用程式],然後按一下 [命令提示字元]。在命令提示字元中,輸入 sqlcmd,後面接著您要使用的選項清單。如需 sqlcmd 所支援選項的完整清單,請參閱<sqlcmd 公用程式>。
- 使用者可指定要執行的單一 Transact-SQL 陳述式,或者將公用程式指向包含所要執行之 Transact-SQL 陳述式的文字檔,來提交 sqlcmd 工作。輸出通常會導向文字檔,不過,也可以在命令提示字元上顯示。
- SQL Server Management Studio 查詢編輯器中的 SQLCMD 模式。
- SQL Server Management Objects (SMO)
- SQL Server Agent CmdExec 作業
一般使用的 sqlcmd 選項
以下是最常使用的選項:
- 伺服器選項 (-S),識別 sqlcmd 所連接的 Microsoft SQL Server 執行個體。
- 驗證選項 (-E、-U 和 -P),指定供 sqlcmd 用來連接到 SQL Server 執行個體的認證。
附註:
-E 選項是預設值,不需要指定。 - 輸入選項 (-Q、-q 和 -i),識別 sqlcmd 的輸入位置。
- 輸出選項 (-o),指定 sqlcmd 存放其輸出的檔案。
連接到 sqlcmd 公用程式
以下是 sqlcmd 公用程式的一般用途:
使用 Windows 驗證連接到預設執行個體,以互動方式執行 Transact-SQL 陳述式:
sqlcmd -S <ComputerName>
附註:
在上述範例中並未指定 -E,因為它是預設值,而且 sqlcmd 會使用 Windows 驗證連接到預設的執行個體。 使用 Windows 驗證連接到具名執行個體,以互動方式執行 Transact-SQL 陳述式:
sqlcmd -S <ComputerName>\<InstanceName>
或
sqlcmd -S .\<InstanceName>
使用 Windows 驗證,並且指定輸入和輸出檔案,以連接到具名執行個體:
sqlcmd -S <ComputerName>\<InstanceName> -i <MyScript.sql> -o <MyOutput.rpt>
使用 Windows 驗證連接到本機電腦上的預設執行個體、執行查詢,並在查詢完成後讓 sqlcmd 繼續執行:
sqlcmd -q "SELECT * FROM AdventureWorks.Person.Contact"
使用 Windows 驗證連接到本機電腦上的預設執行個體、執行查詢、將輸出導向至檔案,然後在查詢完成後結束 sqlcmd:
sqlcmd -Q "SELECT * FROM AdventureWorks.Person.Contact" -o MyOutput.txt
使用 SQL Server 驗證連接到具名執行個體,以互動方式執行 Transact-SQL 陳述式 (sqlcmd 會提示您輸入密碼):
sqlcmd -U MyLogin -S <ComputerName>\<InstanceName>
附註:
若要查看 sqlcmd 公用程式支援的選項清單,請執行: sqlcmd -?
。
使用 sqlcmd 以互動方式執行 Transact-SQL 陳述式
您可以使用 sqlcmd 公用程式,以互動方式在 [命令提示字元] 視窗中執行 Transact-SQL 陳述式。若要使用 sqlcmd 以互動方式執行 Transact-SQL 陳述式,請執行公用程式,但是不要使用 -Q、-q、-Z 或 -i 選項指定任何輸入檔或查詢。例如:
sqlcmd -S <ComputerName>\<InstanceName>
如果在沒有輸入檔或查詢的情況下執行命令,sqlcmd 會連接到指定的 SQL Server 執行個體,然後顯示新的一行,其中在 1>
後面跟著的閃爍底線,即稱為 sqlcmd 提示字元。1
表示此處是 Transact-SQL 陳述式的第一行,而 sqlcmd 提示字元則是您開始輸入 Transact-SQL 陳述式的位置。
在 sqlcmd 提示字元中,您可以輸入 Transact-SQL 陳述式及 sqlcmd 命令,例如 GO 和 EXIT。每個 Transact-SQL 陳述式會放在稱為陳述式快取的緩衝區中。這些陳述式會在您輸入 GO 命令並按下 ENTER 後,傳送至 SQL Server。若要結束 sqlcmd,請在新行開頭輸入 EXIT 或 QUIT。
若要清除陳述式快取,請輸入 :RESET。輸入 ^C 能使 sqlcmd 結束。在發出 GO 命令後,也可以使用 ^C 來停止執行陳述式快取。
在互動式工作階段中輸入的 Transact-SQL 陳述式可藉由輸入 :ED 命令及 sqlcmd 提示字元進行編輯。此時會開啟編輯器,而在編輯過 Transact-SQL 陳述式並關閉編輯器之後,修訂的 Transact-SQL 陳述式即顯示於命令視窗。請輸入 GO 執行****修訂的 陳述式。
使用引號的字串
系統會直接使用引號括住的字元,而不作額外處理,但是連續輸入兩個引號以將引號插入字串中的情況除外。SQL Server 會將這個字元順序視為一個引號(不過,翻譯動作是在伺服器內進行)。指令碼變數出現於字串時,並不會展開。
例如:
sqlcmd
PRINT "Length: 5"" 7'"
GO
以下為結果集:
Length: 5" 7'
跨越多行的字串
sqlcmd 支援其字串跨越多行的指令碼。例如,下列 SELECT
陳述式雖然跨越多行,但是當您輸入 GO
後按下 ENTER 鍵時,所執行的只是單一的字串。
SELECT First line
FROM Second line
WHERE Third line
GO
互動的 sqlcmd 範例
這是您以互動方式執行 sqlcmd 時所看到的範例。
當您開啟 [命令提示字元] 視窗時,只會出現類似下面這一行:
C:\> _
這表示資料夾 C:\
是目前的資料夾,如果您指定了檔案名稱,則 Windows 將會在該資料夾中尋找這個檔案。
輸入 sqlcmd,連接到本機電腦的 SQL Server 預設執行個體,[命令提示字元] 視窗的內容如下:
C:\>sqlcmd
1> _
這表示您已經連接到 SQL Server 的執行個體,而且 sqlcmd
已經準備好要接受 Transact-SQL 陳述式與 sqlcmd
命令。在 1>
後面的閃爍底線是 sqlcmd
提示字元,標示將顯示您輸入的陳述式與命令的位置。現在請輸入 USE AdventureWorks 並按下 ENTER,然後輸入 GO,再按下 ENTER。[命令提示字元] 視窗的內容將如下所示:
sqlcmd
USE AdventureWorks;
GO
以下為結果集:
Changed database context to 'AdventureWorks'.
1> _
輸入 USE AdventureWorks
之後按下 ENTER,會指示 sqlcmd
開始新的一行。輸入 GO,
之後按下 ENTER,會指示 sqlcmd
將 USE AdventureWorks
陳述式傳送至 SQL Server 的執行個體。sqlcmd
便接著傳回訊息指出 USE
陳述式已順利完成,並且顯示新的 1>
提示字元,表示可以再輸入新的陳述式或命令。
下列範例顯示當您輸入 SELECT
陳述式、再輸入 GO
執行 SELECT
,然後輸入 EXIT
結束 sqlcmd
時,[命令提示字元] 視窗中出現的內容:
sqlcmd
USE AdventureWorks;
GO
SELECT TOP (5) ContactID, FirstName, LastName
FROM Person.Contact;
GO
以下為結果集:
ContactID FirstName LastName
----------- -------------------------------------------------- -----------
1 Syed Abbas
2 Catherine Abel
3 Kim Abercrombie
4 Humberto Acevedo
5 Pilar Ackerman
(5 rows affected)
1> EXIT
C:\>
在 3> GO
這一行後面的那幾行,是 SELECT
陳述式的輸出。產生輸出後,sqlcmd
會重設 sqlcmd
提示字元,並顯示 1>
。在 1>
行輸入 EXIT
之後,[命令提示字元] 視窗會顯示和您初次開啟這個視窗時同樣的一行。這表示 sqlcmd
已經結束其工作階段。您現在可以輸入另一個 EXIT
命令,來關閉 [命令提示字元] 視窗。
使用 sqlcmd 執行 Transact-SQL 指令碼檔案
您可以使用 sqlcmd 來執行資料庫指令碼檔案。指令碼檔案是一個文字檔,其中混合了 Transact-SQL 陳述式、sqlcmd 命令與指令碼變數。如需有關如何編寫指令碼變數的詳細資訊,請參閱<以指令碼變數使用 sqlcmd>。sqlcmd 在指令碼檔案中使用陳述式、命令和指令碼變數的方式,與它使用互動方式輸入陳述式和命令的方式類似。主要的差別在於 sqlcmd 會讀取整個輸入檔而不暫停,而不是等待使用者輸入陳述式、命令和指令碼變數。
建立資料庫指令碼檔案有許多不同的方式:
- 您可以互動方式在 SQL Server Management Studio 中建立一組 Transact-SQL 陳述式並進行偵錯,然後將 [查詢] 視窗的內容儲存為指令碼檔案。
- 您可以使用文字編輯器 (如「記事本」),來建立包含 Transact-SQL 陳述式的文字檔。
範例
A. 使用 sqlcmd 執行指令碼
啟動「記事本」,然後輸入下列 Transact-SQL 陳述式:
USE AdventureWorks;
GO
SELECT TOP (5) ContactID, FirstName, LastName
FROM Person.Contact;
GO
建立名為 MyFolder
的資料夾,然後在資料夾 C:\MyFolder
中將指令碼儲存為檔案 MyScript.sql
。在命令提示字元中輸入下列命令,以執行指令碼並將輸出存放在 MyFolder
的 MyOutput.txt
中:
sqlcmd -i C:\MyFolder\MyScript.sql -o C:\MyFolder\MyOutput.txt
當您在「記事本」中檢視 MyOutput.txt
的內容時,會看到下列項目:
Changed database context to 'AdventureWorks'.
ContactID FirstName LastName
----------- ----------- -----------
1 Syed Abbas
2 Catherine Abel
3 Kim Abercrombie
4 Humberto Acevedo
5 Pilar Ackerman
(5 rows affected)
B. 透過專用管理連接來使用 sqlcmd
在下列範例中,使用 sqlcmd
透過專用管理連接 (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
以下為結果集:
session_id blocking_session_id
---------- -------------------
51 54
(1 rows affected)
使用 sqlcmd
結束封鎖處理序。
1> KILL 54;
2> GO
C. 使用 sqlcmd 執行預存程序
下列範例顯示如何使用 sqlcmd
來執行預存程序。建立下列預存程序。
USE AdventureWorks;
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.Contact
WHERE FirstName = @FirstName
AND LastName = @LastName;
SET NOCOUNT OFF
在 sqlcmd
提示字元中,輸入下列命令:
C:\sqlcmd
1> USE AdventureWorks;
2> GO
1> :Setvar FirstName Gustavo
1> :Setvar LastName Achong
1> EXEC dbo.ContactEmailAddress $(FirstName),$(LastName);
2> GO
EmailAddress
-----------------------------
gustavo0@adventure-works.com
D. 使用 sqlcmd 進行資料庫維護
下列範例顯示如何使用 sqlcmd
進行資料庫維護工作。以下列程式碼建立 C:\BackupTemplate.sql
。
USE master;
BACKUP DATABASE [$(db)] TO DISK='$(bakfile)';
在 sqlcmd
提示字元中,輸入下列命令:
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. 使用 sqlcmd 在多個執行個體上執行程式碼
下列在檔案中的程式碼會顯示連接到兩個執行個體的指令碼。請注意,GO
是在連接第二個執行個體之前出現。
:CONNECT <server>\,<instance1>
EXEC dbo.SomeProcedure
GO
:CONNECT <server>\,<instance2>
EXEC dbo.SomeProcedure
GO
E. 傳回 XML 輸出
下列範例顯示 XML 輸出如何在連續資料流中傳回未格式化的資料。
C:\>sqlcmd -d AdventureWorks
1> :XML ON
1> SELECT TOP 4 FirstName + ' ' + LastName + ', '
2> FROM Person.Contact
3> GO
Gustavo Achong, Catherine Abel, Kim Abercrombie, Humberto Acevedo,
F. 在 Windows 指令碼檔案中使用 sqlcmd
sqlcmd
命令 (例如sqlcmd -i C:\InputFile.txt -o C:\OutputFile.txt,
) 可以在 .bat 檔案中與 VBScript 一起執行。在這種情況下,不要使用互動選項。sqlcmd 必須安裝在執行 .bat 檔案的電腦上。
首先,建立下列四個檔案:
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) @echo off
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
然後,在命令提示字元中執行 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
變更歷程記錄
版本 | 歷程記錄 |
---|---|
2006 年 7 月 17 日 |
|
請參閱
工作
如何:建立 CmdExec 作業步驟 (SQL Server Management Studio)
概念
其他資源
sqlcmd 公用程式
利用查詢編輯器來編輯 SQLCMD 指令碼
sqlcmd 公用程式教學課程