Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package apoc.couchbase;
import apoc.Extended;
import apoc.couchbase.document.CouchbaseByteArrayDocument;
import apoc.couchbase.document.CouchbaseJsonDocument;
import apoc.couchbase.document.CouchbaseQueryResult;
import apoc.couchbase.document.CouchbaseUtils;
import apoc.result.BooleanResult;
import apoc.util.MissingDependencyException;
import com.couchbase.client.java.Collection;
import com.couchbase.client.java.BinaryCollection;
import com.couchbase.client.java.Cluster;
import com.couchbase.client.java.json.JsonObject;
import com.couchbase.client.java.kv.GetResult;
import com.couchbase.client.java.kv.MutationResult;
import com.couchbase.client.java.query.QueryOptions;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
/**
* Neo4j Procedures for Couchbase integration.
*
* All of the operations performed against the Couchbase Server are done through
* a {@link CouchbaseConnection}.
*
* A {@link CouchbaseConnection} can be created via the {@link CouchbaseManager}
* .{@link CouchbaseManager#getConnection getConnection} method.
*
* Available operations are:
*
*
{@link #get} to retrieve a json document by its unique ID
*
{@link #exists} to check whether a json document with the given ID does exist
*
{@link #insert} to insert a json document if it does not exist already
*
{@link #upsert} to insert or overwrite a json document
*
{@link #remove} to remove the json document identified by its unique ID
*
{@link #replace} to replace the content of the json document identified by its unique ID
*
{@link #append} to append a json document's content to an existing one
*
{@link #prepend} to prepend a json document's content to an existing one
*
*
* N1QL query can be executed via the following methods:
*
*
{@link #query} for plain un-parameterized N1QL statements
*
{@link #posParamsQuery} for N1QL statements with positional parameters
*
{@link #namedParamsQuery} for N1QL statements with named parameters
*
* For instance, after inserting a JSON document this way:
*
*
* call apoc.couchbase.insert(['localhost'], 'default', 'artist:vincent_van_gogh', '{"firstName":"Vincent","secondName":"Willem","lastName":"Van Gogh","notableWorks":["Starry Night","Sunflowers","Bedroom in Arles","Portrait of Dr Gachet","Sorrow"]}')
*
*
* you can read the just inserted document via:
*
*
* call apoc.couchbase.query(['localhost'], 'default', 'select * from default') yield queryResult
* unwind queryResult as queryResultRow
* call apoc.convert.toMap(queryResultRow) yield value as queryResultRowMap
* with queryResultRowMap.default as content
* return content.firstName, content.secondName, content.lastName, content.notableWorks
*
*
* Using JSON fields instead of the "*" notation makes things a bit easier:
*
*
* call apoc.couchbase.query(['localhost'], 'default', 'select firstName, secondName, lastName, notableWorks from default') yield queryResult
* unwind queryResult as queryRow
* return queryRow.firstName, queryRow.secondName, queryRow.lastName, queryRow.notableWorks
*
*
* @author inserpio
* @since 15.8.2016
*/
@Extended
public class Couchbase {
/**
* Retrieves a {@link GetResult} by its unique ID.
*
* Example:
* call apoc.couchbase.get('localhost', 'default', 'artist:vincent_van_gogh') yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @return the found {@link CouchbaseJsonDocument} or null if not found
* @see Collection#get(String)
*/
@Procedure
@Description("apoc.couchbase.get(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - retrieves a couchbase json document by its unique ID.")
public Stream get(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final GetResult getResult = couchbaseConnection.get(documentId);
return getResult == null ? Stream.empty() : Stream.of(new CouchbaseJsonDocument(getResult, documentId));
}
}
/**
* Check whether a document with the given ID does exist.
*
* Example:
* CALL apoc.couchbase.exists('localhost', 'default', 'artist:vincent_van_gogh') yield value
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @return true if it exists, false otherwise.
* @see Collection#exists(String)
*/
@Procedure
@Description("apoc.couchbase.exists(hostOrKey, bucket, documentId, config) yield value - check whether a couchbase json document with the given ID does exist.")
public Stream exists(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
return Stream.of(new BooleanResult(couchbaseConnection.exists(documentId)));
}
}
/**
* Insert a document if it does not exist already.
*
* Example:
* CALL apoc.couchbase.insert('localhost', 'default', 'artist:vincent_van_gogh', '{"firstName":"Vincent","secondName":"Willem","lastName":"Van Gogh","notableWorks":["Starry Night","Sunflowers","Bedroom in Arles","Portrait of Dr Gachet","Sorrow"]}') yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @param json the JSON String representing the document to store
* @return the newly created document
* @see Collection#insert(String, Object)
*/
@Procedure
@Description("apoc.couchbase.insert(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - insert a couchbase json document with its unique ID.")
public Stream insert(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId, @Name("json") String json,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final MutationResult insert = couchbaseConnection.insert(documentId, json);
GetResult getResult = couchbaseConnection.get(documentId);
return Stream.of(new CouchbaseJsonDocument(getResult, documentId, insert.mutationToken().orElse(null)));
}
}
/**
* Insert or overwrite a document.
*
* Example:
* CALL apoc.couchbase.upsert('localhost', 'default', 'artist:vincent_van_gogh', '{"firstName":"Vincent","secondName":"Willem","lastName":"Van Gogh","notableWorks":["Starry Night","Sunflowers","Bedroom in Arles","Portrait of Dr Gachet","Sorrow"]}') yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @param json the JSON String representing the document to store
* @return the newly created or overwritten document or null in
* case of exception
* @see Collection#upsert(String, Object)
*/
@Procedure
@Description("apoc.couchbase.upsert(hostOrKey, bucket, documentId, jsonDocument) yield id, expiry, cas, mutationToken, content - insert or overwrite a couchbase json document with its unique ID.")
public Stream upsert(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId, @Name("json") String json,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final MutationResult upsert = couchbaseConnection.upsert(documentId, json);
GetResult getResult = couchbaseConnection.get(documentId);
return Stream.of(new CouchbaseJsonDocument(getResult, documentId, upsert.mutationToken().orElse(null)));
}
}
/**
* Append a document's content to an existing one.
*
* Example:
* CALL apoc.couchbase.append('localhost', 'default', 'artist:vincent_van_gogh', 'hello world'.getBytes()) yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @param content the byte[] representing the document to append
* @return the updated document or null in case of exception
* @see BinaryCollection#append(String, byte[])
*/
@Procedure
@Description("apoc.couchbase.append(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - append a couchbase json document to an existing one.")
public Stream append(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId, @Name("content") byte[] content,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final MutationResult append = couchbaseConnection.append(documentId, content);
GetResult getResult = couchbaseConnection.getBinary(documentId);
return Stream.of(new CouchbaseByteArrayDocument(getResult, documentId, append.mutationToken().orElse(null)));
}
}
/**
* Prepend a document's content to an existing one.
*
* Example:
* CALL apoc.couchbase.prepend('localhost', 'default', 'artist:vincent_van_gogh', 'hello world'.getBytes()) yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @param content the byte[] representing the document to prepend
* @return the updated document or null in case of exception
* @see BinaryCollection#prepend(String, byte[])
*/
@Procedure
@Description("apoc.couchbase.prepend(hostOrKey, bucket, documentId, content, config) yield id, expiry, cas, mutationToken, content - prepend a couchbase json document to an existing one.")
public Stream prepend(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId, @Name("content") byte[] content,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final MutationResult prepend = couchbaseConnection.prepend(documentId, content);
GetResult getResult = couchbaseConnection.getBinary(documentId);
return Stream.of(new CouchbaseByteArrayDocument(getResult, documentId, prepend.mutationToken().orElse(null)));
}
}
/**
* Removes the document identified by its unique ID.
*
* Example:
* CALL apoc.couchbase.remove(['localhost'], 'default', 'artist:vincent_van_gogh') yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @return the removed document
* @see Collection#remove(String)
*/
@Procedure
@Description("apoc.couchbase.remove(hostOrKey, bucket, documentId, config) yield id, expiry, cas, mutationToken, content - remove the couchbase json document identified by its unique ID.")
public Stream remove(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
GetResult getResult = couchbaseConnection.get(documentId);
final MutationResult remove = couchbaseConnection.remove(documentId);
return Stream.of(new CouchbaseJsonDocument(getResult, documentId, remove.mutationToken().orElse(null)));
}
}
/**
* Replace the content of the document identified by its unique
* ID.
*
* Example:
* CALL apoc.couchbase.replace('localhost', 'default', 'artist:vincent_van_gogh', '{"firstName":"Vincent","secondName":"Willem","lastName":"Van Gogh","notableWorks":["Starry Night","Sunflowers","Bedroom in Arles","Portrait of Dr Gachet","Sorrow"],"placeOfBirth":"Zundert","placeOfDeath":" Auvers-sur-Oise"}') yield id, expiry, cas, mutationToken, content
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param documentId the unique ID of the document
* @param json the JSON String representing the document to prepend
* @return the replaced document
* @see Collection#replace(String, Object)
*/
@Procedure
@Description("apoc.couchbase.replace(hostOrKey, bucket, documentId, jsonDocument, config) yield id, expiry, cas, mutationToken, content - replace the content of the couchbase json document identified by its unique ID.")
public Stream replace(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("documentId") String documentId, @Name("json") String json,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
final MutationResult replace = couchbaseConnection.replace(documentId, json);
GetResult getResult = couchbaseConnection.get(documentId);
return Stream.of(new CouchbaseJsonDocument(getResult, documentId, replace.mutationToken().orElse(null)));
}
}
/**
* Executes a plain un-parameterized N1QL statement.
*
* Example:
* CALL apoc.couchbase.query('localhost', 'default', 'select * from default where lastName = "Van Gogh"']) yield queryResult
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param statement the raw statement string to execute
* @return the list of {@link JsonObject}s retrieved by this query in the form
* of a {@link CouchbaseQueryResult}
* @see Cluster#query(String)
*/
@Procedure
@Description("apoc.couchbase.query(hostOrKey, bucket, statement, config) yield queryResult - executes a plain un-parameterized N1QL statement.")
public Stream query(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("statement") String statement,
@Name(value = "config", defaultValue = "{}") Map config) {
try (CouchbaseConnection couchbaseConnection = getCouchbaseConnection(hostOrKey, bucket, config)) {
List statementResult = couchbaseConnection.executeStatement(statement);
final CouchbaseQueryResult result = CouchbaseUtils.convertToCouchbaseQueryResult(statementResult);
return result == null ? Stream.empty() : Stream.of(result);
}
}
/**
* Executes a N1QL statement with positional parameters.
*
* Example:
* CALL apoc.couchbase.posParamsQuery('localhost', 'default', 'select * from default where lastName = $1', ['Van Gogh']) yield queryResult
*
* @param hostOrKey a URI to use when connecting to the cluster reference or a configuration key
* @param bucket the bucket to open; if null is passed then it's used the "default"
* bucket
* @param statement the raw statement string to execute (containing positional
* placeholders: $1, $2, ...)
* @param params the values for the positional placeholders in statement
* @return the list of {@link JsonObject}s retrieved by this query in the form
* of a {@link CouchbaseQueryResult}
* @see Cluster#query(String, QueryOptions)
*/
@Procedure
@Description("apoc.couchbase.posParamsQuery(hostOrKey, bucket, statement, params, config) yield queryResult - executes a N1QL statement with positional parameters.")
public Stream posParamsQuery(@Name("hostOrKey") String hostOrKey, @Name("bucket") String bucket,
@Name("statement") String statement, @Name("params") List
