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 Affero 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   You should have received a copy of the GNU Affero General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18 /**
  19  * @file include/gnunet_db_lib.h
  20  * @brief shared defintions for transactional databases
  21  * @author Christian Grothoff
  22  */
  23 #ifndef GNUNET_DB_LIB_H
  24 #define GNUNET_DB_LIB_H
  25
  26
  27 /**
  28  * Status code returned from functions running database commands.
  29  * Can be combined with a function that returns the number
  30  * of results, so all non-negative values indicate success.
  31  */
  32 enum GNUNET_DB_QueryStatus
  33 {
  34   /**
  35    * A hard error occurred, retrying will not help.
  36    */
  37   GNUNET_DB_STATUS_HARD_ERROR = -2,
  38
  39   /**
  40    * A soft error occurred, retrying the transaction may succeed.
  41    * Includes DEADLOCKS and SERIALIZATION errors.
  42    */
  43   GNUNET_DB_STATUS_SOFT_ERROR = -1,
  44
  45   /**
  46    * The transaction succeeded, but yielded zero results.
  47    * May include the case where an INSERT failed with UNIQUE
  48    * violation (i.e. row already exists) or where DELETE
  49    * failed to remove anything (i.e. nothing matched).
  50    */
  51   GNUNET_DB_STATUS_SUCCESS_NO_RESULTS = 0,
  52
  53   /**
  54    * The transaction succeeded, and yielded one result.
  55    */
  56   GNUNET_DB_STATUS_SUCCESS_ONE_RESULT = 1
  57
  58   /* Larger values may be returned for SELECT statements
  59      that returned more than one result. */
  60
  61 };
  62
  63 #endif