#include <MongoKnowledgeGraph.h>

Inheritance diagram for knowrob::MongoKnowledgeGraph:

[legend]

Collaboration diagram for knowrob::MongoKnowledgeGraph:

[legend]

Classes
class	ConnectionRAII

Public Member Functions
	MongoKnowledgeGraph ()

	~MongoKnowledgeGraph () override=default

bool	initializeBackend (std::string_view db_uri, std::string_view db_name="knowrob", std::string_view collectionName="triples")

bool	initializeBackend (const PropertyTree &config) override

const std::string &	dbName () const

const std::string &	dbURI () const

bool	isReadOnly () const

auto	tripleCollection ()

void	drop ()

mongo::BindingsCursorPtr	lookup (const TriplePattern &query)

mongo::BindingsCursorPtr	lookup (const GraphTerm &query)

bool	insertOne (const Triple &triple) override

bool	insertAll (const TripleContainerPtr &triples) override

bool	removeOne (const Triple &triple) override

bool	removeAll (const TripleContainerPtr &triples) override

bool	removeAllWithOrigin (std::string_view origin) override

bool	isPersistent () const override

void	foreach (const TripleVisitor &callback) const override

void	batch (const TripleHandler &callback) const override

void	batchOrigin (std::string_view origin, const TripleHandler &callback) override

void	match (const TriplePattern &query, const TripleVisitor &visitor) override

void	query (const GraphQueryPtr &query, const BindingsHandler &callback) override

void	count (const ResourceCounter &callback) const override

	MongoKnowledgeGraph ()

	~MongoKnowledgeGraph () override=default

bool	initializeBackend (std::string_view db_uri, std::string_view db_name="knowrob", std::string_view collectionName="triples")

bool	initializeBackend (const PropertyTree &config) override

const std::string &	dbName () const

const std::string &	dbURI () const

bool	isReadOnly () const

auto	tripleCollection ()

void	drop ()

mongo::BindingsCursorPtr	lookup (const TriplePattern &query)

mongo::BindingsCursorPtr	lookup (const GraphTerm &query)

bool	insertOne (const Triple &triple) override

bool	insertAll (const TripleContainerPtr &triples) override

bool	removeOne (const Triple &triple) override

bool	removeAll (const TripleContainerPtr &triples) override

bool	removeAllWithOrigin (std::string_view origin) override

bool	isPersistent () const override

void	foreach (const TripleVisitor &callback) const override

void	batch (const TripleHandler &callback) const override

void	batchOrigin (std::string_view origin, const TripleHandler &callback) override

void	match (const TriplePattern &query, const TripleVisitor &visitor) override

void	query (const GraphQueryPtr &query, const BindingsHandler &callback) override

void	count (const ResourceCounter &callback) const override

Public Member Functions inherited from knowrob::QueryableStorage
	QueryableStorage (StorageFeatures features=StorageFeature::NothingSpecial)

	~QueryableStorage () override=default

virtual bool	contains (const Triple &triple)

std::vector< VersionedOriginPtr >	getOrigins ()

std::optional< std::string >	getVersionOfOrigin (std::string_view origin)

void	setVersionOfOrigin (std::string_view origin, std::string_view version)

void	dropSessionOrigins ()

GraphQueryExpansionPtr	expand (const GraphQueryPtr &q)

	QueryableStorage (StorageFeatures features=StorageFeature::NothingSpecial)

	~QueryableStorage () override=default

virtual bool	contains (const Triple &triple)

std::vector< VersionedOriginPtr >	getOrigins ()

std::optional< std::string >	getVersionOfOrigin (std::string_view origin)

void	setVersionOfOrigin (std::string_view origin, std::string_view version)

void	dropSessionOrigins ()

GraphQueryExpansionPtr	expand (const GraphQueryPtr &q)

Public Member Functions inherited from knowrob::Storage
	Storage (StorageFeatures features=StorageFeature::NothingSpecial)

virtual	~Storage ()=default

PluginLanguage	storageLanguage () const

const auto &	vocabulary () const

void	setVocabulary (std::shared_ptr< Vocabulary > vocabulary)

bool	supports (StorageFeature feature) const

std::optional< std::string >	getVersionOfOrigin (std::string_view origin) const

void	setVersionOfOrigin (std::string_view origin, std::optional< std::string_view > version)

	Storage (StorageFeatures features=StorageFeature::NothingSpecial)

virtual	~Storage ()=default

PluginLanguage	storageLanguage () const

const auto &	vocabulary () const

void	setVocabulary (std::shared_ptr< Vocabulary > vocabulary)

bool	supports (StorageFeature feature) const

std::optional< std::string >	getVersionOfOrigin (std::string_view origin) const

void	setVersionOfOrigin (std::string_view origin, std::optional< std::string_view > version)

Public Member Functions inherited from knowrob::DataSourceHandler
	DataSourceHandler ()=default

virtual	~DataSourceHandler ()=default

void	addDataHandler (const std::string &format, const DataSourceLoader &fn)

bool	loadDataSource (const DataSourcePtr &dataSource)

bool	hasDataHandler (const DataSourcePtr &dataSource) const

	DataSourceHandler ()=default

virtual	~DataSourceHandler ()=default

void	addDataHandler (const std::string &format, const DataSourceLoader &fn)

bool	loadDataSource (const DataSourcePtr &dataSource)

bool	hasDataHandler (const DataSourcePtr &dataSource) const

Static Public Attributes
static const std::string	DB_URI_DEFAULT = "mongodb://localhost:27017"

static const std::string	DB_NAME_KNOWROB = "knowrob"

static const std::string	DB_NAME_TESTS = "knowrob_test"

static const std::string	COLL_NAME_TRIPLES = "triples"

static const std::string	COLL_NAME_TESTS = "triples_test"

Static Public Attributes inherited from knowrob::QueryableStorage
static AtomPtr	versionProperty = IRIAtom::Tabled("http://knowrob.org/kb/knowrob.owl#hasVersionOfOrigin")

Protected Member Functions
void	initializeMongo (const std::shared_ptr< mongo::Collection > &tripleCollection)

bool	dropOrigin (std::string_view origin)

mongo::TripleStore	acquireStore () const

void	releaseStore (mongo::TripleStore &store) const

void	initializeMongo (const std::shared_ptr< mongo::Collection > &tripleCollection)

bool	dropOrigin (std::string_view origin)

mongo::TripleStore	acquireStore () const

void	releaseStore (mongo::TripleStore &store) const

Protected Member Functions inherited from knowrob::Storage
void	enableFeature (StorageFeature feature)

void	setStorageLanguage (PluginLanguage storageLanguage)

void	enableFeature (StorageFeature feature)

void	setStorageLanguage (PluginLanguage storageLanguage)

Protected Member Functions inherited from knowrob::DataSourceHandler
virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)

virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)

Static Protected Member Functions
static void	iterate (mongo::TripleCursor &cursor, const TripleVisitor &visitor)

static std::shared_ptr< mongo::Collection >	connect (const boost::property_tree::ptree &config)

static std::shared_ptr< mongo::Collection >	connect (std::string_view uri, std::string_view db, std::string_view collection)

static std::string	getDBName (const boost::property_tree::ptree &config)

static std::string	getCollectionName (const boost::property_tree::ptree &config)

static std::string	getURI (const boost::property_tree::ptree &config)

static void	iterate (mongo::TripleCursor &cursor, const TripleVisitor &visitor)

static std::shared_ptr< mongo::Collection >	connect (const boost::property_tree::ptree &config)

static std::shared_ptr< mongo::Collection >	connect (std::string_view uri, std::string_view db, std::string_view collection)

static std::string	getDBName (const boost::property_tree::ptree &config)

static std::string	getCollectionName (const boost::property_tree::ptree &config)

static std::string	getURI (const boost::property_tree::ptree &config)

Protected Attributes
std::shared_ptr< mongo::Collection >	tripleCollection_

std::shared_ptr< mongo::Collection >	oneCollection_

std::shared_ptr< mongo::MongoTaxonomy >	taxonomy_

bool	isReadOnly_

std::mutex	storeMutex_

std::list< mongo::TripleStore >	connections_

Protected Attributes inherited from knowrob::Storage
std::map< std::string, std::string >	originVersions_

std::shared_ptr< Vocabulary >	vocabulary_

StorageFeatures	features_

PluginLanguage	storageLanguage_

Protected Attributes inherited from knowrob::DataSourceHandler
std::map< std::string, DataSourceLoader >	dataSourceHandler_

Friends
class	ConnectionRAII

Additional Inherited Members
Static Public Member Functions inherited from knowrob::QueryableStorage
static std::shared_ptr< AnswerYes >	yes (const GraphPathQueryPtr &original, const GraphQueryExpansionPtr &expansion, const BindingsPtr &bindings)

static std::shared_ptr< AnswerNo >	no (const GraphPathQueryPtr &q)

static std::shared_ptr< AnswerYes >	yes (const GraphPathQueryPtr &original, const GraphQueryExpansionPtr &expansion, const BindingsPtr &bindings)

static std::shared_ptr< AnswerNo >	no (const GraphPathQueryPtr &q)

Detailed Description

A knowledge graph implemented with MongoDB.

Definition at line 26 of file MongoKnowledgeGraph.h.

Constructor & Destructor Documentation

◆ MongoKnowledgeGraph() [1/2]

MongoKnowledgeGraph::MongoKnowledgeGraph ( )

Definition at line 58 of file MongoKnowledgeGraph.cpp.

         : QueryableStorage(mongoBackendFeatures()),
           isReadOnly_(false) {
 }

◆ ~MongoKnowledgeGraph() [1/2]

knowrob::MongoKnowledgeGraph::~MongoKnowledgeGraph ( )

overridedefault

◆ MongoKnowledgeGraph() [2/2]

knowrob::MongoKnowledgeGraph::MongoKnowledgeGraph ( )

◆ ~MongoKnowledgeGraph() [2/2]

knowrob::MongoKnowledgeGraph::~MongoKnowledgeGraph ( )

overridedefault

Member Function Documentation

◆ acquireStore() [1/2]

mongo::TripleStore MongoKnowledgeGraph::acquireStore ( ) const

protected

Definition at line 70 of file MongoKnowledgeGraph.cpp.

                                                          {
     // Note: We cannot use a Collection object in different threads, so instead we manage
     // a list of active connections and hand them out to threads that need them.
     // If no connection is available, a new one is created on the fly.
     std::lock_guard<std::mutex> lock(storeMutex_);
     if (connections_.empty()) {
         auto tripleCollection = std::make_shared<Collection>(*tripleCollection_);
         auto oneCollection = std::make_shared<Collection>(
                 tripleCollection->connection(),
                 tripleCollection->dbName().c_str(),
                 MONGO_KG_ONE_COLLECTION);
         return {tripleCollection, oneCollection, vocabulary_};
     } else {
         auto store = connections_.front();
         connections_.pop_front();
         return store;
     }
 }

◆ acquireStore() [2/2]

mongo::TripleStore knowrob::MongoKnowledgeGraph::acquireStore ( ) const

protected

◆ batch() [1/2]

void MongoKnowledgeGraph::batch ( const TripleHandler & callback ) const

overridevirtual

Iterate over all triples in the model.

Parameters

callback the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

Definition at line 409 of file MongoKnowledgeGraph.cpp.

                                                                    {
     ConnectionRAII scoped(this);
     batch_(scoped.mongo.tripleCollection, callback, nullptr);
 }

◆ batch() [2/2]

void knowrob::MongoKnowledgeGraph::batch ( const TripleHandler & callback ) const

overridevirtual

Iterate over all triples in the model.

Parameters

callback the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

◆ batchOrigin() [1/2]

void MongoKnowledgeGraph::batchOrigin	(	std::string_view	origin,
		const TripleHandler &	callback
	)

overridevirtual

Iterate over all triples in the model that have a given origin.

Parameters

origin	the origin of the triples.
callback	the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

Definition at line 414 of file MongoKnowledgeGraph.cpp.

                                                                                           {
     ConnectionRAII scoped(this);
     bson_t filterDoc;
     BSON_APPEND_UTF8(&filterDoc, "graph", origin.data());
     batch_(scoped.mongo.tripleCollection, callback, &filterDoc);
 }

◆ batchOrigin() [2/2]

void knowrob::MongoKnowledgeGraph::batchOrigin	(	std::string_view	origin,
		const TripleHandler &	callback
	)

overridevirtual

Iterate over all triples in the model that have a given origin.

Parameters

origin	the origin of the triples.
callback	the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

◆ connect() [1/4]

std::shared_ptr< Collection > MongoKnowledgeGraph::connect ( const boost::property_tree::ptree & config )

staticprotected

Definition at line 191 of file MongoKnowledgeGraph.cpp.

                                                                                             {
     return connect(getURI(config), getDBName(config), getCollectionName(config));
 }

◆ connect() [2/4]

static std::shared_ptr<mongo::Collection> knowrob::MongoKnowledgeGraph::connect ( const boost::property_tree::ptree & config )

staticprotected

◆ connect() [3/4]

std::shared_ptr< Collection > MongoKnowledgeGraph::connect	(	std::string_view	uri,
		std::string_view	db,
		std::string_view	collection
	)

staticprotected

Definition at line 178 of file MongoKnowledgeGraph.cpp.

                                              {
     auto coll = MongoInterface::get().connect(db_uri.data(), db_name.data(), collectionName.data());
     if (coll) {
         KB_INFO("[mongodb] connected to {} ({}.{}).", db_uri, db_name, collectionName);
     } else {
         KB_ERROR("[mongodb] failed to connect to {} ({}.{}).", db_uri, db_name, collectionName);
     }
     return coll;
 }

◆ connect() [4/4]

static std::shared_ptr<mongo::Collection> knowrob::MongoKnowledgeGraph::connect	(	std::string_view	uri,
		std::string_view	db,
		std::string_view	collection
	)

staticprotected

◆ count() [1/2]

void MongoKnowledgeGraph::count ( const ResourceCounter & callback ) const

overridevirtual

Parameters

callback a function that is called for each resource and its count.

Implements knowrob::QueryableStorage.

Definition at line 332 of file MongoKnowledgeGraph.cpp.

                                                                      {
     ConnectionRAII scoped(this);
     for (auto &filename: {PIPELINE_RELATION_COUNTER, PIPELINE_CLASS_COUNTER}) {
         const bson_t *result;
         Cursor cursor(scoped.mongo.tripleCollection);
         Document document(Pipeline::loadFromJSON(
                 filename, {
                         {"COLLECTION", scoped.mongo.tripleCollection->name()}
                 }));
         cursor.aggregate(document.bson());
         while (cursor.next(&result)) {
             bson_iter_t iter;
             if (!bson_iter_init(&iter, result)) break;
             if (!bson_iter_find(&iter, "resource")) break;
             auto property = bson_iter_utf8(&iter, nullptr);
             if (!bson_iter_find(&iter, "count")) break;
             auto count = bson_iter_as_int64(&iter);
             callback(property, count);
         }
     }
 }

◆ count() [2/2]

void knowrob::MongoKnowledgeGraph::count ( const ResourceCounter & callback ) const

overridevirtual

Parameters

callback a function that is called for each resource and its count.

Implements knowrob::QueryableStorage.

◆ dbName() [1/2]

const std::string& knowrob::MongoKnowledgeGraph::dbName ( ) const

inline

Returns: the name of the database.

Definition at line 55 of file MongoKnowledgeGraph.h.

55 { return tripleCollection_->dbName(); }

◆ dbName() [2/2]

const std::string& knowrob::MongoKnowledgeGraph::dbName ( ) const

inline

Returns: the name of the database.

Definition at line 55 of file MongoKnowledgeGraph.h.

55 { return tripleCollection_->dbName(); }

◆ dbURI() [1/2]

const std::string& knowrob::MongoKnowledgeGraph::dbURI ( ) const

inline

Returns: the URI string used to connect to the database.

Definition at line 60 of file MongoKnowledgeGraph.h.

60 { return tripleCollection_->dbURI(); }

◆ dbURI() [2/2]

const std::string& knowrob::MongoKnowledgeGraph::dbURI ( ) const

inline

Returns: the URI string used to connect to the database.

Definition at line 60 of file MongoKnowledgeGraph.h.

60 { return tripleCollection_->dbURI(); }

◆ drop() [1/2]

void MongoKnowledgeGraph::drop ( )

Delete all statements in the database. Note: ths will also delete all indices which need to be re-created afterwards.

Definition at line 227 of file MongoKnowledgeGraph.cpp.

                                {
     ConnectionRAII scoped(this);
     scoped.mongo.tripleCollection->drop();
     vocabulary_ = std::make_shared<Vocabulary>();
 }

◆ drop() [2/2]

void knowrob::MongoKnowledgeGraph::drop ( )

Delete all statements in the database. Note: ths will also delete all indices which need to be re-created afterwards.

◆ dropOrigin() [1/2]

bool MongoKnowledgeGraph::dropOrigin ( std::string_view origin )

protected

Definition at line 320 of file MongoKnowledgeGraph.cpp.

                                                              {
     KB_DEBUG("[mongodb] dropping triples with origin \"{}\".", graphName);
     ConnectionRAII scoped(this);
     scoped.mongo.tripleCollection->removeAll(Document(
             BCON_NEW("graph", BCON_UTF8(graphName.data()))));
     return true;
 }

◆ dropOrigin() [2/2]

bool knowrob::MongoKnowledgeGraph::dropOrigin ( std::string_view origin )

protected

◆ foreach() [1/2]

void MongoKnowledgeGraph::foreach ( const TripleVisitor & visitor ) const

overridevirtual

Iterate over all triples in the model.

Parameters

visitor the callback to handle the triples.

Returns: true if the iteration was successful.

Reimplemented from knowrob::QueryableStorage.

Definition at line 369 of file MongoKnowledgeGraph.cpp.

                                                                     {
     ConnectionRAII scoped(this);
     TripleCursor cursor(scoped.mongo.tripleCollection);
     iterate(cursor, visitor);
 }

◆ foreach() [2/2]

void knowrob::MongoKnowledgeGraph::foreach ( const TripleVisitor & visitor ) const

overridevirtual

Iterate over all triples in the model.

Parameters

visitor the callback to handle the triples.

Returns: true if the iteration was successful.

Reimplemented from knowrob::QueryableStorage.

◆ getCollectionName() [1/2]

std::string MongoKnowledgeGraph::getCollectionName ( const boost::property_tree::ptree & config )

staticprotected

Definition at line 201 of file MongoKnowledgeGraph.cpp.

                                                                                       {
     static std::string defaultCollectionName = MONGO_KG_DEFAULT_COLLECTION;
     auto o_collection = config.get_optional<std::string>(MONGO_KG_SETTING_COLLECTION);
     return (o_collection ? o_collection.value() : defaultCollectionName);
 }

◆ getCollectionName() [2/2]

static std::string knowrob::MongoKnowledgeGraph::getCollectionName ( const boost::property_tree::ptree & config )

staticprotected

◆ getDBName() [1/2]

std::string MongoKnowledgeGraph::getDBName ( const boost::property_tree::ptree & config )

staticprotected

Definition at line 195 of file MongoKnowledgeGraph.cpp.

                                                                               {
     static std::string defaultDBName = MONGO_KG_DEFAULT_DB;
     auto o_dbname = config.get_optional<std::string>(MONGO_KG_SETTING_DB);
     return (o_dbname ? o_dbname.value() : defaultDBName);
 }

◆ getDBName() [2/2]

static std::string knowrob::MongoKnowledgeGraph::getDBName ( const boost::property_tree::ptree & config )

staticprotected

◆ getURI() [1/2]

std::string MongoKnowledgeGraph::getURI ( const boost::property_tree::ptree & config )

staticprotected

Definition at line 207 of file MongoKnowledgeGraph.cpp.

                                                                            {
     auto o_host = config.get_optional<std::string>(MONGO_KG_SETTING_HOST);
     auto o_port = config.get_optional<std::string>(MONGO_KG_SETTING_PORT);
     auto o_user = config.get_optional<std::string>(MONGO_KG_SETTING_USER);
     auto o_password = config.get_optional<std::string>(MONGO_KG_SETTING_PASSWORD);
     // format URI of the form "mongodb://USER:PW@HOST:PORT"
     std::stringstream uriStream;
     uriStream << "mongodb://";
     if (o_user) {
         uriStream << o_user.value();
         if (o_password) uriStream << ':' << o_password.value();
         uriStream << '@';
     }
     uriStream
             << (o_host ? o_host.value() : MONGO_KG_DEFAULT_HOST)
             << ':'
             << (o_port ? o_port.value() : MONGO_KG_DEFAULT_PORT);
     return uriStream.str();
 }

◆ getURI() [2/2]

static std::string knowrob::MongoKnowledgeGraph::getURI ( const boost::property_tree::ptree & config )

staticprotected

◆ initializeBackend() [1/4]

bool MongoKnowledgeGraph::initializeBackend ( const PropertyTree & config )

overridevirtual

Initialize this backend from a property tree.

Parameters

config a property tree.

Returns: true on success

Implements knowrob::Storage.

Definition at line 108 of file MongoKnowledgeGraph.cpp.

                                                                       {
     auto ptree = config.ptree();
     if (!ptree) {
         auto tripleCollection = connect(DB_URI_DEFAULT, DB_NAME_KNOWROB, COLL_NAME_TESTS);
         if (tripleCollection) {
             initializeMongo(tripleCollection);
             dropSessionOrigins();
             return true;
         } else {
             return false;
         }
     }
     initializeMongo(connect(*ptree));
  
     // set isReadOnly_ flag
     auto o_readOnly = ptree->get_optional<bool>(MONGO_KG_SETTING_READ_ONLY);
     if (o_readOnly.has_value()) {
         isReadOnly_ = o_readOnly.value();
     }
     if (!isReadOnly_) {
         dropSessionOrigins();
     }
  
     // Auto-drop some named graphs
     auto o_drop = ptree->get_child_optional(MONGO_KG_SETTING_DROP);
     if (o_drop.has_value()) {
         if (std::string_view("*") == std::string_view(o_drop.value().data())) {
             drop();
             tripleCollection_->createTripleIndex();
         } else {
             BOOST_FOREACH(const auto &v, o_drop.value()) {
                             removeAllWithOrigin(v.second.data());
                         }
         }
     }
  
     return true;
 }

◆ initializeBackend() [2/4]

bool knowrob::MongoKnowledgeGraph::initializeBackend ( const PropertyTree & config )

overridevirtual

Initialize this backend from a property tree.

Parameters

config a property tree.

Returns: true on success

Implements knowrob::Storage.

◆ initializeBackend() [3/4]

bool MongoKnowledgeGraph::initializeBackend	(	std::string_view	db_uri,
		std::string_view	db_name = `"knowrob"`,
		std::string_view	collectionName = `"triples"`
	)

Initialize the knowledge graph with a MongoDB URI.

Parameters

db_uri	the URI string used to connect to the database.
db_name	the name of the database.
collectionName	the name of the collection for triples.

Returns: true on success

Definition at line 96 of file MongoKnowledgeGraph.cpp.

                                                                            {
     auto tripleCollection = connect(db_uri, db_name, collectionName);
     if (tripleCollection) {
         initializeMongo(tripleCollection);
         dropSessionOrigins();
         return true;
     } else {
         return false;
     }
 }

◆ initializeBackend() [4/4]

bool knowrob::MongoKnowledgeGraph::initializeBackend	(	std::string_view	db_uri,
		std::string_view	db_name = `"knowrob"`,
		std::string_view	collectionName = `"triples"`
	)

Initialize the knowledge graph with a MongoDB URI.

Parameters

db_uri	the URI string used to connect to the database.
db_name	the name of the database.
collectionName	the name of the collection for triples.

Returns: true on success

◆ initializeMongo() [1/2]

void knowrob::MongoKnowledgeGraph::initializeMongo ( const std::shared_ptr< mongo::Collection > & tripleCollection )

protected

◆ initializeMongo() [2/2]

void MongoKnowledgeGraph::initializeMongo ( const std::shared_ptr< mongo::Collection > & tripleCollection )

protected

Definition at line 147 of file MongoKnowledgeGraph.cpp.

                                                                                                 {
     tripleCollection_ = tripleCollection;
     // make sure s/p/o index is defined
     tripleCollection_->createTripleIndex();
     // a collection with just a single document used for querying
     oneCollection_ = std::make_shared<Collection>(
             tripleCollection_->connection(),
             tripleCollection_->dbName().c_str(),
             MONGO_KG_ONE_COLLECTION);
     // Make sure there is one document in the "one" collection.
     // The collection is used to initiate a pipeline for a single input document.
     if (oneCollection_->empty()) {
         Document oneDoc(bson_new());
         bson_t scopeDoc, timeDoc;
         bson_decimal128_t infinity, zero;
         bson_decimal128_from_string(BSON_DECIMAL128_INF, &infinity);
         bson_decimal128_from_string("0", &zero);
         BSON_APPEND_DOCUMENT_BEGIN(oneDoc.bson(), "v_scope", &scopeDoc);
         BSON_APPEND_DOCUMENT_BEGIN(&scopeDoc, "time", &timeDoc);
         BSON_APPEND_DECIMAL128(&timeDoc, "since", &zero);
         BSON_APPEND_DECIMAL128(&timeDoc, "until", &infinity);
         bson_append_document_end(&scopeDoc, &timeDoc);
         bson_append_document_end(oneDoc.bson(), &scopeDoc);
         oneCollection_->storeOne(oneDoc);
     }
     // Create an object used for taxonomy operations
     taxonomy_ = std::make_shared<MongoTaxonomy>(tripleCollection_, oneCollection_, vocabulary_);
     // Add the connection to connection list
     connections_.emplace_back(tripleCollection_, oneCollection_, vocabulary_);
 }

◆ insertAll() [1/2]

bool MongoKnowledgeGraph::insertAll ( const TripleContainerPtr & triples )

overridevirtual

Add assertions to this backend.

Parameters

triples a set of triples.

Returns: true on success

Implements knowrob::Storage.

Definition at line 249 of file MongoKnowledgeGraph.cpp.

                                                                      {
     ConnectionRAII scoped(this);
     // only used in case triples do not specify origin field
     auto &fallbackOrigin = vocabulary_->importHierarchy()->defaultGraph();
     auto bulk = scoped.mongo.tripleCollection->createBulkOperation();
     std::vector<MongoTaxonomy::StringPair> subClassAssertions;
     std::vector<MongoTaxonomy::StringPair> subPropertyAssertions;
  
     std::for_each(triples->begin(), triples->end(),
                   [&](auto &data) {
                       MongoTriple mngTriple(vocabulary_, *data, fallbackOrigin,
                                             vocabulary_->isTaxonomicProperty(data->predicate().data()));
                       bulk->pushInsert(mngTriple.document().bson());
  
                       if (isSubClassOfIRI(data->predicate())) {
                           subClassAssertions.emplace_back(data->subject(), data->valueAsString());
                       } else if (isSubPropertyOfIRI(data->predicate())) {
                           subPropertyAssertions.emplace_back(data->subject(), data->valueAsString());
                       }
                   });
     bulk->execute();
  
     taxonomy_->updateInsert(subClassAssertions, subPropertyAssertions);
  
     return true;
 }

◆ insertAll() [2/2]

bool knowrob::MongoKnowledgeGraph::insertAll ( const TripleContainerPtr & triples )

overridevirtual

Add assertions to this backend.

Parameters

triples a set of triples.

Returns: true on success

Implements knowrob::Storage.

◆ insertOne() [1/2]

bool MongoKnowledgeGraph::insertOne ( const Triple & triple )

overridevirtual

Add an assertion to this backend.

Parameters

triple a triple.

Returns: true on success

Implements knowrob::Storage.

Definition at line 233 of file MongoKnowledgeGraph.cpp.

                                                             {
     ConnectionRAII scoped(this);
     auto &fallbackOrigin = vocabulary_->importHierarchy()->defaultGraph();
     bool isTaxonomic = vocabulary_->isTaxonomicProperty(tripleData.predicate());
     MongoTriple mngTriple(vocabulary_, tripleData, fallbackOrigin, isTaxonomic);
     scoped.mongo.tripleCollection->storeOne(mngTriple.document());
  
     if (isSubClassOfIRI(tripleData.predicate())) {
         taxonomy_->updateInsert({{tripleData.subject(), tripleData.valueAsString()}}, {});
     } else if (isSubPropertyOfIRI(tripleData.predicate())) {
         taxonomy_->updateInsert({}, {{tripleData.subject(), tripleData.valueAsString()}});
     }
  
     return true;
 }

◆ insertOne() [2/2]

bool knowrob::MongoKnowledgeGraph::insertOne ( const Triple & triple )

overridevirtual

Add an assertion to this backend.

Parameters

triple a triple.

Returns: true on success

Implements knowrob::Storage.

◆ isPersistent() [1/2]

bool knowrob::MongoKnowledgeGraph::isPersistent ( ) const

inlineoverridevirtual

Returns: true if the backend is persistent.

Implements knowrob::QueryableStorage.

Definition at line 110 of file MongoKnowledgeGraph.h.

110 { return true; }

◆ isPersistent() [2/2]

bool knowrob::MongoKnowledgeGraph::isPersistent ( ) const

inlineoverridevirtual

Returns: true if the backend is persistent.

Implements knowrob::QueryableStorage.

Definition at line 110 of file MongoKnowledgeGraph.h.

110 { return true; }

◆ isReadOnly() [1/2]

bool knowrob::MongoKnowledgeGraph::isReadOnly ( ) const

inline

Returns: true if only read operations are allowed.

Definition at line 65 of file MongoKnowledgeGraph.h.

65 { return isReadOnly_; }

◆ isReadOnly() [2/2]

bool knowrob::MongoKnowledgeGraph::isReadOnly ( ) const

inline

Returns: true if only read operations are allowed.

Definition at line 65 of file MongoKnowledgeGraph.h.

65 { return isReadOnly_; }

◆ iterate() [1/2]

void MongoKnowledgeGraph::iterate	(	mongo::TripleCursor &	cursor,
		const TripleVisitor &	visitor
	)

staticprotected

Definition at line 354 of file MongoKnowledgeGraph.cpp.

                                                                                     {
     TripleView tripleData;
     TriplePtr triplePtr;
     triplePtr.ptr = &tripleData;
     // Mongo cursor own the allocation, and the memory of a document will be deallocated by the cursor during iteration.
     // @see https://mongoc.org/libmongoc/current/mongoc_cursor_next.html
     // So it cannot be allowed that the visitor takes over ownership, hence owned is set to false.
     triplePtr.owned = false;
  
     // iterate over matching documents
     while (cursor.nextTriple(*triplePtr.ptr)) {
         visitor(triplePtr);
     }
 }

◆ iterate() [2/2]

static void knowrob::MongoKnowledgeGraph::iterate	(	mongo::TripleCursor &	cursor,
		const TripleVisitor &	visitor
	)

staticprotected

◆ lookup() [1/4]

BindingsCursorPtr MongoKnowledgeGraph::lookup ( const GraphTerm & query )

Lookup up a path of matching triples. The lookup pipeline includes a step for each expression in the vector in the same order as the expressions are ordered in the vector.

Parameters

query a path query

Returns: a getAnswerCursor over matching triples

Definition at line 456 of file MongoKnowledgeGraph.cpp.

                                                                     {
     ConnectionRAII scoped(this);
     return doLookup(query, scoped.mongo);
 }

◆ lookup() [2/4]

mongo::BindingsCursorPtr knowrob::MongoKnowledgeGraph::lookup ( const GraphTerm & query )

Lookup up a path of matching triples. The lookup pipeline includes a step for each expression in the vector in the same order as the expressions are ordered in the vector.

Parameters

query a path query

Returns: a getAnswerCursor over matching triples

◆ lookup() [3/4]

BindingsCursorPtr MongoKnowledgeGraph::lookup ( const TriplePattern & query )

Lookup up all matching triples.

Parameters

query a triple pattern

Returns: a getAnswerCursor over matching triples

Definition at line 451 of file MongoKnowledgeGraph.cpp.

                                                                         {
     ConnectionRAII scoped(this);
     return doLookup(query, scoped.mongo);
 }

◆ lookup() [4/4]

mongo::BindingsCursorPtr knowrob::MongoKnowledgeGraph::lookup ( const TriplePattern & query )

Lookup up all matching triples.

Parameters

query a triple pattern

Returns: a getAnswerCursor over matching triples

◆ match() [1/2]

void MongoKnowledgeGraph::match	(	const TriplePattern &	query,
		const TripleVisitor &	visitor
	)

overridevirtual

Parameters

query	a framed triple pattern.
visitor	a function that is called for each matching framed triple.

Reimplemented from knowrob::QueryableStorage.

Definition at line 421 of file MongoKnowledgeGraph.cpp.

                                                                                         {
     ConnectionRAII scoped(this);
     bool b_isTaxonomicProperty;
     if (query.propertyTerm()->termType() == TermType::ATOMIC) {
         b_isTaxonomicProperty = vocabulary_->isTaxonomicProperty(((Atomic *) query.propertyTerm().get())->stringForm());
     } else {
         b_isTaxonomicProperty = false;
     }
     TripleCursor cursor(scoped.mongo.tripleCollection);
     // filter documents by triple pattern
     MongoTriplePattern mngQuery(query, b_isTaxonomicProperty, vocabulary_->importHierarchy());
     cursor.filter(mngQuery.bson());
     iterate(cursor, visitor);
 }

◆ match() [2/2]

void knowrob::MongoKnowledgeGraph::match	(	const TriplePattern &	query,
		const TripleVisitor &	visitor
	)

overridevirtual

Parameters

query	a framed triple pattern.
visitor	a function that is called for each matching framed triple.

Reimplemented from knowrob::QueryableStorage.

◆ query() [1/2]

void MongoKnowledgeGraph::query	(	const GraphQueryPtr &	query,
		const BindingsHandler &	callback
	)

overridevirtual

Submits a graph query to this storage.

Parameters

query	a graph query
callback	a function that is called for each answer to the query.

Implements knowrob::QueryableStorage.

Definition at line 461 of file MongoKnowledgeGraph.cpp.

                                                                                        {
     const bool onlyOneSol = (q->ctx()->queryFlags & QUERY_FLAG_ONE_SOLUTION);
     ConnectionRAII scoped(this);
     BindingsCursorPtr cursor = doLookup(*q->term(), scoped.mongo);
     // NOTE: for some reason below causes a cursor error. looks like a bug in libmongoc to me!
     //if(query->flags() & QUERY_FLAG_ONE_SOLUTION) { cursor->limit(1); }
  
     while (true) {
         auto next = std::make_shared<Bindings>();
         if (cursor->nextBindings(next)) callback(next);
         else break;
         if (onlyOneSol) break;
     }
 }

◆ query() [2/2]

void knowrob::MongoKnowledgeGraph::query	(	const GraphQueryPtr &	query,
		const BindingsHandler &	callback
	)

overridevirtual

Submits a graph query to this storage.

Parameters

query	a graph query
callback	a function that is called for each answer to the query.

Implements knowrob::QueryableStorage.

◆ releaseStore() [1/2]

void MongoKnowledgeGraph::releaseStore ( mongo::TripleStore & store ) const

protected

Definition at line 89 of file MongoKnowledgeGraph.cpp.

                                                                     {
     std::lock_guard<std::mutex> lock(storeMutex_);
     if (connections_.size() < MONGO_KG_NUM_KEEP_ALIVE) {
         connections_.push_back(store);
     }
 }

◆ releaseStore() [2/2]

void knowrob::MongoKnowledgeGraph::releaseStore ( mongo::TripleStore & store ) const

protected

◆ removeAll() [1/2]

bool MongoKnowledgeGraph::removeAll ( const TripleContainerPtr & triples )

overridevirtual

Delete all matching statements from this backend.

Parameters

triples a set of triples.

Implements knowrob::Storage.

Definition at line 293 of file MongoKnowledgeGraph.cpp.

                                                                      {
     ConnectionRAII scoped(this);
     auto bulk = scoped.mongo.tripleCollection->createBulkOperation();
     std::vector<MongoTaxonomy::StringPair> subClassAssertions;
     std::vector<MongoTaxonomy::StringPair> subPropertyAssertions;
  
     std::for_each(triples->begin(), triples->end(),
                   [&](auto &data) {
                       MongoTriplePattern mngQuery(
                               TriplePattern(*data),
                       vocabulary_->isTaxonomicProperty(data->predicate()),
                               vocabulary_->importHierarchy());
                       bulk->pushRemoveOne(mngQuery.bson());
  
                       if (isSubClassOfIRI(data->predicate())) {
                           subClassAssertions.emplace_back(data->subject(), data->valueAsString());
                       } else if (isSubPropertyOfIRI(data->predicate())) {
                           subPropertyAssertions.emplace_back(data->subject(), data->valueAsString());
                       }
                   });
     bulk->execute();
  
     taxonomy_->updateRemove(subClassAssertions, subPropertyAssertions);
  
     return true;
 }

◆ removeAll() [2/2]

bool knowrob::MongoKnowledgeGraph::removeAll ( const TripleContainerPtr & triples )

overridevirtual

Delete all matching statements from this backend.

Parameters

triples a set of triples.

Implements knowrob::Storage.

◆ removeAllWithOrigin() [1/2]

bool MongoKnowledgeGraph::removeAllWithOrigin ( std::string_view origin )

overridevirtual

Delete all statements with a given origin from this backend.

Parameters

origin the origin of the statements to be deleted.

Implements knowrob::Storage.

Definition at line 328 of file MongoKnowledgeGraph.cpp.

                                                                       {
     return dropOrigin(graphName);
 }

◆ removeAllWithOrigin() [2/2]

bool knowrob::MongoKnowledgeGraph::removeAllWithOrigin ( std::string_view origin )

overridevirtual

Delete all statements with a given origin from this backend.

Parameters

origin the origin of the statements to be deleted.

Implements knowrob::Storage.

◆ removeOne() [1/2]

bool MongoKnowledgeGraph::removeOne ( const Triple & triple )

overridevirtual

Delete the first matching statement from this backend.

Parameters

triple a triple.

Implements knowrob::Storage.

Definition at line 276 of file MongoKnowledgeGraph.cpp.

                                                         {
     ConnectionRAII scoped(this);
     MongoTriplePattern mngQuery(
             TriplePattern(triple),
             vocabulary_->isTaxonomicProperty(triple.predicate()),
             vocabulary_->importHierarchy());
     scoped.mongo.tripleCollection->removeOne(mngQuery.document());
  
     if (isSubClassOfIRI(triple.predicate())) {
         taxonomy_->updateRemove({{triple.subject(), triple.valueAsString()}}, {});
     } else if (isSubPropertyOfIRI(triple.predicate())) {
         taxonomy_->updateRemove({}, {{triple.subject(), triple.valueAsString()}});
     }
  
     return true;
 }

◆ removeOne() [2/2]

bool knowrob::MongoKnowledgeGraph::removeOne ( const Triple & triple )

overridevirtual

Delete the first matching statement from this backend.

Parameters

triple a triple.

Implements knowrob::Storage.

◆ tripleCollection() [1/2]

auto knowrob::MongoKnowledgeGraph::tripleCollection ( )

inline

Returns: the collection for triples.

Definition at line 70 of file MongoKnowledgeGraph.h.

70 { return tripleCollection_; }

◆ tripleCollection() [2/2]

auto knowrob::MongoKnowledgeGraph::tripleCollection ( )

inline

Returns: the collection for triples.

Definition at line 70 of file MongoKnowledgeGraph.h.

70 { return tripleCollection_; }

Friends And Related Function Documentation

◆ ConnectionRAII

ConnectionRAII

friend

Definition at line 170 of file MongoKnowledgeGraph.h.

Member Data Documentation

◆ COLL_NAME_TESTS

const std::string MongoKnowledgeGraph::COLL_NAME_TESTS = "triples_test"

static

Definition at line 32 of file MongoKnowledgeGraph.h.

◆ COLL_NAME_TRIPLES

const std::string MongoKnowledgeGraph::COLL_NAME_TRIPLES = "triples"

static

Definition at line 31 of file MongoKnowledgeGraph.h.

◆ connections_

std::list< mongo::TripleStore > knowrob::MongoKnowledgeGraph::connections_

mutableprotected

Definition at line 137 of file MongoKnowledgeGraph.h.

◆ DB_NAME_KNOWROB

const std::string MongoKnowledgeGraph::DB_NAME_KNOWROB = "knowrob"

static

Definition at line 29 of file MongoKnowledgeGraph.h.

◆ DB_NAME_TESTS

const std::string MongoKnowledgeGraph::DB_NAME_TESTS = "knowrob_test"

static

Definition at line 30 of file MongoKnowledgeGraph.h.

◆ DB_URI_DEFAULT

const std::string MongoKnowledgeGraph::DB_URI_DEFAULT = "mongodb://localhost:27017"

static

Register the backend with the BackendManager

Definition at line 28 of file MongoKnowledgeGraph.h.

◆ isReadOnly_

bool knowrob::MongoKnowledgeGraph::isReadOnly_

protected

Definition at line 134 of file MongoKnowledgeGraph.h.

◆ oneCollection_

std::shared_ptr< mongo::Collection > knowrob::MongoKnowledgeGraph::oneCollection_

protected

Definition at line 132 of file MongoKnowledgeGraph.h.

◆ storeMutex_

std::mutex knowrob::MongoKnowledgeGraph::storeMutex_

mutableprotected

Definition at line 136 of file MongoKnowledgeGraph.h.

◆ taxonomy_

std::shared_ptr< mongo::MongoTaxonomy > knowrob::MongoKnowledgeGraph::taxonomy_

protected

Definition at line 133 of file MongoKnowledgeGraph.h.

◆ tripleCollection_

std::shared_ptr< mongo::Collection > knowrob::MongoKnowledgeGraph::tripleCollection_

protected

Definition at line 131 of file MongoKnowledgeGraph.h.

The documentation for this class was generated from the following files:

build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/storage/mongo/MongoKnowledgeGraph.h
src/storage/mongo/MongoKnowledgeGraph.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MongoKnowledgeGraph() [1/2]

◆ ~MongoKnowledgeGraph() [1/2]

◆ MongoKnowledgeGraph() [2/2]

◆ ~MongoKnowledgeGraph() [2/2]

Member Function Documentation

◆ acquireStore() [1/2]

◆ acquireStore() [2/2]

◆ batch() [1/2]

◆ batch() [2/2]

◆ batchOrigin() [1/2]

◆ batchOrigin() [2/2]

◆ connect() [1/4]

◆ connect() [2/4]

◆ connect() [3/4]

◆ connect() [4/4]

◆ count() [1/2]

◆ count() [2/2]

◆ dbName() [1/2]

◆ dbName() [2/2]

◆ dbURI() [1/2]

◆ dbURI() [2/2]

◆ drop() [1/2]

◆ drop() [2/2]

◆ dropOrigin() [1/2]

◆ dropOrigin() [2/2]

◆ foreach() [1/2]

◆ foreach() [2/2]

◆ getCollectionName() [1/2]

◆ getCollectionName() [2/2]

◆ getDBName() [1/2]

◆ getDBName() [2/2]

◆ getURI() [1/2]

◆ getURI() [2/2]

◆ initializeBackend() [1/4]

◆ initializeBackend() [2/4]

◆ initializeBackend() [3/4]

◆ initializeBackend() [4/4]

◆ initializeMongo() [1/2]

◆ initializeMongo() [2/2]

◆ insertAll() [1/2]

◆ insertAll() [2/2]

◆ insertOne() [1/2]

◆ insertOne() [2/2]

◆ isPersistent() [1/2]

◆ isPersistent() [2/2]

◆ isReadOnly() [1/2]

◆ isReadOnly() [2/2]

◆ iterate() [1/2]

◆ iterate() [2/2]

◆ lookup() [1/4]

◆ lookup() [2/4]

◆ lookup() [3/4]

◆ lookup() [4/4]

◆ match() [1/2]

◆ match() [2/2]

◆ query() [1/2]

◆ query() [2/2]

◆ releaseStore() [1/2]

◆ releaseStore() [2/2]

◆ removeAll() [1/2]

◆ removeAll() [2/2]

◆ removeAllWithOrigin() [1/2]

◆ removeAllWithOrigin() [2/2]

◆ removeOne() [1/2]

◆ removeOne() [2/2]

◆ tripleCollection() [1/2]

◆ tripleCollection() [2/2]

Friends And Related Function Documentation

◆ ConnectionRAII

Member Data Documentation