Skip to content

Commit e6d8db2

Browse files
committed
update readme
1 parent 15546cd commit e6d8db2

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -235,19 +235,16 @@ DDB.locking.SLEEP_TIMEOUT = 0.001 # 1ms, default value
235235
A value of 1 millisecond is good and it is generally not recommended to change it,
236236
but you can still tune it to optimize performance in your use case.
237237

238-
Lock Timeout
238+
239+
Lock aquisition timeout
239240
----------------------------------------------------------------------------------------
240-
When a lock file is older than the lock timeout, it is considered orphaned and will
241-
be removed. This could be the case when your operating terminates a thread or process
242-
while it holds a lock. The timeout can be adjusted:
241+
AQUIRE_LOCK_TIMEOUT specifies the maximum duration to wait for acquiring a lock before
242+
giving up and throwing a timeout error.
243243

244244
```python
245-
DDB.locking.LOCK_TIMEOUT = 30.0 # 30s, default value
245+
DDB.locking.REMOVE_ORPHAN_LOCK_TIMEOUT = 60.0 # 60s, default value
246246
```
247247

248-
Chose a value that is long enough where you know that your database operations will
249-
less than it.
250-
251248

252249
API Reference
253250
========================================================================================

0 commit comments

Comments
 (0)