Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loki-astari/thorsmongo
C++ MongoDB API and BSON/JSON Serialization library
https://github.com/loki-astari/thorsmongo
bson bson-library bson-serialization c-plus-plus c-plus-plus-20 cxx database database-driver driver header-only-library json-serialization mongo mongodb mongodb-driver networking nosql
Last synced: 4 days ago
JSON representation
C++ MongoDB API and BSON/JSON Serialization library
- Host: GitHub
- URL: https://github.com/loki-astari/thorsmongo
- Owner: Loki-Astari
- License: gpl-3.0
- Created: 2012-04-24T10:10:30.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T22:12:23.000Z (3 months ago)
- Last Synced: 2024-10-29T14:21:06.556Z (3 months ago)
- Topics: bson, bson-library, bson-serialization, c-plus-plus, c-plus-plus-20, cxx, database, database-driver, driver, header-only-library, json-serialization, mongo, mongodb, mongodb-driver, networking, nosql
- Language: C++
- Homepage:
- Size: 4.96 MB
- Stars: 316
- Watchers: 22
- Forks: 71
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://ko-fi.com/G2G216KZR3)
# ThorsMongo
[](https://formulae.brew.sh/formula/thors-mongo)
A modern C++20 library to interact with MongoDB.
This library provides a simple and intuitive library for interacting with a MongoDB.
There are two main parts:
1. [ThorsSerializer](https://github.com/Loki-Astari/ThorsSerializer) automatically converts C++ objects into BSON (JSON/YAML).
2. [ThorsMongoAPI](https://github.com/Loki-Astari/ThorsMongoAPI) sends and receives MongoDB wire protocol messages.
The main goal of this project is to remove the need to write boilerplate code to save/ restore C++ objects into a MongoDB. Using a declarative style an engineer can define the C++ classes and members that need to be serialized into BSON thus allowing them to be inserted into or retrieved directly to/from a MongoDB.
## Example:
```C++
#include "ThorsMongo/ThorsMongo.h"
#include
#include
class Address
{
friend class ThorsAnvil::Serialize::Traits
;
std::string street;
std::string city;
std::string country;
std::string postCode;
public:
// Add your API here
};
using Allergies = std::vector;
class Person
{
friend class ThorsAnvil::Serialize::Traits;
std::string name;
std::uint32_t age;
Address address;
Allergies alergies;
public:
// Add your API here
};
// Make the classes serialize able into BSON.
ThorsAnvil_MakeTrait(Address, street, city, country, postCode);
ThorsAnvil_MakeTrait(Person, name, age, address, alergies);
// Define what fields can be used in Search/Update
ThorsMongo_CreateFieldAccess(Person, name); // Search/Update a person by name.
ThorsMongo_CreateFieldAccess(Person, age); // Search/Update a person by age.
ThorsMongo_CreateFieldAccess(Person, address, country); // Search/Update a person by country.
// Define a class that can be used to search for a person by name using 'Eq' (equal)
using FindEqName = ThorsMongo_FilterFromAccess(Eq, Person, name);
// Define a class that can be used to search for a person by age age using 'Gt' (Greater than)
using FindGtAge = ThorsMongo_FilterFromAccess(Gt, Person, age);
// Define a class that increments age
using IncAge = ThorsMongo_UpdateFromAccess(Inc, Person, age);
// Define a class that sets the country.
using SetCountry = ThorsMongo_UpdateFromAccess(Set, Person, address, country);
std::vector readDataFromFile()
{
// Read all the people you want to put in the DB
return {};
}
int main()
{
using ThorsAnvil::DB::Mongo::ThorsMongo;
using ThorsAnvil::DB::Mongo::Query;
std::vector data = readDataFromFile(); // Write this function to read data from file.
ThorsMongo mongo({"localhost", 27017}, {"DbUser", "UserPassword"});
mongo["DB"]["PeopleCollection"].insert(data);
mongo["DB"]["PeopleCollection"].remove(Query{"John"}); // Remove all the people named "John"
auto find = mongo["DB"]["PeopleCollection"].find(FindGtAge{51});// Find all the people over 51
for (auto const& person: find) {
// Now you a person
}
mongo["DB"]["PeopleCollection"].findAndUpdateOne(FindEqName{"Tom"}, IncAge{2}); // Increment the age of Tom by 2
mongo["DB"]["PeopleCollection"].findAndUpdateOne(FindEqName{"Sam"}, SetCountry{"USA"}); // Sam now lives in the USA
}
```
Builing the above application:
```bash
> export THORS_ROOT=
> g++ -std=c++20 Example.cpp -I ${THORS_ROOT}/include -L ${THORS_ROOT}/lib -lThorSerialize -lThorsLogging -lThorsMongo -lThorsSocket
```
# Installing
## Easy: Using Brew
Can be installed via brew on Mac and Linux
> brew install thors-mongo
* Mac: https://formulae.brew.sh/formula/thors-mongo
* Linux: https://formulae.brew.sh/formula-linux/thors-mongo
## Building Manually
> git clone [email protected]:Loki-Astari/ThorsMongo.git
> cd ThorsMongo
> ./configure
> make
Note: The `configure` script will tell you about any missing dependencies and how to install them.
## Building Conan
If you have conan installed the conan build processes should work.
> git clone [email protected]:Loki-Astari/ThorsMongo.git
> cd ThorsMongo
> conan build -s compiler.cppstd=20 conanfile.py
## Header Only
To install header only version
> git clone --single-branch --branch header-only https://github.com/Loki-Astari/ThorsMongo.git
Some dependencies you will need to install manually for header only builds.
Magic Enum: https://github.com/Neargye/magic_enum
libYaml https://github.com/yaml/libyaml
libSnappy https://github.com/google/snappy
libZ https://www.zlib.net/
## Building With Visual Studio
To build on windows you will need to add the flag: [`/Zc:preprocessor`](https://learn.microsoft.com/en-us/cpp/build/reference/zc-preprocessor?view=msvc-170). These libraries make heavy use of VAR_ARG macros to generate code for you so require conforming pre-processor. See [Macro Expansion of __VA_ARGS__ Bug in Visual Studio?](https://stackoverflow.com/questions/78605945/macro-expansion-of-va-args-bug-in-visual-studio) for details.