1
0
Fork 0
arangodb/VocBase/voc-error.h

303 lines
11 KiB
C

////////////////////////////////////////////////////////////////////////////////
/// @brief vocbase error codes
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2012 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Jan Steemann
/// @author Copyright 2012, triagens GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef TRIAGENS_DURHAM_VOC_VOCBASE_VOC_ERROR_H
#define TRIAGENS_DURHAM_VOC_VOCBASE_VOC_ERROR_H 1
#ifdef __cplusplus
extern "C" {
#endif
////////////////////////////////////////////////////////////////////////////////
/// @page AvocadoErrors Error codes and meanings
///
/// The following errors might be raised when running AvocadoDB:
///
/// @section AvocadoGeneralErrors General errors
///
/// - @copydoc TRI_VOC_ERROR_ILLEGAL_STATE
/// - @copydoc TRI_VOC_ERROR_SHAPER_FAILED
/// - @copydoc TRI_VOC_ERROR_CORRUPTED_DATAFILE
/// - @copydoc TRI_VOC_ERROR_MMAP_FAILED
/// - @copydoc TRI_VOC_ERROR_MSYNC_FAILED
/// - @copydoc TRI_VOC_ERROR_NO_JOURNAL
/// - @copydoc TRI_VOC_ERROR_DATAFILE_SEALED
/// - @copydoc TRI_VOC_ERROR_CORRUPTED_COLLECTION
/// - @copydoc TRI_VOC_ERROR_UNKNOWN_TYPE
/// - @copydoc TRI_VOC_ERROR_ILLEGAL_PARAMETER
/// - @copydoc TRI_VOC_ERROR_INDEX_EXISTS
/// - @copydoc TRI_VOC_ERROR_CONFLICT
/// - @copydoc TRI_VOC_ERROR_WRONG_PATH
/// - @copydoc TRI_VOC_ERROR_CANNOT_RENAME
/// - @copydoc TRI_VOC_ERROR_WRITE_FAILED
/// - @copydoc TRI_VOC_ERROR_READ_ONLY
/// - @copydoc TRI_VOC_ERROR_DATAFILE_FULL
/// - @copydoc TRI_VOC_ERROR_FILESYSTEM_FULL
/// - @copydoc TRI_VOC_ERROR_READ_FAILED
/// - @copydoc TRI_VOC_ERROR_FILE_NOT_FOUND
/// - @copydoc TRI_VOC_ERROR_FILE_NOT_ACCESSIBLE
/// - @copydoc TRI_VOC_ERROR_DOCUMENT_NOT_FOUND
///
/// @section AvocadoQueryErrors Query errors
///
/// The following errors might be raised during query execution:
///
/// - @copydoc TRI_ERROR_QUERY_OOM
/// - @copydoc TRI_ERROR_QUERY_KILLED
/// - @copydoc TRI_ERROR_QUERY_PARSE
/// - @copydoc TRI_ERROR_QUERY_EMPTY
/// - @copydoc TRI_ERROR_QUERY_NUMBER_OUT_OF_RANGE
/// - @copydoc TRI_ERROR_QUERY_LIMIT_VALUE_OUT_OF_RANGE
/// - @copydoc TRI_ERROR_QUERY_TOO_MANY_JOINS
/// - @copydoc TRI_ERROR_QUERY_COLLECTION_NAME_INVALID
/// - @copydoc TRI_ERROR_QUERY_COLLECTION_ALIAS_INVALID
/// - @copydoc TRI_ERROR_QUERY_COLLECTION_ALIAS_REDECLARED
/// - @copydoc TRI_ERROR_QUERY_COLLECTION_ALIAS_UNDECLARED
/// - @copydoc TRI_ERROR_QUERY_COLLECTION_NOT_FOUND
/// - @copydoc TRI_ERROR_QUERY_GEO_RESTRICTION_INVALID
/// - @copydoc TRI_ERROR_QUERY_GEO_INDEX_MISSING
/// - @copydoc TRI_ERROR_QUERY_BIND_PARAMETER_MISSING
/// - @copydoc TRI_ERROR_QUERY_BIND_PARAMETER_REDECLARED
/// - @copydoc TRI_ERROR_QUERY_BIND_PARAMETER_UNDECLARED
/// - @copydoc TRI_ERROR_QUERY_BIND_PARAMETER_VALUE_INVALID
/// - @copydoc TRI_ERROR_QUERY_BIND_PARAMETER_NUMBER_OUT_OF_RANGE
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup AvocadoErrors
/// @{
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- definitions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief error codes
///
/// If you add a new error code, you must also add the description in
/// @ref TRI_InitialiseVocBase.
///
/// Please note that the error numbers defined here must not conflict with error
/// numbers defined for other parts of the program (e.g. in
/// VocBase/query-error.h)
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_BEGIN (1000)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1000: Illegal state.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_ILLEGAL_STATE (1000)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1001: Shaper failed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_SHAPER_FAILED (1001)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1002: Corrupted datafile.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_CORRUPTED_DATAFILE (1002)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1003: mmap failed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_MMAP_FAILED (1003)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1004: msync failed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_MSYNC_FAILED (1004)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1005: No journal.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_NO_JOURNAL (1005)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1006: Datafile sealed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_DATAFILE_SEALED (1006)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1007: Corrupted collection.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_CORRUPTED_COLLECTION (1007)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1008: Unknown type.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_UNKNOWN_TYPE (1008)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1009: Illegal parameter.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_ILLEGAL_PARAMETER (1009)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1010: Index exists.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_INDEX_EXISTS (1010)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1011: Conflict.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_CONFLICT (1011)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1100: Wrong path.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_WRONG_PATH (1100)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1101: Cannot rename.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_CANNOT_RENAME (1101)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1102: Write failed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_WRITE_FAILED (1102)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1103: Read only.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_READ_ONLY (1103)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1104: Datafile full.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_DATAFILE_FULL (1104)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1105: Filesystem full.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_FILESYSTEM_FULL (1105)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1106: Read failed.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_READ_FAILED (1106)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1107: File not found.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_FILE_NOT_FOUND (1107)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1108: File not accessible.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_FILE_NOT_ACCESSIBLE (1108)
////////////////////////////////////////////////////////////////////////////////
/// @brief 1200: Document not found.
///
/// TODO
////////////////////////////////////////////////////////////////////////////////
#define TRI_VOC_ERROR_DOCUMENT_NOT_FOUND (1200)
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus
}
#endif
#endif
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: