mongodb_tool.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** 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.
*/
 
/*
 * mongodb_tool.h
 *
 *  Created on: 26 Jun 2015
 *      Author: billy
 */
#ifndef MONGODB_TOOL_H_
#define MONGODB_TOOL_H_
 
#include "mongoc.h"
#include "typedefs.h"
#include "jansson.h"
#include "mongodb_library.h"
#include "operation.h"
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
  #ifdef GRASSROOTS_MONGODB_LIBRARY_EXPORTS // defined if we are building the LIB DLL (instead of using it)
 
    #ifdef ALLOCATE_MONGODB_TAGS
      #define MONGODB_PREFIX GRASSROOTS_MONGODB_API
      #define MONGODB_VAL(x)  = x
    #else
      #define MONGODB_PREFIX  extern GRASSROOTS_MONGODB_API
      #define MONGODB_VAL(x)
    #endif
  #else
    #define MONGODB_PREFIX extern GRASSROOTS_MONGODB_API
    #define MONGODB_VAL(x)
  #endif
 
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
 
 
 
MONGODB_PREFIX const char *MONGO_ID_S MONGODB_VAL("_id");
 
MONGODB_PREFIX const char *MONGO_COLLECTION_S MONGODB_VAL("collection");
 
MONGODB_PREFIX const char *MONGO_OPERATION_S MONGODB_VAL("operation");
 
MONGODB_PREFIX const char *MONGO_OPERATION_INSERT_S MONGODB_VAL("insert");
 
MONGODB_PREFIX const char *MONGO_OPERATION_SEARCH_S MONGODB_VAL("search");
 
MONGODB_PREFIX const char *MONGO_OPERATION_REMOVE_S MONGODB_VAL("remove");
 
MONGODB_PREFIX const char *MONGO_OPERATION_DATA_S MONGODB_VAL("data");
 
MONGODB_PREFIX const char *MONGO_OPERATION_FIELDS_S MONGODB_VAL("fields");
 
MONGODB_PREFIX const char *MONGO_OPERATION_GET_ALL_S MONGODB_VAL("dump");
 
MONGODB_PREFIX const char *MONGO_CLAUSE_OPERATOR_S MONGODB_VAL("operator");
 
MONGODB_PREFIX const char *MONGO_CLAUSE_VALUE_S MONGODB_VAL("value");
 
 
//MONGODB_PREFIX const uint32 MONGO_OID_STRING_BUFFER_SIZE MONGODB_VAL(25);
 
#define MONGO_OID_STRING_BUFFER_SIZE (25)
 
MONGODB_PREFIX const char *MONGO_OID_KEY_S MONGODB_VAL("$oid");
 
 
 
MONGODB_PREFIX const char *MONGO_TIMESTAMP_S MONGODB_VAL ("modified");
 
 
typedef struct MongoTool
{
  mongoc_client_t *mt_client_p;
 
 
  bool mt_owns_client_flag;
 
  mongoc_collection_t *mt_collection_p;
 
 
  mongoc_database_t *mt_database_p;
 
  mongoc_cursor_t *mt_cursor_p;
 
 
  struct MongoClientManager *mt_manager_p;
} MongoTool;
 
 
/*
 * The following preprocessor macros allow us to declare
 * and define the variables in the same place. By default,
 * they will expand to
 *
 *    extern const char *SERVICE_NAME_S;
 *
 * however if ALLOCATE_MONGODB_TAGS is defined then it will
 * become
 *
 *    const char *SERVICE_NAME_S = "path";
 *
 * ALLOCATE_MONGODB_TAGS must be defined only once prior to
 * including this header file. Currently this happens in
 * mongodb_tool.c.
 */
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_MONGODB_API bool SetMongoToolDatabaseAndCollection (MongoTool *tool_p, const char *db_s, const char *collection_s);
 
 
GRASSROOTS_MONGODB_API bool SetMongoToolDatabase (MongoTool *tool_p, const char *db_s);
 
 
GRASSROOTS_MONGODB_API bool SetMongoToolCollection (MongoTool *tool_p, const char *collection_s);
 
 
GRASSROOTS_MONGODB_API MongoTool *AllocateMongoTool (mongoc_client_t *client_p, struct MongoClientManager *mongo_manager_p);
 
 
GRASSROOTS_MONGODB_API void FreeMongoTool (MongoTool *tool_p);
 
 
GRASSROOTS_MONGODB_API bson_oid_t *InsertJSONIntoMongoCollection (MongoTool *tool_p, json_t *json_p);
 
 
GRASSROOTS_MONGODB_API bool UpdateMongoDocumentsByJSON (MongoTool *tool_p, const json_t *query_p, const json_t *update_p, const bool multiple_flag);
 
 
GRASSROOTS_MONGODB_API bool UpdateMongoDocuments (MongoTool *tool_p, const bson_oid_t *id_p, const json_t *json_p, const bool multiple_flag);
 
 
GRASSROOTS_MONGODB_API bool RemoveMongoDocuments (MongoTool *tool_p, const json_t *selector_json_p, const bool remove_first_match_only_flag);
 
 
GRASSROOTS_MONGODB_API bool FindMatchingMongoDocumentsByJSON (MongoTool *tool_p, const json_t *query_json_p, const char **fields_ss, bson_t *extra_opts_p);
 
 
GRASSROOTS_MONGODB_API bool FindMatchingMongoDocumentsByBSON (MongoTool *tool_p, const bson_t *query_p, const char **fields_ss, bson_t *extra_opts_p);
 
 
GRASSROOTS_MONGODB_API bool IterateOverMongoResults (MongoTool *tool_p, bool (*process_bson_fn) (const bson_t *document_p, void *data_p), void *data_p);
 
 
GRASSROOTS_MONGODB_API bool HasMongoQueryResults (MongoTool *tool_p);
 
 
GRASSROOTS_MONGODB_API json_t *GetAllMongoResultsAsJSON (MongoTool *tool_p, bson_t *query_p, bson_t *extra_opts_p);
 
 
GRASSROOTS_MONGODB_API bool PopulateJSONWithAllMongoResults (MongoTool *tool_p, bson_t *query_p, bson_t *extra_opts_p, json_t *results_array_p);
 
 
GRASSROOTS_MONGODB_API int32 GetAllMongoResultsForKeyValuePair (MongoTool *tool_p, json_t **docs_pp, const char * const key_s, const char * const value_s, const char **fields_ss);
 
 
GRASSROOTS_MONGODB_API json_t *GetCurrentValuesAsJSON (MongoTool *tool_p, const char **fields_ss, const size_t num_fields);
 
 
GRASSROOTS_MONGODB_API json_t *GetAllExistingMongoResultsAsJSON (MongoTool *tool_p);
 
 
GRASSROOTS_MONGODB_API bool AddBSONDocumentToJSONArray (const bson_t *document_p, void *data_p);
 
 
GRASSROOTS_MONGODB_API int PrintBSONToLog (const uint32 level, const char *filename_s, const int line_number, const bson_t *bson_p, const char *message_s, ...);
 
 
GRASSROOTS_MONGODB_API int PrintBSONToErrors (const uint32 level, const char *filename_s, const int line_number, const bson_t *bson_p, const char *message_s, ...);
 
 
GRASSROOTS_MONGODB_API void LogBSONOid (const bson_oid_t *bson_p, const int level, const char * const filename_s, const int line_number,  const char * const prefix_s);
 
 
GRASSROOTS_MONGODB_API void LogAllBSON (const bson_t *bson_p, const int level, const char * const file_s, const int line, const char * const prefix_s);
 
 
GRASSROOTS_MONGODB_API int32 IsKeyValuePairInCollection (MongoTool *tool_p, const char *database_s, const char *collection_s, const char *key_s, const char *value_s);
 
 
GRASSROOTS_MONGODB_API bson_t *GenerateQuery (const json_t *json_p);
 
 
GRASSROOTS_MONGODB_API json_t *ConvertBSONValueToJSON (const bson_value_t *value_p);
 
 
 
 
GRASSROOTS_MONGODB_API json_t *ConvertBSONToJSON (const bson_t *bson_p);
 
 
GRASSROOTS_MONGODB_API const char *InsertOrUpdateMongoData (MongoTool *tool_p, json_t *values_p, const char * const database_s, const char * const collection_s, const char **primary_keys_ss, const size_t num_keys, const char * const mapped_id_s, const char * const object_key_s);
 
 
GRASSROOTS_MONGODB_API const char *EasyInsertOrUpdateMongoData (MongoTool *tool_p, json_t *values_p, const char *const primary_key_id_s);
 
 
 
GRASSROOTS_MONGODB_API bool CreateIndexForMongoCollection (MongoTool *tool_p, char **fields_ss);
 
 
 
GRASSROOTS_MONGODB_API bool InsertMongoData (MongoTool *tool_p, const json_t *values_p, bson_t **reply_pp, bson_error_t *error_p);
 
 
GRASSROOTS_MONGODB_API bool InsertMongoDataAsBSON (MongoTool *tool_p, const bson_t *doc_p, bson_t **reply_pp, bson_error_t *error_p);
 
 
GRASSROOTS_MONGODB_API bool RunMongoCommand (MongoTool *tool_p, bson_t *command_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool RemoveMongoDocumentsByBSON (MongoTool *tool_p, const bson_t *selector_p, const bool remove_first_match_only_flag);
 
 
 
GRASSROOTS_MONGODB_API bson_t *ConvertJSONToBSON (const json_t *json_p);
 
 
GRASSROOTS_MONGODB_API char *GetBSONOidAsString (const bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API void FreeBSONOidString (char *id_s);
 
 
GRASSROOTS_MONGODB_API bson_oid_t *GetBSONOidFromString (const char *id_s);
 
 
GRASSROOTS_MONGODB_API bool SaveMongoData (MongoTool *mongo_p, const json_t *data_to_save_p, const char *collection_s, bson_t *selector_p);
 
 
GRASSROOTS_MONGODB_API bool SaveMongoDataWithTimestamp (MongoTool *mongo_p, json_t *data_to_save_p, const char *collection_s, bson_t *selector_p, const char *timestamp_key_s);
 
GRASSROOTS_MONGODB_API bool SaveAndBackupMongoDataWithTimestamp (MongoTool *mongo_p, json_t *data_to_save_p, const char *collection_s, const char *backup_collection_s, const char *id_key_s, bson_t *selector_p, const char *timestamp_key_s);
 
 
GRASSROOTS_MONGODB_API bool SaveMongoDataFromBSON (MongoTool *mongo_p, const bson_t *data_to_save_p, const char *collection_s, bson_t *selector_p);
 
 
GRASSROOTS_MONGODB_API bool SaveAndBackupMongoData (MongoTool *mongo_p, const json_t *data_to_save_p, const char *collection_s, const char *backup_collection_s, const char *id_key_s, bson_t *selector_p);
 
 
GRASSROOTS_MONGODB_API bool SaveAndBackupMongoDataFromBSON (MongoTool *mongo_p, const bson_t *data_to_save_p, const char *collection_s, const char *backup_collection_s, const char *id_key_s, bson_t *selector_p);
 
 
GRASSROOTS_MONGODB_API bool SetMongoDataAsBSON (MongoTool *tool_p, bson_t *selector_p, const bson_t *doc_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool UnsetMongoDataAsBSON (MongoTool *tool_p, bson_t *selector_p, const bson_t *doc_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool UpdateMongoDataAsBSON (MongoTool *tool_p, const char * const update_s, bson_t *selector_p, const bson_t *doc_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool SetMongoDataAsBSONForGivenId (MongoTool *tool_p, bson_oid_t *id_p, bson_t *update_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool SetMongoData (MongoTool *tool_p, bson_t *selector_p, const json_t *values_p, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bool RemoveMongoFields (MongoTool *tool_p, bson_t *selector_p, const char **fields_ss, bson_t **reply_pp);
 
 
GRASSROOTS_MONGODB_API bson_oid_t *GetNewBSONOid (void);
 
 
GRASSROOTS_MONGODB_API bson_oid_t *GetNewUnitialisedBSONOid (void);
 
 
GRASSROOTS_MONGODB_API bson_oid_t *CopyBSONOid (const bson_oid_t *src_p);
 
 
GRASSROOTS_MONGODB_API void FreeBSONOid (bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API bson_t *AllocateBSON (void);
 
 
GRASSROOTS_MONGODB_API void FreeBSON (bson_t *bson_p);
 
 
GRASSROOTS_MONGODB_API bool GetMongoIdFromJSON (const json_t *data_p, bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API bool GetNamedIdFromJSON (const json_t *data_p, const char * const key_s, bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API const char *GetNamedIdAsStringFromJSON (const json_t *data_p, const char * const key_s);
 
 
GRASSROOTS_MONGODB_API bool GetIdFromJSONKeyValuePair (const json_t *id_val_p, bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API bool AddCompoundIdToJSON (json_t *data_p, bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API bool AddNamedCompoundIdToJSON (json_t *data_p, bson_oid_t *id_p, const char *key_s);
 
 
GRASSROOTS_MONGODB_API bool AddCompoundIdToJSONArray (json_t *array_p, const bson_oid_t *id_p);
 
 
GRASSROOTS_MONGODB_API bool AddIdToJSON (json_t *data_p, bson_oid_t *id_p, const char *key_s);
 
 
GRASSROOTS_MONGODB_API bool AddQueryTerm (bson_t *query_p, const char *key_s, const char *value_s, bool regex_flag);
 
 
GRASSROOTS_MONGODB_API int64 GetNumberOfMongoResults (MongoTool *tool_p, bson_t *query_p, bson_t *extra_opts_p);
 
 
GRASSROOTS_MONGODB_API OperationStatus ProcessMongoResults (MongoTool *tool_p, bson_t *query_p, bson_t *extra_opts_p, bool (*process_bson_fn) (const bson_t *document_p, void *data_p), void *data_p);
 
 
 
GRASSROOTS_MONGODB_API bool UpdateMongoDocumentsByBSON (MongoTool *tool_p, const bson_t *query_p, const json_t *update_p, const bool multiple_flag);
 
 
 
GRASSROOTS_MONGODB_API bool AddCollectionCompoundIndex (MongoTool *tool_p, const char *database_s, const char * const collection_s, const char ** const keys_ss, const bool unique_flag, const bool sparse_flag);
 
 
GRASSROOTS_MONGODB_API bool AddCollectionSingleIndex (MongoTool *tool_p, const char *database_s, const char * const collection_s, const char *key_s, const char *index_type_s, const bool unique_flag, const bool sparse_flag);
 
 
GRASSROOTS_MONGODB_API bool CreateMongoToolCollection (MongoTool *tool_p, const char *collection_s, bson_t *opts_p);
 
 
GRASSROOTS_MONGODB_API int DoesCollectionExist (MongoTool *tool_p, const char *collection_s);
 
 
 
GRASSROOTS_MONGODB_API bool DropCollectionIndex (MongoTool *tool_p, const char *index_s);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif /* MONGODB_TOOL_H_ */