src/include/gnunet_db_lib.h

   1 /*
   2   This file is part of GNUnet
   3   Copyright (C) 2017 GNUnet e.V.
   4
   5   GNUnet is free software: you can redistribute it and/or modify it
   6   under the terms of the GNU General Public License as published
   7   by the Free Software Foundation, either version 3 of the License,
   8   or (at your option) any later version.
   9
  10   GNUnet is distributed in the hope that it will be useful, but
  11   WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   Affero General Public License for more details.
  14 */
  15 /**
  16  * @file include/gnunet_db_lib.h
  17  * @brief shared defintions for transactional databases
  18  * @author Christian Grothoff
  19  */
  20 #ifndef GNUNET_DB_LIB_H
  21 #define GNUNET_DB_LIB_H
  22
  23
  24 /**
  25  * Status code returned from functions running database commands.
  26  * Can be combined with a function that returns the number
  27  * of results, so all non-negative values indicate success.
  28  */
  29 enum GNUNET_DB_QueryStatus
  30 {
  31   /**
  32    * A hard error occurred, retrying will not help.
  33    */
  34   GNUNET_DB_STATUS_HARD_ERROR = -2,
  35
  36   /**
  37    * A soft error occurred, retrying the transaction may succeed.
  38    * Includes DEADLOCKS and SERIALIZATION errors.
  39    */
  40   GNUNET_DB_STATUS_SOFT_ERROR = -1,
  41
  42   /**
  43    * The transaction succeeded, but yielded zero results.
  44    * May include the case where an INSERT failed with UNIQUE
  45    * violation (i.e. row already exists) or where DELETE
  46    * failed to remove anything (i.e. nothing matched).
  47    */
  48   GNUNET_DB_STATUS_SUCCESS_NO_RESULTS = 0,
  49
  50   /**
  51    * The transaction succeeded, and yielded one result.
  52    */
  53   GNUNET_DB_STATUS_SUCCESS_ONE_RESULT = 1
  54
  55   /* Larger values may be returned for SELECT statements
  56      that returned more than one result. */
  57
  58 };
  59
  60 #endif