通过

sp_getapplock (Transact-SQL)

  • 项目

对应用程序资源设置锁。

主题链接图标 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（失败）

值

结果

0

锁已同时成功授予。

1

在等待释放其他不兼容锁后成功授予锁。

-1

锁请求超时。

-2

锁请求被取消。

-3

选择锁请求作为死锁牺牲品。

-999

指示参数验证或其他调用错误。

注释

对资源设置的锁与当前事务或当前会话相关联。 当事务提交或回滚时，将释放与当前事务相关联的锁。 当会话注销时，将释放与会话相关联的锁。 当服务器因任何原因而关闭时，将释放所有锁。

sp_getapplock 创建的锁资源在会话的当前数据库中创建。 每个锁资源都由下列值的组合值进行标识：

  • 包含锁资源的数据库的数据库 ID。

  • @DbPrincipal 参数中指定的数据库主体。

  • @Resource 参数中指定的锁名。

只有 @DbPrincipal 参数中指定的数据库主体成员才能获取指定该主体的应用程序锁。 dbo 和 db_owner 角色的成员被隐式视为所有角色的成员。

可以使用 sp_releaseapplock 显式释放锁。 如果某个应用程序为同一锁资源多次调用 sp_getapplock，则必须调用 sp_releaseapplock 同样次数才能释放锁。

如果为同一锁资源多次调用 sp_getapplock，但是在所有请求中指定的锁模式与现有模式不同，则对资源的影响将是两个锁模式的联合。 多数情况下，这意味着将锁模式提升为现有模式或新请求模式中更强的模式。 在最终释放锁之前，即使出现锁释放调用，也会一直保持这一更强的模式。 例如，在以下调用顺序中，将以 Exclusive 模式而非 Shared 模式控制资源。

USE AdventureWorks2012;
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 AdventureWorks2012;
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 使用当前数据库 ID 来限定资源。 因此，如果在不同数据库中执行 sp_getapplock，即便使用了相同的参数值，结果仍然是对单独资源使用单独锁。

使用 sys.dm_tran_locks 动态管理视图或 sp_lock 系统存储过程检查锁信息，或使用 SQL Server Profiler 监视锁。

权限

要求具有 public 角色的成员身份。

示例

下面的示例对 AdventureWorks2012 数据库中的资源 Form1 设置共享锁，使其与当前事务相关联。

USE AdventureWorks2012;
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 = 'AdventureWorks2012', 
     @LockMode = 'Shared';
COMMIT TRAN;
GO

请参阅

参考

APPLOCK_MODE (Transact-SQL)

APPLOCK_TEST (Transact-SQL)

sp_releaseapplock (Transact-SQL)