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