DECLARE @local_variable (Transact-SQL)

語法

DECLARE 
     { 
{{ @local_variable [AS] data_type } | [ = value ] }
    | { @cursor_variable_name CURSOR }
} [,...n] 
    | { @table_variable_name [AS] <table_type_definition> | <user-defined table type> } 

<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 資料類型。

  如需有關系統資料類型的詳細資訊，請參閱＜資料類型 (Transact-SQL)＞。如需有關 CLR 使用者自訂類型或別名資料類型的詳細資訊，請參閱＜CREATE TYPE (Transact-SQL)＞。

• = value
  以內嵌方式指派值給變數。此值可以是常數或運算式，但是它必須符合變數宣告類型，或是必須可隱含轉換成該類型。

• @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 (Transact-SQL)＞。

• 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 (Transact-SQL)＞。

• 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 變數陳述式 (在右側)。

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

資料指標變數：

• 可以是資料指標類型或另一個資料指標變數的目標。如需詳細資訊，請參閱＜SET @local\_variable (Transact-SQL)＞。

• 如果資料指標變數目前未指派任何資料指標，就可以在 EXECUTE 陳述式中，將它當做輸出資料指標參數的目標來參考。

• 應該視為指向資料指標的指標。如需有關資料指標變數的詳細資訊，請參閱＜Transact-SQL 資料指標＞。

範例

A. 使用 DECLARE

USE AdventureWorks;
GO
DECLARE @find varchar(30);
/* Also allowed: 
DECLARE @find varchar(30) = 'Man%';
*/
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

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. 宣告資料表類型的變數

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,
    ModifiedDate = GETDATE() 
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.
SELECT TOP (10) EmployeeID, VacationHours, ModifiedDate
FROM HumanResources.Employee;
GO

D. 宣告使用者定義資料表類型的變數

DECLARE @LocationTVP 
AS LocationTableType;

請參閱

參考

概念