8
0
mirror of https://github.com/FirebirdSQL/firebird.git synced 2025-01-23 00:03:02 +01:00
firebird-mirror/doc/sql.extensions/README.skip_locked.md
Vlad Khorsun 69f8afd178 Fixed DELETE RETURNING handling, update documentation for SKIP LOCKED.
Revert the old way of BLR generation for DELETE RETURNING when SKIP LOCKED is not specified.
2023-11-23 18:55:41 +02:00

1.9 KiB

SKIP LOCKED clause (FB 5.0)

SKIP LOCKED clause can be used with SELECT ... WITH LOCK, UPDATE and DELETE statements.

It makes engine skip records locked by others transactions instead of wait on them or raise conflict errors.

This is very useful to implement work queues where one or more processes post work to a table and issue an event while workers listen for events and read/delete items from the table. Using SKIP LOCKED multiple workers can get exclusive work items from the table without conflicts.

Syntax

SELECT
  [FIRST ...]
  [SKIP ...]
  FROM <sometable>
  [WHERE ...]
  [PLAN ...]
  [ORDER BY ...]
  [{ ROWS ... } | {OFFSET ...} | {FETCH ...}]
  [FOR UPDATE [OF ...]]
  [WITH LOCK [SKIP LOCKED]]
UPDATE <sometable>
  SET ...
  [WHERE ...]
  [PLAN ...]
  [ORDER BY ...]
  [ROWS ...]
  [SKIP LOCKED]
  [RETURNING ...]
DELETE FROM <sometable>
  [WHERE ...]
  [PLAN ...]
  [ORDER BY ...]
  [ROWS ...]
  [SKIP LOCKED]
  [RETURNING ...]

Notes

If statement have both SKIP LOCKED and SKIP/ROWS subclauses, some locked rows could be skipped before SKIP/ROWS subclause would account it, thus skipping more rows than specified in SKIP/ROWS.

Examples

Prepare metadata

create table emails_queue (
    subject varchar(60) not null,
    text blob sub_type text not null
);

set term !;

create trigger emails_queue_ins after insert on emails_queue
as
begin
    post_event('EMAILS_QUEUE');
end!

set term ;!

Sender application or routine

insert into emails_queue (subject, text)
  values ('E-mail subject', 'E-mail text...');
commit;

Client application

Client application can listen to event EMAILS_QUEUE to actually send e-mails using this query:

delete from emails_queue
  rows 10
  skip locked
  returning subject, text;

More than one instance of the application may be running, for example to load balance work.