Changes

Jump to navigation Jump to search
1,046 bytes added ,  22:44, 18 August 2017
Please note that:
* Locks ''cannot be synchronized'' between across BaseX instances that run in different JVMs. If concurrent write operations are to be performed, we generally recommend working with the client/server or the HTTP architecture .
* An ''unexpected abort'' of the server during a transaction, caused by a hardware failure or power cut, may lead to an inconsistent database state if a transaction was active at shutdown time. So it is advisable to use the [[Commands#CREATE BACKUP|BACKUP]] command to regularly backup your database. If the worst case occurs, you can try the [[Commands#INSPECT|INSPECT]] command to check if your database has obvious inconsistencies, and use [[Commands#RESTORE|RESTORE]] to restore the last backed up version of the database.
* Subsequent operations (read or write) will be queued until the updating transaction has completed.
Each database has its own queue: An update on database A will not block operations on database B. This is under the premise that it can be statically determined, i.e., before the transaction is evaluated) , which databases will be accessed by a transaction (see [[#Limitations|below]]). The number of maximum parallel transactions can be adjusted with the [[Options#PARALLEL|PARALLEL]] option.
==External Side Effects==With {{Version|8.6}}, locking has been improved:
Access to external resources (files on hard disk* Jobs without database access will never be locked. Globally locking jobs can now be executed in parallel with non-locking jobs.* A {{Option|FAIRLOCK}} option has been added: By default, HTTP requestsread transactions will now be favored, ...) is not controlled by the transaction monitor of BaseX unless specified by and transactions that access no databases can be evaluated even if the usertransactions limit has been reached.
===XQuery Locking Options=Locks==
Custom locks can be acquired By default, access to external resources (files on hard disk, HTTP requests, ...) is not controlled by setting the transaction monitor of BaseX-specific XQuery options {{Code|query:read-lock}} and {{Code|query:write-lock}}. Multiple option declarations may occur in the prolog of a query, but multiple values You can also be separated with commas in a single declaration. These use custom XQuery locks are in another namespace than the database namesto do so: the lock value {{Code|factbook}} will not lock a database named factbook.
These ===Query Options=== * You can declare custom locks via the {{Code|query:read-lock}} and {{Code|query:write-lock}} options in the query prolog.* The value of the option declarations contains the lock string, or multiple ones (separated with commas).* Similar to the internal database locks, write locks block all other operations while read locks allow parallel access.* The internal locks and XQuery locks can co-exist (there will be no conflicts, even if your lock string equals the name of a database that will put read be locked by the transaction manager). In the following two example modules, locks have been added to prevent concurrent write operations on the same file: <pre class="brush:xquery">module namespace read = 'read'foo'', ''bar'' and ''batz'' and a write ; (:~ Read lock on CONFIG key. :)declare option query:read-lock 'CONFIG'quix; declare function read:config() { file:read-text('config.txt':)};</pre>
<pre class="brush:xquery">
declare option querymodule namespace write = 'write'; (:read-~ Write lock "foo,bar";on CONFIG key. :)declare option query:readwrite-lock "batz"'CONFIG'; declare option queryfunction write:file($data) { file:write-lock "quix"text('config.txt', $data)};
</pre>
 
Some explanations:
 
* If a query is parsed that is going to call the <code>read:file</code> function, a read lock will be acquired for the user-defined {{Code|CONFIG}} lock string before query evaluation.
* If <code>write:file</code> is referenced by a query, a write lock on this lock string will be set for this query.
* If a query references <code>write:file</code>, it will be queued until there is no running query left that has {{Code|files}} locked.
* If the writing query will be evaluated, all other queries that will set a {{Code|files}} lock (reading or writing) will have to wait.
 
In practice, it’s often sufficient to only work with (exclusive) write locks.
===Java Modules===
You can consult the query info output (which you find in the [[GUI#Visualizations|Info View]] of the GUI or which you can turn on by setting <code>[[Options#QUERYINFO|QUERYINFO]]</code> to {{Code|true}}) to find out which databases have been locked by a query.
 
===GUI===
 
Database locking is currently disabled if the BaseX GUI is used.
 
==Process Locking==
 
In order to enable locking on global (process) level, the option <code>[[Options#GLOBALLOCK|GLOBALLOCK]]</code> can be set to {{Code|true}}. This can e.g. be done by editing your {{Code|.basex}} file (see [[Options]] for more details). If process locking is active, a process that performs write operations will queue all other operations.
=File-System Locks=
==Update Operations==
During the term of a database update, a locking file {{Code|upd.basex}} will reside in that database directory. If the update fails for some unexpected reason, or if the process is killed ungracefully, this file may will not be deleted. In this case, the database cannot be opened anymore using the default commands, and the message "Database ... is being updated, or update was not completed" will be shown instead.  If the locking file is manually removed, you may be able to reopen the database, but you should be aware that database may have got corrupt due to the interrupted update process, and you should revert to the most recent database backup.
==Database Locks==
To avoid database corruptions that are caused by accidental write operations from different JVMs, a shared lock is requested on the database table file ({{Code|tbl.basex}}) whenever a database is opened. If an update operation is triggered, and if no exclusive lock can be acquired, it will be rejected with the message "Database ... is currently opened by another process.".
Please note that you cannot 100% rely on this mechanism, as it is not possible to synchronize operations across different JVMs. You will be safe when using the client/server or HTTP architecture.
=Changelog=
 
;Version 8.6
* Updated: New {{Option|FAIRLOCK}} option, improved detection of lock patterns.
;Version 7.8
 
* Added: Locks can also be acquired on [[Java Bindings#Locking|Java functions]].
;Version 7.6
 
* Added: database locking introduced, replacing process locking.
;Version 7.2.1
 
* Updated: pin files replaced with shared/exclusive filesystem locking.
;Version 7.2
 
* Added: pin files to mark open databases.
;Version 7.1
 
* Added: update lock files.
 
[[Category:Server]]
[[Category:Internals]]
Bureaucrats, editor, reviewer, Administrators
13,551

edits

Navigation menu