DECLARE @local_variable (Transact-SQL)

發行項
12/15/2008

更新： 2005 年 12 月 5 日

變數是利用 DECLARE 陳述式宣告在批次或程序的主體中，利用 SET 或 SELECT 陳述式來指派值。資料指標變數可以是利用這個陳述式來宣告，且可以搭配其他與資料指標相關的陳述式來使用。在宣告之後，會將所有變數初始化成為 NULL。

語法

DECLARE 
     {{ @local_variable [AS] data_type } 
    | { @cursor_variable_name CURSOR } 
    | { @table_variable_name [AS] < table_type_definition > } 
     } [ ,...n]

< table_type_definition > ::= 
     TABLE ( { < column_definition > | < table_constraint > } [ ,... ] 
      ) 

< column_definition > ::= 
          column_name { scalar_data_type | AS computed_column_expression }
     [ COLLATE collation_name ] 
     [ [ DEFAULT constant_expression ] | IDENTITY [ ( seed,increment ) ] ] 
     [ ROWGUIDCOL ] 
     [ < column_constraint > ] 

< column_constraint > ::= 
     { [ NULL | NOT NULL ] 
     | [ PRIMARY KEY | UNIQUE ] 
     | CHECK ( logical_expression ) 
     } 

< table_constraint > ::= 
     { { PRIMARY KEY | UNIQUE } ( column_name [ ,... ] ) 
     | CHECK ( search_condition ) 
     }

引數

****@local_variable
這是變數的名稱。變數名稱的開頭必須是 at (@**) 符號。本機變數名稱必須符合識別碼的規則。如需詳細資訊，請參閱＜將識別碼當成物件名稱使用＞。

data_type
這是任何系統提供的 Common Language Runtime (CLR) 使用者自訂類型或別名資料類型。變數不能是 text、ntext 或 image 資料類型。如需有關系統資料類型的詳細資訊，請參閱＜資料類型＞。如需有關 CLR 使用者自訂類型或別名資料類型的詳細資訊，請參閱＜CREATE TYPE (Transact-SQL)＞。

****@cursor_variable_name
這是資料指標變數的名稱。資料指標變數名稱的開頭必須是 at (@**) 符號，且必須符合識別碼的規則。

CURSOR
指定變數是本機資料指標變數。

@table_variable_name
這是 table 類型的變數名稱。變數名稱的開頭必須是 at (@) 符號，且必須符合識別碼的規則。

table_type_definition
定義 table 資料類型。資料表宣告包括資料行定義、名稱、資料類型和條件約束。允許使用的條件約束類型只有 PRIMARY KEY、UNIQUE、NULL 和 CHECK。如果規則或預設定義繫結於別名資料類型，就無法利用別名資料類型來作為資料行純量資料類型。

table_type_definition 是在 CREATE TABLE 中，用來定義資料表的部分資訊。這裡包括元素和必要定義。如需詳細資訊，請參閱＜CREATE TABLE＞。

n
這是一個預留位置，表示可以指定多個變數，且可以指派這些變數的值。當宣告 table 變數時，table 變數必須是 DECLARE 陳述式所宣告的唯一變數。

column_name
這是資料表中之資料行的名稱。

scalar_data_type
指定資料行是一種純量資料類型。

computed_column_expression
這是定義計算資料行值的運算式。它是從運算式中，利用相同資料表中其他資料行計算而得。例如，計算資料行的定義可能是 cost AS price * qty。運算式可以是非計算的資料行名稱、常數、內建函數、變數，或一或多個運算子所連接的這些項目的任何組合。運算式不能是子查詢或使用者自訂函數。運算式不能參考 CLR 使用者自訂類型。

[ COLLATE collation_name ]
指定資料行的定序。collation_name 可以是 Windows 定序名稱或 SQL 定序名稱，只適用於 char、varchar、text、nchar、nvarchar 和 ntext 等資料類型的資料行。若未指定，便會將使用者自訂資料類型的定序指派給這個資料行 (如果資料行是使用者自訂資料類型)，否則，便會指派目前資料庫的定序。

如需有關 Windows 和 SQL 定序名稱的詳細資訊，請參閱＜COLLATE＞。

DEFAULT
指定在插入期間未明確提供值時，提供給資料行的值。除了定義為 timestamp 或含有 IDENTITY 屬性的資料行之外，任何資料行都可以套用 DEFAULT 定義。當卸除資料表時，會移除 DEFAULT 定義。預設值只能使用常數值 (如字元字串)、系統函數 (如 SYSTEM_USER()) 或 NULL。若要維護與舊版 SQL Server 的相容性，您可以將條件約束名稱指派給 DEFAULT。

constant_expression
這是用來作為資料行預設值的常數、NULL 或系統函數。

IDENTITY
指出新資料行是識別資料行。當新資料列加入資料表時，SQL Server 會提供資料行的唯一累加值。識別資料行通常用來結合 PRIMARY KEY 條件約束一起使用，作為資料表的唯一資料列識別碼。IDENTITY 屬性可以指派給 tinyint、smallint、int、decimal(p,0) 或 numeric(p,0) 等資料行。每份資料表都只能建立一個識別資料行。繫結的預設值和 DEFAULT 條件約束，無法搭配識別資料行來使用。您必須同時指定種子和遞增，或同時不指定這兩者。如果同時不指定這兩者，預設值便是 (1,1)。

seed
這是載入資料表的第一個資料列所用的值。

increment
這是加入先前載入的資料列之識別值的累加值。

ROWGUIDCOL
指出新資料行是一個資料列全域唯一識別碼資料行。每份資料表都只能有一個 uniqueidentifier 資料行指定為 ROWGUIDCOL 資料行。ROWGUIDCOL 屬性只能指派給 uniqueidentifier 資料行。

NULL | NOT NULL
這是決定資料行中是否允許使用 NULL 值的關鍵字。

PRIMARY KEY
這是一個條件約束，它利用唯一索引來強制執行一或多個給定資料行的實體完整性。每份資料表都只能建立一個 PRIMARY KEY 條件約束。

UNIQUE
這是一個條件約束，它利用唯一索引來提供一或多個給定資料行的實體完整性。一份資料表可以有多項 UNIQUE 條件約束。

CHECK
這是一個條件約束，藉由限制可能輸入一或多個資料行的值，強制執行範圍完整性。

logical_expression
這是一個傳回 TRUE 或 FALSE 的邏輯運算式。

備註

批次或程序通常會利用變數來作為 WHILE、LOOP 或 IF...ELSE 區塊的計數器。

變數只能用在運算式中，不能用來取代物件名稱或關鍵字。若要建構動態 SQL 陳述式，請使用 EXECUTE。

本機變數的範圍是宣告它的批次。

下列陳述式可以將目前指派了資料指標的資料指標變數當做一項來源來參考：

CLOSE 陳述式。
DEALLOCATE 陳述式。
FETCH 陳述式。
OPEN 陳述式。
定位 DELETE 或 UPDATE 陳述式。
SET CURSOR 變數陳述式 (在右側)。

在所有這些陳述式中，如果參考的資料指標變數存在，但目前未配置資料指標，Microsoft SQL Server 便會產生錯誤。如果所參考的資料指標變數不存在，SQL Server 便會產生其他類型未宣告的變數所產生的相同錯誤。

在資料指標宣告之後，資料指標變數值便不會改變。在 SQL Server 6.5 版和更早的版本中，每次重新開啟資料指標時，都會重新整理變數值。

資料指標變數：

可以是資料指標類型或另一個資料指標變數的目標。如需詳細資訊，請參閱＜SET @local\_variable＞。
如果資料指標變數目前未指派任何資料指標，就可以在 EXECUTE 陳述式中，將它當做輸出資料指標參數的目標來參考。
應該視為指向資料指標的指標。如需有關資料指標變數的詳細資訊，請參閱＜Transact-SQL 資料指標＞。

範例

A. 使用 DECLARE

下列範例會利用名稱為 @find 的本機變數來擷取開頭是 'Man' 的所有姓氏的連絡資訊。

USE AdventureWorks;
GO
DECLARE @find varchar(30);
SET @find = 'Man%';
SELECT LastName, FirstName, Phone
FROM Person.Contact
WHERE LastName LIKE @find;

結果集如下：

LastName            FirstName               Phone                     
-------------------------------------------------- -------------------------------------------------- ------------------------- 
Manchepalli         Ajay                    1 (11) 500 555-0174
Manek               Parul                   1 (11) 500 555-0146
Manzanares          Tomas                   1 (11) 500 555-0178
(3 row(s) affected)

B. 搭配兩個變數來使用 DECLARE

下列範例會擷取在北美銷售地區且年度銷售額至少 $2,000,000 的 Adventure Works Cycles 銷售代表姓名。

USE AdventureWorks;
GO
SET NOCOUNT ON;
GO
DECLARE @Group nvarchar(50), @Sales money;
SET @Group = N'North America';
SET @Sales = 2000000;
SET NOCOUNT OFF;
SELECT FirstName, LastName, SalesYTD
FROM Sales.vSalesPerson
WHERE TerritoryGroup = @Group and SalesYTD >= @Sales;

C. DECLARE 資料表類型的變數

下列範例會建立一個 table 變數來儲存 UPDATE 陳述式的 OUTPUT 子句所指定的值。之後的兩個 SELECT 陳述式會傳回 @MyTableVar 中的值，以及 Employee 資料表中更新作業的結果。請注意，INSERTED.ModifiedDate 資料行中的結果不同於 Employee 資料表中 ModifiedDate 資料行的值。這是因為將 ModifiedDate 值更新成目前日期的 AFTER UPDATE 觸發程序是定義在 Employee 資料表上。不過，從 OUTPUT 傳回的資料行會反映引發觸發程序之前的資料。如需有關使用 OUTPUT 子句的更多範例，請參閱＜OUTPUT 子句 (Transact-SQL)＞。

USE AdventureWorks;
GO
DECLARE @MyTableVar table(
    EmpID int NOT NULL,
    OldVacationHours int,
    NewVacationHours int,
    ModifiedDate datetime);
UPDATE TOP (10) HumanResources.Employee
SET VacationHours = VacationHours * 1.25 
OUTPUT INSERTED.EmployeeID,
       DELETED.VacationHours,
       INSERTED.VacationHours,
       INSERTED.ModifiedDate
INTO @MyTableVar;
--Display the result set of the table variable.
SELECT EmpID, OldVacationHours, NewVacationHours, ModifiedDate
FROM @MyTableVar;
GO
--Display the result set of the table.
--Note that ModifiedDate reflects the value generated by an
--AFTER UPDATE trigger.
SELECT TOP (10) EmployeeID, VacationHours, ModifiedDate
FROM HumanResources.Employee;
GO

請參閱

變更歷程記錄

版本	歷程記錄
2005 年 12 月 5 日	新增內容： computed_column_expression 引數不能參考 CLR 使用者自訂類型。