mirror of https://gitee.com/bigwinds/arangodb
202 lines
8.1 KiB
C++
202 lines
8.1 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief document request handler
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
|
|
/// Copyright 2004-2014 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 ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Dr. Frank Celler
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2010-2014, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_REST_HANDLER_REST_DOCUMENT_HANDLER_H
|
|
#define ARANGODB_REST_HANDLER_REST_DOCUMENT_HANDLER_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
|
|
#include "RestHandler/RestVocbaseBaseHandler.h"
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- class RestDocumentHandler
|
|
// -----------------------------------------------------------------------------
|
|
|
|
namespace triagens {
|
|
namespace arango {
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief document request handler
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
class RestDocumentHandler : public RestVocbaseBaseHandler {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors and destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief constructor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
RestDocumentHandler (rest::HttpRequest*);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- Handler methods
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// {@inheritDoc}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
status_t execute ();
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- protected methods
|
|
// -----------------------------------------------------------------------------
|
|
|
|
protected:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get collection type
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual TRI_col_type_e getCollectionType () const {
|
|
return TRI_COL_TYPE_DOCUMENT;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a document
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool createDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads a single or all documents
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool readDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads a single document
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool readSingleDocument (bool generateBody);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads all documents
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool readAllDocuments ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief reads a single document head
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool checkDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief replaces a document
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool replaceDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief updates a document
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool updateDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief helper function for replace and update
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool modifyDocument (bool);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief deletes a document
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool deleteDocument ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a document, coordinator case in a cluster
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool createDocumentCoordinator (char const* collection,
|
|
bool waitForSync,
|
|
TRI_json_t* json);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief delete a document, coordinator case in a cluster
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool deleteDocumentCoordinator (std::string const& collname,
|
|
std::string const& key,
|
|
TRI_voc_rid_t const rev,
|
|
TRI_doc_update_policy_e policy,
|
|
bool waitForSync);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read a single document, coordinator case in a cluster
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool getDocumentCoordinator (std::string const& collname,
|
|
std::string const& key,
|
|
bool generateBody);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read all documents, coordinator case in a cluster
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool getAllDocumentsCoordinator (std::string const& collname,
|
|
std::string const& returnType);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief read a single document, coordinator case in a cluster
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool modifyDocumentCoordinator (std::string const& collname,
|
|
std::string const& key,
|
|
TRI_voc_rid_t const rev,
|
|
TRI_doc_update_policy_e policy,
|
|
bool waitForSync,
|
|
bool isPatch,
|
|
TRI_json_t* json);
|
|
|
|
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|