granicus.if.org Git - postgresql/blob - src/include/utils/lockwaitpolicy.h

   1 /*-------------------------------------------------------------------------
   2  * lockwaitpolicy.h
   3  *        Header file for LockWaitPolicy enum.
   4  *
   5  * Copyright (c) 2014, PostgreSQL Global Development Group
   6  *
   7  * src/include/utils/lockwaitpolicy.h
   8  *-------------------------------------------------------------------------
   9  */
  10 #ifndef LOCKWAITPOLICY_H
  11 #define LOCKWAITPOLICY_H
  12
  13 /*
  14  * This enum controls how to deal with rows being locked by FOR UPDATE/SHARE
  15  * clauses (i.e., NOWAIT and SKIP LOCKED clauses).  The ordering here is
  16  * important, because the highest numerical value takes precedence when a
  17  * RTE is specified multiple ways.  See applyLockingClause.
  18  */
  19 typedef enum
  20 {
  21         /* Wait for the lock to become available (default behavior) */
  22         LockWaitBlock,
  23
  24         /* Skip rows that can't be locked (SKIP LOCKED) */
  25         LockWaitSkip,
  26
  27         /* Raise an error if a row cannot be locked (NOWAIT) */
  28         LockWaitError
  29 } LockWaitPolicy;
  30
  31 #endif   /* LOCKWAITPOLICY_H */