sp_getapplock (Transact-SQL)

語法

sp_getapplock [ @Resource = ] 'resource_name' ,
     [ @LockMode = ] 'lock_mode' 
     [ , [ @LockOwner = ] 'lock_owner' ] 
     [ , [ @LockTimeout = ] 'value' ]
     [ , [ @DbPrincipal = ] 'database_principal' ]
[ ; ]

引數

• [ @Resource = ] 'resource_name'
  這是一個字串，指定用來識別鎖定資源的名稱。應用程式必須確定資源名稱是唯一的。指定的名稱會在內部雜湊成 SQL Server 鎖定管理員所能儲存的值。resource_name 是 nvarchar(255)，沒有預設值。如果資源字串長度超過 nvarchar(255)，便會截斷成 nvarchar(255)。

  resource_name 是以二進位來比較，因此，不論目前資料庫的定序設定為何，都會區分大小寫。

  [!附註]

  取得應用程式鎖定之後，只會擷取純文字中的前 32 個字元，其餘部分會予以雜湊。

• [ @LockMode = ] 'lock_mode'
  這是要取得的特定資源鎖定模式。lock_mode 是 nvarchar(32)，沒有預設值。此值可以是下列其中一項：Shared、Update、IntentShared、IntentExclusive 或 Exclusive。

• [ @LockOwner = ] 'lock_owner'
  這是鎖定的擁有者，也就是要求鎖定時的 lock_owner 值。lock_owner 是 nvarchar(32)。此值可以是 Transaction (預設值) 或 Session。當 lock_owner 值是 Transaction 時，依預設或明確地指定，必須從交易內執行 sp_getapplock。

• [ @LockTimeout = ] 'value'
  這是鎖定逾時值 (以毫秒為單位)。預設值與 @@LOCK_TIMEOUT 傳回的值相同。若要指出在無法立即授與要求時，鎖定要求應該傳回錯誤，而不是等待鎖定，請指定 0。

• [ @DbPrincipal = ] 'database_principal'
  這是擁有資料庫中物件權限的使用者、角色或應用程式角色。函數的呼叫者必須是 database_principal、dbo 或 db_owner 固定資料庫角色的成員，才能夠成功呼叫函數。預設值是 public。

傳回碼值

>= 0 (成功) 或 < 0 (失敗)

備註

資源所設定的鎖定與目前交易或目前工作階段相關聯。當認可或回復交易時，便會釋放與目前交易相關聯的鎖定。當登出工作階段時，便會釋放與工作階段相關聯的鎖定。當因故而關閉伺服器時，便會釋放所有鎖定。

sp_getapplock 所建立的鎖定資源建立在工作階段的目前資料庫中。每項鎖定資源都是用下列各項的合計值來識別的：

• 包含鎖定資源之資料庫的資料庫識別碼。

• @DbPrincipal 參數所指定的資料庫主體。

• @Resource 參數所指定的鎖定名稱。

只有 @DbPrincipal 參數所指定之資料庫主體的成員，才能夠取得指定這個主體的應用程式鎖定。dbo 和 db_owner 角色的成員會隱含地被視為所有角色的成員。

您可以利用 sp_releaseapplock 來明確釋放鎖定。當應用程式針對相同鎖定資源來重複呼叫 sp_getapplock 時，也必須呼叫 sp_releaseapplock 相同次數，以便釋出鎖定。

如果針對相同鎖定資源呼叫了 sp_getapplock 許多次，但有任何要求所指定的鎖定模式與現有的模式不同，資源便會受到兩個鎖定模式的聯合影響。在大部分情況下，這表示鎖定模式會升級成較強的鎖定模式、現有的模式，或新要求的模式。這個較強的鎖定模式會保留到最後釋出鎖定為止，即使鎖定釋出呼叫先發生，也是如此。例如，在下列呼叫順序中，資源會保留 Exclusive 模式，而不是 Shared 模式。

USE AdventureWorks2008R2;
GO
BEGIN TRANSACTION;
DECLARE @result int;
EXEC @result = sp_getapplock @Resource = 'Form1', 
               @LockMode = 'Shared';
EXEC @result = sp_getapplock @Resource = 'Form1', 
               @LockMode = 'Exclusive';
EXEC @result = sp_releaseapplock @Resource = 'Form1';
COMMIT TRANSACTION;
GO

含應用程式鎖定的死結不會回復要求應用程式鎖定的交易。當因為傳回值而可能需要進行任何回復時，您必須手動回復。因此，建議您在程式碼中併入錯誤檢查，以便在傳回某些值 (如 -3) 時，起始 ROLLBACK TRANSACTION 或替代動作。

範例如下：

USE AdventureWorks2008R2;
GO
BEGIN TRANSACTION;
DECLARE @result int;
EXEC @result = sp_getapplock @Resource = 'Form1', 
               @LockMode = 'Exclusive';
IF @result = -3
BEGIN
    ROLLBACK TRANSACTION;
END
ELSE
BEGIN
    EXEC @result = sp_releaseapplock @Resource = 'Form1';
    COMMIT TRANSACTION;
END;
GO

SQL Server 利用目前資料庫識別碼來限定資源。因此，如果執行 sp_getapplock，即使不同資料庫使用相同參數值，結果是不同資源也會有不同的鎖定。

請利用 sys.dm_tran_locks 動態管理檢視或 sp_lock 系統預存程序來檢查鎖定資訊，或利用 SQL Server Profiler 來監視鎖定。

權限

需要 public 角色中的成員資格。

範例

下列範例會在 AdventureWorks2008R2 資料庫的 Form1 資源上，設定與目前交易相關聯的共用鎖定。

USE AdventureWorks2008R2;
GO
BEGIN TRAN;
DECLARE @result int;
EXEC @result = sp_getapplock @Resource = 'Form1', 
               @LockMode = 'Shared';
COMMIT TRAN;
GO

下列範例會將 dbo 指定為資料庫主體。

BEGIN TRAN;
EXEC sp_getapplock @DbPrincipal = 'dbo', @Resource = 'AdventureWorks2008R2', 
     @LockMode = 'Shared';
COMMIT TRAN;
GO

請參閱

參考