apoc.mongodb.MongoDB Maven / Gradle / Ivy
package apoc.mongodb;
import apoc.Extended;
import apoc.result.LongResult;
import apoc.result.MapResult;
import apoc.util.MissingDependencyException;
import apoc.util.UrlResolver;
import org.bson.types.ObjectId;
import org.neo4j.logging.Log;
import org.neo4j.procedure.Context;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;
import java.io.Closeable;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Stream;
/*
also see https://docs.mongodb.com/ecosystem/tools/http-interfaces/#simple-rest-api
// Load courses from MongoDB
CALL apoc.load.json('http://127.0.0.1:28017/course_catalog/course/') YIELD value
UNWIND value.rows AS course
// Create Course nodes
MERGE (c:Course {_id: course._id['$oid']})
ON CREATE SET c.name = course.name
WITH course, c
// Create Category nodes and connect to Course
FOREACH (category IN course.categories |
MERGE (cat:Category {_id: category.id})
ON CREATE SET cat.name = category.name
MERGE (c)-[:HAS_CATEGORY]->(cat)
)
WITH course, c
// Create University nodes and connect to Course
UNWIND course.universities AS univ
WITH c, univ WHERE univ.id IS NOT NULL
MERGE (u:University {id: univ.id})
ON CREATE SET u.location = univ.location,
u.shortName = univ.shortName,
u.url = univ.website
MERGE (c)-[:OFFERED_BY]->(u)
*/
@Extended
public class MongoDB {
@Context
public Log log;
@Deprecated
@Procedure
@Description("apoc.mongodb.get(host-or-key,db,collection,query,[compatibleValues=false|true],skip-or-null,limit-or-null,[extractReferences=false|true],[objectIdAsMap=true|false]) yield value - perform a find operation on mongodb collection")
public Stream get(@Name("host") String hostOrKey,
@Name("db") String db,
@Name("collection") String collection,
@Name("query") Map query,
@Name(value = "compatibleValues", defaultValue = "false") boolean compatibleValues,
@Name(value = "skip", defaultValue = "0") Long skip,
@Name(value = "limit", defaultValue = "0") Long limit,
@Name(value = "extractReferences", defaultValue = "false") boolean extractReferences,
@Name(value = "objectIdAsMap", defaultValue = "true") boolean objectIdAsMap) {
return executeMongoQuery(hostOrKey, db, collection, compatibleValues,
extractReferences, objectIdAsMap, coll -> coll.all(query, skip, limit).map(MapResult::new),
e -> log.error("apoc.mongodb.get - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "], compatibleValues = [" + compatibleValues + "], skip = [" + skip + "], limit = [" + limit + "]", e));
}
@Deprecated
@Procedure
@Description("apoc.mongodb.count(host-or-key,db,collection,query) yield value - perform a find operation on mongodb collection")
public Stream count(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("query") Map query) {
return executeMongoQuery(hostOrKey, db, collection, false,
false,
false, coll -> {
long count = coll.count(query);
return Stream.of(new LongResult(count));
},
e -> log.error("apoc.mongodb.count - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "]",e));
}
private Coll getColl(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection,
boolean compatibleValues, boolean extractReferences, boolean objectIdAsMap) {
String url = getMongoDBUrl(hostOrKey);
return Coll.Factory.create(url, db, collection, compatibleValues, extractReferences, objectIdAsMap);
}
@Deprecated
@Procedure
@Description("apoc.mongodb.first(host-or-key,db,collection,query,[compatibleValues=false|true],[extractReferences=false|true],[objectIdAsMap=true|false]) yield value - perform a first operation on mongodb collection")
public Stream first(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("query") Map query, @Name(value = "compatibleValues", defaultValue = "true") boolean compatibleValues,
@Name(value = "extractReferences", defaultValue = "false") boolean extractReferences,
@Name(value = "objectIdAsMap", defaultValue = "true") boolean objectIdAsMap) {
return executeMongoQuery(hostOrKey, db, collection, compatibleValues,
extractReferences,
objectIdAsMap, coll -> {
Map result = coll.first(query);
return result == null || result.isEmpty() ? Stream.empty() : Stream.of(new MapResult(result));
},
e -> log.error("apoc.mongodb.first - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "], compatibleValues = [" + compatibleValues + "]",e));
}
@Deprecated
@Procedure
@Description("apoc.mongodb.find(host-or-key,db,collection,query,projection,sort,[compatibleValues=false|true],skip-or-null,limit-or-null,[extractReferences=false|true],[objectIdAsMap=true|false]) yield value - perform a find,project,sort operation on mongodb collection")
public Stream find(@Name("host") String hostOrKey,
@Name("db") String db,
@Name("collection") String collection,
@Name("query") Map query,
@Name("project") Map project,
@Name("sort") Map sort,
@Name(value = "compatibleValues", defaultValue = "false") boolean compatibleValues,
@Name(value = "skip", defaultValue = "0") Long skip,
@Name(value = "limit", defaultValue = "0") Long limit,
@Name(value = "extractReferences", defaultValue = "false") boolean extractReferences,
@Name(value = "objectIdAsMap", defaultValue = "true") boolean objectIdAsMap) {
return executeMongoQuery(hostOrKey, db, collection, compatibleValues,
extractReferences, objectIdAsMap, coll -> coll.find(query, project, sort, skip, limit).map(MapResult::new),
e -> log.error("apoc.mongodb.find - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "], project = [" + project + "], sort = [" + sort + "], compatibleValues = [" + compatibleValues + "], skip = [" + skip + "], limit = [" + limit + "]",e));
}
@Deprecated
@Procedure
@Description("apoc.mongodb.insert(host-or-key,db,collection,documents) - inserts the given documents into the mongodb collection")
public void insert(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("documents") List> documents) {
try (Coll coll = getMongoColl(hostOrKey, db, collection, false, false, false)) {
coll.insert(documents);
} catch (Exception e) {
log.error("apoc.mongodb.insert - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], documents = [" + documents + "]",e);
throw new RuntimeException(e);
}
}
@Deprecated
@Procedure
@Description("apoc.mongodb.delete(host-or-key,db,collection,query) - delete the given documents from the mongodb collection and returns the number of affected documents")
public Stream delete(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("query") Map query) {
return executeMongoQuery(hostOrKey, db, collection, false,
false, false, coll -> Stream.of(new LongResult(coll.delete(query))),
e -> log.error("apoc.mongodb.delete - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "]",e));
}
@Deprecated
@Procedure
@Description("apoc.mongodb.update(host-or-key,db,collection,query,update) - updates the given documents from the mongodb collection and returns the number of affected documents")
public Stream update(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("query") Map query, @Name("update") Map update) {
return executeMongoQuery(hostOrKey, db, collection, false,
false, false, coll -> Stream.of(new LongResult(coll.update(query, update))),
e -> log.error("apoc.mongodb.update - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], query = [" + query + "], update = [" + update + "]",e));
}
@Procedure("apoc.mongodb.get.byObjectId")
@Description("apoc.mongodb.get.byObjectId(hostOrKey, db, collection, objectIdValue, config(default:{})) - get the document by Object id value")
public Stream byObjectId(@Name("host") String hostOrKey, @Name("db") String db, @Name("collection") String collection, @Name("objectIdValue") String objectIdValue, @Name(value = "config", defaultValue = "{}") Map config) {
MongoDbConfig conf = new MongoDbConfig(config);
return executeMongoQuery(hostOrKey, db, collection, conf.isCompatibleValues(), conf.isExtractReferences(), conf.isObjectIdAsMap(),
coll -> {
Map result = coll.first(Map.of(conf.getIdFieldName(), new ObjectId(objectIdValue)));
return result == null || result.isEmpty() ? Stream.empty() : Stream.of(new MapResult(result));
},
e -> log.error("apoc.mongo.get.byObjectId - hostOrKey = [" + hostOrKey + "], db = [" + db + "], collection = [" + collection + "], objectIdValue = [" + objectIdValue + "]",e));
}
private String getMongoDBUrl(String hostOrKey) {
return new UrlResolver("mongodb", "localhost", 27017).getUrl("mongodb", hostOrKey);
}
private Coll getMongoColl(String hostOrKey, String db, String collection, boolean compatibleValues,
boolean extractReferences, boolean objectIdAsMap) {
Coll coll = null;
try {
coll = getColl(hostOrKey, db, collection, compatibleValues, extractReferences, objectIdAsMap);
} catch (NoClassDefFoundError e) {
throw new MissingDependencyException("Cannot find the jar into the plugins folder. \n" +
"Please put these jar in the plugins folder :\n\n" +
"bson-x.y.z.jar\n" +
"\n" +
"mongo-java-driver-x.y.z.jar\n" +
"\n" +
"mongodb-driver-x.y.z.jar\n" +
"\n" +
"mongodb-driver-core-x.y.z.jar\n" +
"\n" +
"jackson-annotations-x.y.z.jar\n\njackson-core-x.y.z.jar\n\njackson-databind-x.y.z.jar\n\nSee the documentation: https://neo4j-contrib.github.io/neo4j-apoc-procedures/#_interacting_with_mongodb");
}
return coll;
}
interface Coll extends Closeable {
Map first(Map params);
Stream> all(Map query, Long skip, Long limit);
long count(Map query);
Stream> find(Map query, Map project, Map sort, Long skip, Long limit);
void insert(List> docs);
long update(Map query, Map update);
long delete(Map query);
default void safeClose() {
try {
this.close();
} catch (Exception e) {
e.printStackTrace();
}
}
class Factory {
public static Coll create(String url, String db, String coll, boolean compatibleValues,
boolean extractReferences,
boolean objectIdAsMap) {
try {
return new MongoDBColl(url, db, coll, compatibleValues, extractReferences, objectIdAsMap);
} catch (Exception e) {
throw new RuntimeException("Could not create MongoDBClientWrapper instance", e);
}
}
}
}
private Stream executeMongoQuery(String hostOrKey, String db, String collection, boolean compatibleValues,
boolean extractReferences, boolean objectIdAsMap, Function> execute, Consumer onError) {
Coll coll = null;
try {
coll = getMongoColl(hostOrKey, db, collection, compatibleValues, extractReferences, objectIdAsMap);
return execute.apply(coll).onClose(coll::safeClose);
} catch (Exception e) {
if (coll != null) {
coll.safeClose();
}
onError.accept(e);
throw new RuntimeException(e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy