Lock Service
Page Summary
The Lock service in Apps Script prevents concurrent access to sections of code, useful for managing shared resources and preventing collisions.
The LockService class provides methods to get different types of locks: document, script, and user.
The Lock class represents a mutual-exclusion lock and includes methods to check if a lock is acquired, release a lock, and attempt to acquire a lock with or without timing out.
This service allows scripts to prevent concurrent access to sections ofcode. This can be useful when you have multiple users or processes modifying ashared resource and want to prevent collisions.
Classes
| Name | Brief description |
|---|---|
Lock | A representation of a mutual-exclusion lock. |
Lock | Prevents concurrent access to sections of code. |
Lock
Methods
| Method | Return type | Brief description |
|---|---|---|
has | Boolean | Returns true if the lock was acquired. |
release | void | Releases the lock, allowing other processes waiting on the lock to continue. |
try | Boolean | Attempts to acquire the lock, timing out after the provided number of milliseconds. |
wait | void | Attempts to acquire the lock, timing out with an exception after the provided number ofmilliseconds. |
LockService
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Lock|null | Gets a lock that prevents any user of the current document from concurrently running a sectionof code. |
get | Lock | Gets a lock that prevents any user from concurrently running a section of code. |
get | Lock | Gets a lock that prevents the current user from concurrently running a section of code. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.