sqlcmd 公用程式

更新: 2006 年 7 月 17 日

sqlcmd 公用程式可讓您在命令提示字元之下、在 SQLCMD 模式下的 [查詢編輯器] 中、在 Windows 指令碼檔案中,或是在 SQL Server Agent 作業的作業系統 (Cmd.exe) 作業步驟中,輸入 Transact-SQL 陳述式、系統程序和指令碼檔案。這個公用程式利用 OLE DB 來執行 Transact-SQL 批次。

ms162773.note(zh-tw,SQL.90).gif重要事項:
SQL Server Management Studio 利用 Microsoft .NET Framework SqlClient,在 [查詢編輯器] 中執行正規和 SQLCMD 模式。從命令列執行 sqlcmd 時,sqlcmd 會使用 OLE DB 提供者。由於可能套用不同的預設選項,因此,當您在 SQL Server Management Studio SQLCMD 模式中,以及在 sqlcmd 公用程式中執行相同的查詢時,可能會看到不同的行為。

語法

sqlcmd 
[{ { -U login_id [ -P password ] } | –E trusted connection }] 
[ -z new password ] [ -Z new password and exit]
[ -S server_name [ \ instance_name ] ] [ -H wksta_name ] [ -d db_name ]
[ -l login time_out ] [ -A dedicated admin connection ] 
[ -i input_file ] [ -o output_file ]
[ -f < codepage > | i: < codepage > [ < , o: < codepage > ] ]
[ -u unicode output ] [ -r [ 0 | 1 ] msgs to stderr ] 
[ -R use client regional settings ]
[ -q "cmdline query" ] [ -Q "cmdline query" and exit ] 
[ -e echo input ] [ -t query time_out ] 
[ -I enable Quoted Identifiers ] 
[ -v var = "value"...] [ -x disable variable substitution ]
[ -h headers ][ -s col_separator ] [ -w column_width ] 
[ -W remove trailing spaces ]
[ -k [ 1 | 2 ] remove[replace] control characters ] 
[ -y display_width ] [-Y display_width ]
[ -b on error batch abort ] [ -V severitylevel ] [ -m error_level ] 
[ -a packet_size ][ -c cmd_end ] 
[ -L [ c ] list servers[clean output] ] 
[ -p [ 1 ] print statistics[colon format] ] 
[ -X [ 1 ] ] disable commands, startup script, enviroment variables [and exit] 
[ -? show syntax summary ]

命令列選項

  • 登入相關選項
  • -Ulogin_id
    這是使用者登入識別碼。

    ms162773.note(zh-tw,SQL.90).gif附註:
    OSQLUSER 環境變數可提供回溯相容性。SQLCMDUSER 環境變數的優先順序高於 OSQLUSER 環境變數。這表示您可以先後使用 sqlcmdosql,而不會發生互相干擾的狀況。這也表示現有的 osql 指令碼仍然有效。

    如果沒有指定 -U-P 選項,sqlcmd 便會嘗試利用 Microsoft Windows 驗證模式進行連接。這項驗證以執行 sqlcmd 之使用者的 Windows 帳戶為基礎。

    如果同時使用 -U 選項和 -E 選項 (本主題稍後將進行討論),便會產生錯誤訊息。如果 –U 選項後面有多個引數,便會產生錯誤訊息,程式將會結束。

  • -Ppassword
    這是一個使用者指定的密碼。密碼會區分大小寫。如果使用 -U 選項但未使用 -P 選項,也未設定 SQLCMDPASSWORD 環境變數,sqlcmd 會提示使用者輸入密碼。如果在命令提示字元之下的尾端使用 -P 選項,且沒有密碼,sqlcmd 會使用預設密碼 (NULL)。

    ms162773.security(zh-tw,SQL.90).gif安全性注意事項:
    密碼不能空白。請使用增強式密碼。如需詳細資訊,請參閱<增強式密碼>。

    將密碼提示傳至主控台時,會依照下列方式來顯示密碼提示:Password:

    使用者輸入為隱藏狀態。這表示畫面上不會顯示任何內容,而且游標也不會移動。

    SQLCMDPASSWORD 環境變數可讓您設定目前工作階段的預設密碼。因此,您不需要將密碼寫在批次檔中。

    下列範例會先在命令提示字元之下設定 SQLCMDPASSWORD 變數,再存取 sqlcmd 公用程式。在命令提示字元中,輸入:

    SET SQLCMDPASSWORD= p@a$$w0rd

    ms162773.security(zh-tw,SQL.90).gif安全性注意事項:
    任何能夠見到您的電腦監視器的人,都能夠見到密碼。

    請在下列命令提示字元之下,輸入:

    sqlcmd

    如果使用者名稱和密碼的組合不正確,OLE DB 提供者便會產生錯誤訊息。

    ms162773.note(zh-tw,SQL.90).gif附註:
    保留 OSQLPASSWORD 環境變數的目的,是為了與舊版相容。SQLCMDPASSWORD 環境變數的優先順序比 OSQLPASSWORD 優先順序高;這表示您可以先後使用 sqlcmdosql,它們不會互相干擾,舊的指令碼仍能運作。

    如果同時使用 -P 選項和 -E 選項,便會產生錯誤訊息。

    如果 -P 選項後面有多個引數,便會產生錯誤訊息,程式將會結束。

  • -Etrusted connection
    使用信任連接登入 SQL Server,而不用使用者名稱和密碼。根據預設,如果沒有指定 -E,sqlcmd 都會使用信任連接選項。

    -E 選項會忽略可能出現的使用者名稱和密碼環境變數設定,例如 SQLCMDPASSWORD。如果同時使用 -E 選項和 -U 選項或 -P 選項,便會產生一則錯誤訊息。

  • -znew password
    變更密碼:

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

  • -Znew password and exit
    變更密碼並結束:

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

  • -Sserver_name [ **\**instance_name ]
    指定要連接的 SQL Server 執行個體。它會設定 sqlcmd 指令碼變數 SQLCMDSERVER。

    指定 server_name 來連接到該伺服器電腦上的 SQL Server 預設執行個體。指定 server_name [ **\**instance_name ] 來連接到該伺服器電腦上的 SQL Server 具名執行個體。如果未指定任何伺服器電腦,sqlcmd 會連接本機電腦中的 SQL Server 預設執行個體。當您從網路中的遠端電腦執行 sqlcmd 時,需要這個選項。

    如果您啟動 sqlcmd 時,並未指定 server_name [ **\**instance_name ],SQL Server 會檢查和使用 SQLCMDSERVER 環境變數。

    ms162773.note(zh-tw,SQL.90).gif附註:
    保留 OSQLSERVER 環境變數的目的,是為了與舊版相容。SQLCMDSERVER 環境變數的優先順序比 OSQLSERVER 優先順序高;這表示您可以先後使用 sqlcmdosql,它們不會互相干擾,舊的指令碼仍能運作。
  • -Hwksta_name
    這是一個工作站名稱。這個選項會設定 sqlcmd 指令碼變數 SQLCMDWORKSTATION。工作站名稱列在 sys.dm_exec_sessions 動態管理檢視的 host_name 資料行中,或可以使用預存程序 sp_who 傳回名稱。如果未指定這個選項,預設值為目前的電腦名稱。這個名稱可用來識別不同的 sqlcmd 工作階段。
  • -ddb_name
    當您啟動 sqlcmd 時發出 USEdb_name 陳述式。這個選項會設定 sqlcmd 指令碼變數 SQLCMDDBNAME。這會指定初始資料庫。預設值為您登入的預設資料庫屬性。如果資料庫不存在,會產生一則錯誤訊息,且會結束 sqlcmd
  • -llogintime_out
    指定在您嘗試連接到伺服器時,OLE DB 提供者之 sqlcmd 登入逾時之前的秒數。這個選項會設定 sqlcmd 指令碼變數 SQLCMDLOGINTIMEOUT。登入 sqlcmd 的預設逾時值是 8 秒。登入逾時值必須是 0 和 65534 之間的數字。如果提供的值不是數字,或不在這個範圍內,sqlcmd 會產生一則錯誤訊息。0 值指定逾時值無限。
  • -Adedicated admin connection
    利用專用管理員連接 (DAC) 來登入 SQL Server。這種連接可用以進行伺服器的疑難排解。這只能使用支援 DAC 的伺服器電腦。如果無法使用 DAC,sqlcmd 會產生一則錯誤訊息,並結束作業。如需有關 DAC 的詳細資訊,請參閱<使用專用管理員連接>。
  • 輸入/輸出選項
  • -iinput_file[***,***input_file2...]
    識別 SQL 陳述式或預存程序的批次所在的檔案。您可以指定多個檔案,它們會依照順序來讀取和處理。檔案名稱之間不能有空格。sqlcmd 會先檢查指定的檔案是否全部存在。如果有一或多個檔案不存在,sqlcmd 會結束作業。-i 和 -Q/-q 為互斥選項。

    路徑範例:

    -i C:\<filename>

    -i \\<Server>\<Share$>\<filename>

    -i "C:\Some Folder\<file name>"

    包含空格的檔案路徑必須用引號括住。

    這個選項可以使用一次以上: -i input_file -i I input_file.

  • -ooutput_file
    識別用來接收 sqlcmd 輸出的檔案。

    如果有指定 -uoutput_file 會以 Unicode 格式儲存。如果檔案名稱無效,便會產生錯誤訊息,並結束 sqlcmdsqlcmd 不支援同時將多個 sqlcmd 處理序寫入相同的檔案中。檔案輸出會損毀或不正確。如需有關檔案格式的詳細資訊,請參閱 -f 參數。如果這個檔案不存在,系統將會建立檔案,並覆寫先前 sqlcmd 工作階段所產生的同名檔案。此處所指定的檔案並不是 stdout 檔案。如果指定 stdout 檔案,則不會使用這個檔案。

    路徑範例:

    -o C:\< filename>

    -o \\<Server>\<Share$>\<filename>

    -o "C:\Some Folder\<file name>"

    包含空格的檔案路徑必須用引號括住。

  • -f < codepage > | i: < codepage > [ <, o: < codepage > ]
    指定輸入和輸出字碼頁。字碼頁碼是一個數值,指定已安裝的 Windows 字碼頁。如需詳細資訊,請參閱<安裝程式中的定序設定>。

    字碼頁轉換規則:

    • 如果未指定字碼頁,則 sqlcmd 會在輸入檔和輸出檔中使用目前的字碼頁,除非輸入檔是 Unicode 檔,否則就不需要轉換。
    • sqlcmd 會自動識別 Big-Endian 和 Little-Endian 的 Unicode 輸入檔。如果已指定 -u 選項,則輸出一律為 Little-Endian Unicode。
    • 如果未指定輸出檔,則輸出字碼頁會是主控台字碼頁。這可讓輸出正確地顯示在主控台上。
    • 假設多個輸入檔都是相同的字碼頁。Unicode 與非 Unicode 的輸入檔可以混合使用。

    在命令提示字元下輸入 chcp,以驗證 Cmd.exe 的字碼頁。

  • -uunicode output
    指定不論 input_file 的格式如何,output_file 均以 Unicode 格式儲存。
  • -r [ 0 | 1] msgs to stderr
    將錯誤訊息輸出重新導向至畫面 (stderr)。如果您沒有指定參數,或指定 0,只會重新導向嚴重性層級 11 (含) 以上的錯誤訊息。如果您指定 1,便會重新導向包括 PRINT 在內的所有錯誤訊息輸出。如果您使用 -o,此選項就沒有作用。根據預設,訊息會傳送至 stdout
  • -Ruse client regional settings
    將 SQL Server OLE DB 提供者設成在將貨幣、日期和時間資料轉換成字元資料時,使用用戶端的地區設定。預設值為伺服器地區設定。
  • 查詢執行選項
  • -q" cmdline query "
    啟動 sqlcmd 時便執行查詢,但查詢執行完成時,sqlcmd 不會結束。可以執行多項以分號分隔的查詢。請依照下列範例所示,利用引號來括住查詢。

    在命令提示字元中,輸入:

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

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

    ms162773.note(zh-tw,SQL.90).gif重要事項:
    請勿在查詢中使用 GO 結束字元。

    如果同時指定 -b 和這個選項,sqlcmd 會發生錯誤,並結束作業。本主題稍後將提供 -b 的說明。

  • **-Q"**cmdline query " and exit
    啟動 sqlcmd 時便執行查詢,然後立即結束 sqlcmd。可以執行多項以分號分隔的查詢。

    請依照下列範例所示,利用引號來括住查詢。

    在命令提示字元中,輸入:

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

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

    ms162773.note(zh-tw,SQL.90).gif重要事項:
    請勿在查詢中使用 GO 結束字元。

    如果同時指定 -b 和這個選項,sqlcmd 會發生錯誤,並結束作業。本主題稍後將提供 -b 的說明。

  • -eecho input
    將輸入指令碼寫入標準的輸出裝置 (stdout) 中。
  • -Ienable Quoted Identifiers
    將 SET QUOTED_IDENTIFIER 連接選項設為 ON。依預設,此選項設定為 OFF。如需詳細資訊,請參閱<SET QUOTED_IDENTIFIER (Transact-SQL)>。
  • -tquerytime_out
    指定命令 (或 SQL 陳述式) 逾時之前的秒數。這個選項會設定 sqlcmd 指令碼變數 SQLCMDSTATTIMEOUT。如果未指定 time_out 值,命令不會逾時。querytime_out 必須是介於 1 到 65535 之間的數字。如果提供的值不是數字,或不在該範圍內,sqlcmd 便會產生錯誤訊息。

    注意:實際逾時值可能與指定的 time_out 值之間有幾秒的差異。

  • -vvar=value[ var=value...]
    建立 sqlcmd 指令碼所能使用的 sqlcmd 指令碼變數。如果值包含空格,請用引號括住該值。您可以指定多個 var="values" 值。如果指定的任何值發生錯誤,sqlcmd 會產生一則錯誤訊息,並結束作業。

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

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

  • -xdisable variable substitution
    使 sqlcmd 忽略指令碼變數。當指令碼所包含的許多 INSERT 陳述式可能含有與一般變數 (例如 $(variable_name)) 相同格式的字串時,這就很有幫助。
  • 格式化選項
  • -hheaders
    指定資料行標頭之間所要列印的資料列數。預設值是每一組查詢結果各列印一次標頭。這個選項會設定 sqlcmd 指令碼變數 SQLCMDHEADERS。請利用 -1 來指定不列印標頭。任何無效的值都會使 sqlcmd 產生錯誤訊息,並結束作業。
  • -scol_separator
    指定資料行分隔字元。預設值是空格。這個選項會設定 sqlcmd 指令碼變數 SQLCMDCOLSEP。若要使用對作業系統有特殊意義的字元,如連字號 (&) 或分號 (;),請用引號 (") 括住該字元。資料行分隔字元可以是任何 8 位元的字元。
  • -wcolumn_width
    指定輸出的螢幕寬度。這個選項會設定 sqlcmd 指令碼變數 SQLCMDCOLWIDTH。資料行寬度必須是大於 8 且小於 65536 的數字。如果指定的資料行寬度不在這個範圍內,sqlcmd 會產生一則錯誤訊息。預設寬度是 80 個字元。當輸出行超出指定的資料行寬度時,它會折行。
  • -Wremove trailing spaces
    這個選項會從資料行中移除尾端的空格。在準備要匯出至另一個應用程式的資料時,請同時使用 -s 選項和這個選項。這個選項不能搭配 -y-Y 選項一起使用。
  • -k [ 1 | 2 ] remove[replace] control characters
    從輸出中移除所有控制字元,如定位字元和新行字元。這會在資料傳回時,保留資料行的格式。如果指定 1,會用單一空格來取代控制字元。如果指定 2,會用單一空格取代連續控制字元。
  • -ydisplay_width
    設定 sqlcmd 指令碼變數 SQLCMDMAXVARTYPEWIDTH。預設值 = 0 (未設定)。這會限制可變長度資料類型的傳回字元數:

    • varchar(max)
    • nvarchar(max)
    • varbinary(max)
    • xml
    • UDT (使用者自訂類型)
    • text
    • ntext
    • image
    ms162773.note(zh-tw,SQL.90).gif附註:
    UDT 可以是固定長度,這會隨著實作情況而不同。如果固定長度 UDT 的長度小於 display_width,傳回的 UDT 值不會受到影響。不過,如果長度超出 display_width,便會截斷輸出。

    如果 display_width 是 0,會在 1 MB 處截斷輸出。您可以使用 :XML ON 命令,以避免輸出遭到截斷。本主題稍後將提供 :XML ON 命令的說明。

    ms162773.note(zh-tw,SQL.90).gif重要事項:
    使用 -y 0 選項時,要非常小心,因為可能會使伺服器和網路出現嚴重的效能問題,這會隨著傳回的資料大小而不同。
  • -Ydisplay_width
    設定 sqlcmd 指令碼變數 SQLCMDMAXFIXEDTYPEWIDTH。預設值為 256。限制下列資料類型的傳回字元數:

    • char,其中 1<n<8000
    • nchar ,其中 1<n<4000
    • varchar(n),其中 1<n<8000
    • nvarchar(n),其中 1<n<4000
    • varbinary(n),其中 1<n<8000
    • sql_variant
  • 錯誤報告選項
  • -b on error batch abort
    指定在發生錯誤時,sqlcmd 結束作業並傳回 DOS ERRORLEVEL 值。當 SQL Server 錯誤訊息的嚴重性層級大於 10 時,傳回 DOS ERRORLEVEL 變數的值是 1;否則,傳回的值是 0。如果除了設定 -b 以外,還設定了 -V 選項,且嚴重性層級低於使用 -V 所設定的值,則 sqlcmd 不會報告發生錯誤。命令提示字元批次檔可以測試 ERRORLEVEL 值,且能夠適當處理錯誤。sqlcmd 不會報告嚴重性層級 10 (參考用訊息) 的錯誤。

    如果 sqlcmd 指令碼包含不正確的命令、語法錯誤,或遺漏指令碼變數,則傳回的 ERRORLEVEL 便是 1。

  • -Vseveritylevel
    指定 sqlcmd 所報告的最低嚴重性層級。當 Transact-SQL 指令碼發生錯誤時,只有在嚴重性層級大於或等於 -V 參數所指定的值時,才會報告嚴重性層級。如果嚴重性層級較低,則報告嚴重性層級 0。預設錯誤層級為 0。命令提示字元批次檔可以測試 ERRORLEVEL 的值,而且能夠適當處理錯誤。
  • -merror_level
    自訂錯誤訊息的顯示畫面。嚴重性在指定層級以上的錯誤,會顯示訊息編號、狀態和錯誤層級。嚴重性在指定層級以下的錯誤,不會顯示任何資訊。請利用 -1 來指定訊息傳回所有標頭,即使參考用訊息也是如此。如果指定了 -1,參數和設定之間不能有空格 (例如 -m-1,而不是 -m-1)。

    這個選項會設定 sqlcmd 指令碼變數 SQLCMDERRORLEVEL,其預設值為 0。

  • 其他選項
  • -apacket_size
    要求不同大小的封包。這個選項會設定 sqlcmd 指令碼變數 SQLCMDPACKETSIZE。packet_size 必須是介於 512 到 32767 之間的值。預設值 = 4096。較大的封包可以增強具有大量 SQL 陳述式的指令碼,在 GO 命令之間的執行效能。您可以要求較大的封包。不過,若要求遭到拒絕,sqlcmd 便會使用伺服器預設封包大小。
  • -ccmd_end
    指定批次結束字元。依預設,在一行中單獨輸入 "GO" 這個字,便會終止命令,並將命令傳給 SQL Server。當您重設批次結束字元時,請勿使用對作業系統有特殊意義的 Transact-SQL 保留關鍵字或字元,即使它們前面附加了反斜線也一樣。
  • -L [ c ] list servers[clean output]
    列出設定在本機的伺服器電腦,以及在網路中進行廣播的伺服器電腦名稱。這個參數不能結合其他參數來使用。能夠列出的最大伺服器電腦數目是 3000。如果伺服器清單因為緩衝區大小而截斷,便會顯示警告訊息。

    ms162773.note(zh-tw,SQL.90).gif附註:
    由於網路廣播的本質,sqlcmd 可能不會收到所有伺服器的及時回應。因此,這個選項每次的引動過程,所傳回的伺服器清單可能各不相同。

    如果指定了選擇性的參數 c,顯示的輸出不會有 Servers: 標頭行,列出的每個伺服器行也都不會有開頭空白。這稱為清除輸出。清除輸出可以增進指令碼語言的處理效能。

  • -p [ 1 ] print statistics[colon format]
    列印每個結果集的效能統計資料。以下是效能統計資料的格式範例:

    Network packet size (bytes): n

    x xact[s]:

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

    其中:

    x = SQL Server 所處理的交易數。

    t1 = 所有交易的總時間。

    t2 = 單一交易的平均時間。

    t3 = 每秒的平均交易數。

    所有時間都以毫秒表示。

    如果指定了選擇性的參數 1,統計資料的輸出格式是用冒號分隔的格式,很容易匯入試算表中,指令碼也很容易處理它。

    如果選擇性的參數是 1 以外的任何值,就會產生錯誤,且 sqlcmd 會結束作業。

  • -X [ 1 ] disable commands, startup script, enviroment variables [and exit]
    停用從批次檔執行 sqlcmd 時,可能會危及系統安全性的命令。仍會辨識停用的命令;sqlcmd 會發出一則警告訊息,並繼續作業。如果指定了選擇性的參數 1sqlcmd 會產生一則錯誤訊息,並結束作業。當使用 -X 選項時,會停用下列命令:

    • ED
    • **!!**command

    如果指定了 -X 選項,您就無法將環境變數傳給 sqlcmd。也無法執行利用 SQLCMDINI 指令碼變數所指定的啟動指令碼。如需有關 sqlcmd 指令碼變數的詳細資訊,請參閱<以指令碼變數使用 sqlcmd>。

  • -? show syntax summary
    顯示 sqlcmd 選項的語法摘要。

備註

您不需要按照語法區段中顯示的順序使用選項。

當傳回多個結果時,sqlcmd 會在批次的各結果集之間,列印一道空白行。另外,當「<x> 個資料列受影響」的訊息不適合執行的陳述式時,便不會出現這則訊息。

若要以互動方式使用 sqlcmd,請在命令提示字元之下輸入 sqlcmd,並指定本主題前面說明的一或多個選項。如需詳細資訊,請參閱<使用 sqlcmd 公用程式>。

ms162773.note(zh-tw,SQL.90).gif附註:
-L-Q-Z-i 等選項會導致 sqlcmd 在執行之後結束

命令列環境 (Cmd.exe) 中之 sqlcmd 命令列的總長度 (包括所有引數和展開的變數),是由 Cmd.exe 的作業系統決定。這個長度會隨著作業系統而不同。若為 Windows Server 2003 和 Windows XP,此長度為 8191;若為 Windows 2000 和 Windows NT4,則此長度為 2047。

變數優先順序 (由高至低)

  1. 系統層級環境變數
  2. 使用者層級環境變數
  3. 執行 sqlcmd 之前,在命令提示字元下設定的命令 Shell (SET X=Y)
  4. sqlcmd-v X=Y
  5. :Setvar X Y
ms162773.note(zh-tw,SQL.90).gif附註:
若要檢視環境變數,請在 [控制台] 中開啟 [系統],然後按一下 [進階] 索引標籤。

sqlcmd 指令碼變數

變數 相關參數 R/W 預設值

SQLCMDUSER

-U

R

""

SQLCMDPASSWORD

-P

--

""

SQLCMDSERVER

-S

R

"DefaultLocalInstance"

SQLCMDWORKSTATION

-H

R

"ComputerName"

SQLCMDDBNAME

-d

R

""

SQLCMDLOGINTIMEOUT

-l

R/W

"8" (秒)

SQLCMDSTATTIMEOUT

-t

R/W

"0" = 永遠等候

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" = 無限制

SQLCMDEDITOR

R/W

"edit.com"

SQLCMDINI

R

""

SQLCMDUSER、SQLCMDPASSWORD 和 SQLCMDSERVER 會在使用 :Connect

時設定。

R 表示在程式初始化期間只能設定該值一次。

R/W 表示可以使用 setvar 命令修改值,且後續的命令會受到新值影響。

sqlcmd 命令

除了 sqlcmd 內的 Transact-SQL 陳述式之外,您也可以使用下列命令:

GO [count]

:List

[:] RESET

:Error

[:] ED

:Out

[:] !!

:Perftrace

[:] QUIT

:Connect

[:] EXIT

:On Error

:r

:Help

:ServerList

:XML [ON | OFF]

:Setvar

:Listvar

使用 sqlcmd 命令時請注意下列事項:

  • 除了 GO,所有 sqlcmd 命令的開頭都必須加上冒號 (:)。
    ms162773.note(zh-tw,SQL.90).gif重要事項:
    為了顧及與現有 osql 指令碼的回溯相容性,將以沒有冒號的形式辨識部分命令。[:] 表示這一點。
  • sqlcmd 命令必須在行首,才能夠辨識。
  • 所有 sqlcmd 命令都不區分大小寫。
  • 每個命令都必須在個別的單行中。命令後面不能有 Transact-SQL 陳述式或另一個命令。
  • 命令會立即執行,不會像 陳述式一樣放在執行緩衝區中。
  • 編輯命令
  • [:] ED
    啟動文字編輯器。您可以利用這個編輯器編輯目前的 Transact-SQL 批次,或上次執行的批次。若要編輯上次執行的批次,在上一個批次執行完成之後,必須立即輸入 ED 命令。

    文字編輯器由 SQLCMDEDITOR 環境變數來定義。預設編輯器是 'Edit'。若要變更編輯器,請設定 SQLCMDEDITOR 環境變數。例如,若要將編輯器設為 Microsoft Notepad,請在命令提示字元之下,輸入:

    SET SQLCMDEDITOR=notepad

  • [:] RESET
    清除陳述式快取。
  • :List
    列印陳述式快取內容。
  • 變數
  • :Setvar <var> [ "value" ]
    定義 sqlcmd 指令碼變數。指令碼變數的格式如下:$(VARNAME)

    變數名稱不區分大小寫。

    指令碼變數可以透過下列幾種方式設定:

    • 隱含地使用命令列選項。例如,-l 選項會設定 SQLCMDLOGINTIMEOUT sqlcmd 變數。
    • 明確地利用 :Setvar 命令。
    • 在您執行 sqlcmd 之前,定義一個環境變數。
    ms162773.note(zh-tw,SQL.90).gif附註:
    -X 選項會讓您無法將環境變數傳給 sqlcmd

    如果使用 :Setvar 所定義的變數和環境變數同名,則以使用 :Setvar 所定義的變數優先。

    變數名稱不能包含空格字元。

    變數名稱的格式不能與變數運算式 (例如 $(var)) 相同。

    如果指令碼變數的字串值包含空格,請用引號括住這個值。如果未指定指令碼變數值,就會卸除指令碼變數。

  • :Listvar
    顯示目前所設定之指令碼變數的清單。

    ms162773.note(zh-tw,SQL.90).gif附註:
    只顯示 sqlcmd 所設定的指令碼變數,以及 :Setvar 命令所設定的指令碼變數。
  • 輸出命令
  • :Error<filename>|STDERR|STDOUT
    將所有錯誤輸出重新導向至 file name 指定的檔案、至 stderr 或至 stdout。在指令碼中,Error 命令可以重複出現。根據預設,錯誤輸出會傳送到 stderr

    • file name
      建立和開啟用來接收輸出的檔案。如果檔案已經存在,它會截斷成零位元組。如果因為權限或其他原因無法使用,就不會切換輸出,輸出會送往最後指定的目的地或預設目的地。
    • STDERR
      將錯誤輸出切換到 stderr 資料流。如果它已重新導向,資料流所重新導向的目標會接收這個錯誤輸出。
    • STDOUT
      將錯誤輸出切換到 stdout 資料流。如果它已重新導向,資料流所重新導向的目標會接收這個錯誤輸出。
  • :Out <filename>| STDERR| STDOUT
    建立並將所有查詢結果重新導向至 file name 指定的檔案、stderrstdout。根據預設,輸出會傳送到 stdout。如果檔案已經存在,它會截斷成零位元組。在指令碼中,Out 命令可以重複出現。
  • :Perftrace <filename>| STDERR| STDOUT
    建立並將所有效能追蹤資訊重新導向至 file name 指定的檔案、stderrstdout。根據預設,效能追蹤輸出會傳送到 stdout。如果檔案已經存在,它會截斷成零位元組。在指令碼中,Perftrace 命令可以重複出現。
  • 執行控制命令
  • :On Error[ exit| ignore]
    設定執行指令碼或批次發生錯誤時所要執行的動作。

    使用 exit 選項時,sqlcmd 會結束作業,並且出現適當的錯誤值。

    使用 ignore 選項時,sqlcmd 會忽略錯誤,繼續執行批次或指令碼。依預設,會列印一則錯誤訊息。

  • [:] QUIT
    使得 sqlcmd 結束作業。
  • [:] EXIT[ (statement) ]
    可讓您使用 SELECT 陳述式的結果做為 sqlcmd 的傳回值。第一個結果資料列的第一個資料行會轉換成 4 位元組的整數 (long)。MS-DOS 會將低位元組傳給父處理序或作業系統錯誤層級。Windows 2000 會傳遞完整的 4 位元組整數。語法如下:

    :EXIT(query)

    例如:

    :EXIT(SELECT @@ROWCOUNT)

    您也可以將 EXIT 參數併入批次檔中。例如,在命令提示字元之下,輸入:

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

    sqlcmd 公用程式會將 () 括號之間的任何內容傳給伺服器。如果系統預存程序選取某一組,傳回某個值,此時只會傳回選取的項目。括號中沒有任何內容的 EXIT**()** 陳述式,會執行批次中在它前面的任何內容,然後結束作業,不傳回任何值。

    指定不正確的查詢時,sqlcmd 會結束作業,不傳回任何值。

    以下是 EXIT 格式清單:

    • :EXIT

    不執行批次,然後立即結束,不傳回任何值。

    • :EXIT( )

    執行批次之後,便結束作業,不傳回任何值。

    • :EXIT(query)

    執行包含查詢的批次,傳回查詢結果之後,便告結束。

    如果在 sqlcmd 指令碼內使用 RAISERROR,並引發 127 狀態,sqlcmd 會結束作業,並將訊息識別碼傳回用戶端。例如:

    RAISERROR(50001, 10, 127)

    這個錯誤會使得 sqlcmd 指令碼結束作業,並將訊息 ID 50001 傳回用戶端。

    SQL Server 保留傳回值 -1 至 -99;sqlcmd 定義了下列其他傳回值:

    傳回值 描述

    -100

    在選取傳回值之前發生錯誤。

    -101

    在選取傳回值時,找不到任何資料列。

    -102

    在選取傳回值時,發生轉換錯誤。

  • GO [count]
    GO 會發出批次結束及執行任何快取的 Transact-SQL 陳述式的信號。指定 count 的值時,快取的陳述式將以單一批次執行 count 次。
  • 其他命令
  • :r<filename>
    <filename>** 指定的檔案中其他 Transact-SQL 陳述式和 sqlcmd 命令,剖析至陳述式快取中。

    如果檔案包含的 陳述式後面沒有 GO,您必須在 :r 後面一行輸入 GO

    ms162773.note(zh-tw,SQL.90).gif附註:
    從執行 sqlcmd 之啟動目錄的相對目錄中讀取 <filename>

    在發現批次結束字元之後,便會讀取和執行這個檔案。您可以發出多個 :r 命令。這個檔案可包含任何 sqlcmd 命令,其中包括批次結束字元 GO

    ms162773.note(zh-tw,SQL.90).gif附註:
    每次發現 :r 命令時,以互動模式顯示的行數便會加 1。:r 命令會出現在 list 命令的輸出中。
  • :Serverlist
    列出設定在本機的伺服器,以及在網路中進行廣播的伺服器名稱。
  • :Connectserver_name[**\**instance_name] [-l timeout] [-U user_name [-P password]]
    連接到 SQL Server 的執行個體。另外,也關閉目前的連接。

    逾時選項:

    0

    永久等候

    n>0

    等候 n 秒

    SQLCMDSERVER 指令碼變數會反映目前作用中的連接。

    如果沒有指定 timeout,預設值就是 SQLCMDLOGINTIMEOUT 變數的值。

    如果只指定 user_name (作為選項,或作為環境變數),則會提示使用者輸入密碼。如果已設定 SQLCMDUSER 或 SQLCMDPASSWORD 環境變數,就不會提示。如果既沒有提供選項,也沒有提供環境變數,就會利用 Windows 驗證模式來登入。例如,若要利用整合式安全性連接 SQL Server (myserver) 的執行個體 instance1,您將使用下列命令:

    :connect myserver\instance1

    若要利用指令碼變數來連接 myserver 的預設執行個體,您將使用下列命令:

    :setvar myusername test

    :setvar myservername myserver

    :connect $(myservername) $(myusername)

  • [:] !!< command>
    執行作業系統命令。若要執行作業系統命令,請在行首輸入兩個驚歎號 (!!),後面再接著作業系統命令。例如:

    :!! Dir

    ms162773.note(zh-tw,SQL.90).gif附註:
    這個命令會在執行 sqlcmd 的電腦上執行。
  • :XML [ON | OFF]
    如需詳細資訊,請參閱本主題稍後的「XML 輸出格式」。
  • :Help
    列出 sqlcmd 命令及各命令的簡短描述。

sqlcmd 檔案名稱

您可以使用 -i 選項或 :r 命令指定 sqlcmd 輸入檔。輸入檔則可以使用 -o 選項或 :Error:Out:Perftrace 命令予以指定。以下列出使用這些檔案的幾項指導方針:

  • :Error:Out:Perftrace 應該使用不同的 <filename>。如果使用相同的 <filename>,指令所產生的輸入可能會混合在一起。
  • 如果從本機電腦的 sqlcmd 呼叫位於遠端電腦的輸入檔,而檔案中包含磁碟機檔案 (例如 :out c:\OutputFile.txt),便會在本機電腦建立輸出檔案,而不是在遠端伺服器建立。
  • 有效的檔案路徑包括:C:\<filename>, \\<Server>\<Share$>\<filename> 和 "C:\Some Folder\<file name>"。如果路徑中有空格,請使用引號。
  • 每個新的 sqlcmd 工作階段都會覆寫現有的同名檔案。

參考用訊息

sqlcmd 會列印伺服器所傳送的任何參考用訊息。在下列範例中,執行 Transact-SQL 陳述式之後,會列印一則參考用訊息。

在命令提示字元中,請輸入下列項目:

sqlcmd

sqlcmd 提示中輸入:

USE AdventureWorks;

GO

當您按 ENTER 鍵時,會出現下列參考用訊息:「已將資料庫內容變更為 'AdventureWorks'」。

Transact-SQL 查詢的輸出格式

sqlcmd 會先列印包含選取清單所指定之資料行名稱的資料行標頭。資料行名稱是以 SQLCMDCOLSEP 字元分隔。根據預設,這是一個空格。如果資料行名稱長度小於資料行寬度,便會在輸出中填補空格直到下一個資料行。

這一行後面會接著一條由虛線字元組成的分隔線。下列輸出顯示一個範例。

啟動 sqlcmd。在 sqlcmd 命令提示字元中,輸入下列命令:

USE AdventureWorks;

SELECT TOP (2) Person.ContactID, FirstName, LastName

FROM Person.Contact;

GO

當您按 ENTER 鍵時,會傳回下列結果集。

ContactID FirstName LastName

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

1 Syed Abbas

2 Catherine Abel

(2 row(s) affected)

雖然 ContactID 資料行的寬度只有 4 個字元,但它已擴充,能夠容納較長的資料行名稱。依預設,輸出的長度最多為 80 個字元。您可以利用 -w 選項或設定 SQLCMDCOLWIDTH 指令碼變數來加以變更。

XML 輸出格式

FOR XML 子句所產生的 XML 輸出,會在連續資料流中以未格式化的形式輸出。

當您希望產生 XML 輸出時,請使用下列命令::XML ON.

ms162773.note(zh-tw,SQL.90).gif附註:
sqlcmd 會以一般格式傳回錯誤訊息。請注意,錯誤訊息也會以 XML 格式輸出至 XML 文字資料流。如果使用 :XML ONsqlcmd 就不會顯示參考用訊息。

若要將 XML 模式設定為關閉,請使用下列命令::XML OFF

在發出 XML OFF 命令之前,不應出現 GO 命令,因為 XML OFF 命令會將 sqlcmd 切換回資料列導向的輸出。

XML (資料流) 資料和資料列集不能混合。如果在執行輸出 XML 資料流的 Transact-SQL 陳述式之前發出 XML ON 命令,輸出會混亂。如果已發出 XML ON 命令,您就不能執行輸出正規資料列集的 Transact-SQL 陳述式。

ms162773.note(zh-tw,SQL.90).gif附註:
:XML 命令不支援 SET STATISTICS XML 陳述式。

sqlcmd 最佳作法

請採用下列作法以提高安全性與效率。

  • 使用整合式安全性。
  • 在自動化環境中使用 -X
  • 利用 NTFS 檔案系統權限保護輸入檔和輸出檔。
  • 為了提高效能,請盡可能在單一 sqlcmd 工作階段中執行所有工作,不要使用一連串的工作階段。
  • 將批次或查詢執行的逾時值,設定成高於您預期執行批次或查詢所需的時間值。

請參閱

其他資源

使用 sqlcmd 公用程式
以指令碼變數使用 sqlcmd
如何:使用 sqlcmd.exe 連接到 Database Engine
利用查詢編輯器來編輯 SQLCMD 指令碼
sqlcmd 公用程式教學課程
建立作業步驟
如何:建立 CmdExec 作業步驟 (SQL Server Management Studio)

說明及資訊

取得 SQL Server 2005 協助