[
https://issues.apache.org/jira/browse/GORA-650?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17344734#comment-17344734
]
ASF GitHub Bot commented on GORA-650:
-------------------------------------
kamaci commented on a change in pull request #218:
URL: https://github.com/apache/gora/pull/218#discussion_r632676232
##########
File path:
gora-arangodb/src/main/java/org/apache/gora/arangodb/store/ArangoDBStore.java
##########
@@ -0,0 +1,690 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+package org.apache.gora.arangodb.store;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.util.Base64;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+import java.util.List;
+import java.util.ArrayList;
+
+import com.arangodb.ArangoDB;
+import com.arangodb.entity.BaseDocument;
+import org.apache.avro.Schema;
+import org.apache.avro.util.Utf8;
+import org.apache.gora.arangodb.query.ArangoDBQuery;
+import org.apache.gora.persistency.impl.BeanFactoryImpl;
+import org.apache.gora.persistency.impl.DirtyListWrapper;
+import org.apache.gora.persistency.impl.DirtyMapWrapper;
+import org.apache.gora.persistency.impl.PersistentBase;
+import org.apache.gora.query.PartitionQuery;
+import org.apache.gora.query.Query;
+import org.apache.gora.query.Result;
+import org.apache.gora.query.impl.PartitionQueryImpl;
+import org.apache.gora.store.impl.DataStoreBase;
+import org.apache.gora.util.AvroUtils;
+import org.apache.gora.util.ClassLoadingUtils;
+import org.apache.gora.util.GoraException;
+
+
+/**
+ * {@inheritDoc}
+ * {@link org.apache.gora.arangodb.store.ArangoDBStore} is the primary class
+ * responsible for facilitating GORA CRUD operations on ArangoDB documents.
+ */
+public class ArangoDBStore<K, T extends PersistentBase> extends
DataStoreBase<K, T> {
+
+ public static final String DEFAULT_MAPPING_FILE =
"/gora-arangodb-mapping.xml";
+ private ArangoDBStoreParameters arangoDbStoreParams;
+ private ArangoDBMapping arangoDBMapping;
+ private ArangoDB arangoDB;
+
+ /**
+ * {@inheritDoc}
+ * Initialize the ArangoDB dataStore by {@link Properties} parameters.
+ *
+ * @param keyClass key class type for dataStore.
+ * @param persistentClass persistent class type for dataStore.
+ * @param properties ArangoDB dataStore properties EG:- ArangoDB client
credentials.
+ */
+ @Override
+ public void initialize(Class<K> keyClass, Class<T> persistentClass,
Properties properties) throws GoraException {
+ super.initialize(keyClass, persistentClass, properties);
+ try {
+ arangoDbStoreParams = ArangoDBStoreParameters.load(properties);
+ arangoDB = new ArangoDB.Builder()
+ .host(arangoDbStoreParams.getServerHost(),
+ Integer.valueOf(arangoDbStoreParams.getServerPort()))
+ .user(arangoDbStoreParams.getUserName())
+ .password(arangoDbStoreParams.getUserPassword())
+
.maxConnections(Integer.valueOf(arangoDbStoreParams.getConnectionPoolSize()))
+ .build();
+ if (!arangoDB.db(arangoDbStoreParams.getDatabaseName()).exists())
+ arangoDB.createDatabase(arangoDbStoreParams.getDatabaseName());
+
+ ArangoDBMappingBuilder<K, T> builder = new
ArangoDBMappingBuilder<>(this);
+ arangoDBMapping =
builder.fromFile(arangoDbStoreParams.getMappingFile()).build();
+ if (!schemaExists()) {
+ createSchema();
+ }
+ } catch (Exception e) {
+ LOG.error("Error while initializing ArangoDB dataStore: {}",
+ new Object[]{e.getMessage()});
+ throw new RuntimeException(e);
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String getSchemaName(final String mappingSchemaName,
+ final Class<?> persistentClass) {
+ return super.getSchemaName(mappingSchemaName, persistentClass);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String getSchemaName() {
+ return arangoDBMapping.getDocumentClass();
+ }
+
+ /**
+ * {@inheritDoc}
+ * Create a new class of ArangoDB documents if necessary. Enforce specified
schema over the document class.
+ */
+ @Override
+ public void createSchema() throws GoraException {
+ if (schemaExists()) {
+ return;
+ }
+ try {
+ arangoDB.db(arangoDbStoreParams.getDatabaseName())
+ .createCollection(arangoDBMapping.getDocumentClass());
+
+ } catch (Exception e) {
+ throw new GoraException(e);
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ * Deletes enforced schema over ArangoDB Document class.
+ */
+ @Override
+ public void deleteSchema() throws GoraException {
+ try {
+ arangoDB.db(arangoDbStoreParams.getDatabaseName())
+ .collection(arangoDBMapping.getDocumentClass()).drop();
+ } catch (Exception e) {
+ throw new GoraException(e);
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ * Check whether there exist a schema enforced over ArangoDB document class.
+ */
+ @Override
+ public boolean schemaExists() throws GoraException {
+ try {
+ return arangoDB
+ .db(arangoDbStoreParams.getDatabaseName())
+ .collection(arangoDBMapping.getDocumentClass()).exists();
+ } catch (Exception e) {
+ throw new GoraException(e);
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public T get(K key, String[] fields) throws GoraException {
+ try {
+ boolean isExists = arangoDB.db(arangoDbStoreParams.getDatabaseName())
+
.collection(arangoDBMapping.getDocumentClass()).documentExists(key.toString());
+ if (isExists) {
+ String[] dbFields = getFieldsToQuery(fields);
+ BaseDocument document =
arangoDB.db(arangoDbStoreParams.getDatabaseName())
+
.collection(arangoDBMapping.getDocumentClass()).getDocument(key.toString(),
BaseDocument.class);
+ return convertArangoDBDocToAvroBean(document, dbFields);
+ } else {
+ return null;
+ }
+ } catch (Exception e) {
+ throw new GoraException(e);
+ }
+ }
+
+ public T convertArangoDBDocToAvroBean(final BaseDocument obj, final String[]
fields) throws GoraException {
+ T persistent = newPersistent();
+ String[] dbFields = getFieldsToQuery(fields);
+ for (String f : dbFields) {
+ String docf = arangoDBMapping.getDocumentField(f);
+ if (docf == null || !obj.getProperties().containsKey(docf))
+ continue;
+
+ ArangoDBMapping.DocumentFieldType storeType =
arangoDBMapping.getDocumentFieldType(docf);
+ Schema.Field field = fieldMap.get(f);
+ Schema fieldSchema = field.schema();
+
+ LOG.debug("Load from ODocument, field:{}, schemaType:{}, docField:{},
storeType:{}",
+ new Object[]{field.name(), fieldSchema.getType(), docf,
storeType});
+ Object result = convertDocFieldToAvroField(fieldSchema, storeType,
field, docf, obj);
+ persistent.put(field.pos(), result);
+ }
+ persistent.clearDirty();
+ return persistent;
+ }
+
+ private Object convertDocFieldToAvroField(final Schema fieldSchema,
+ final
ArangoDBMapping.DocumentFieldType storeType,
+ final Schema.Field field,
+ final String docf,
+ final BaseDocument obj) throws
GoraException {
+ Object result = null;
+ switch (fieldSchema.getType()) {
+ case MAP:
+ result = convertDocFieldToAvroMap(docf, fieldSchema, obj, field,
storeType);
+ break;
+ case ARRAY:
+ result = convertDocFieldToAvroList(docf, fieldSchema, obj, field,
storeType);
+ break;
+ case RECORD:
+ BaseDocument record = (BaseDocument) obj.getAttribute(docf);
+ if (record == null) {
+ result = null;
+ break;
+ }
+ result = convertAvroBeanToArangoDBDoc(fieldSchema, record);
+ break;
+ case BOOLEAN:
+ result = Boolean.valueOf(obj.getAttribute(docf).toString());
+ break;
+ case DOUBLE:
+ result = Double.valueOf(obj.getAttribute(docf).toString());
+ break;
+ case FLOAT:
+ result = Float.valueOf(obj.getAttribute(docf).toString());
+ break;
+ case INT:
+ result = Integer.valueOf(obj.getAttribute(docf).toString());
+ break;
+ case LONG:
+ result = Long.valueOf(obj.getAttribute(docf).toString());
+ break;
+ case STRING:
+ result = new Utf8(obj.getAttribute(docf).toString());
+ ;
+ break;
+ case ENUM:
+ result = AvroUtils.getEnumValue(fieldSchema,
obj.getAttribute(docf).toString());
+ break;
+ case BYTES:
+ case FIXED:
+ if (!obj.getProperties().containsKey(docf)) {
+ result = null;
+ break;
+ }
+ result = ByteBuffer.wrap(Base64
+ .getDecoder()
+ .decode(obj.getAttribute(docf).toString()));
+ break;
+ case NULL:
+ result = null;
+ break;
+ case UNION:
+ result = convertDocFieldToAvroUnion(fieldSchema, storeType, field,
docf, obj);
+ break;
+ default:
+ LOG.warn("Unable to read {}", docf);
+ break;
+ }
+ return result;
+ }
+
+ private Object convertDocFieldToAvroUnion(final Schema fieldSchema,
+ final
ArangoDBMapping.DocumentFieldType storeType,
+ final Schema.Field field,
+ final String docf,
+ final BaseDocument doc) throws
GoraException {
+ Object result;
+ Schema.Type type0 = fieldSchema.getTypes().get(0).getType();
+ Schema.Type type1 = fieldSchema.getTypes().get(1).getType();
+
+ if (!type0.equals(type1)
+ && (type0.equals(Schema.Type.NULL) ||
type1.equals(Schema.Type.NULL))) {
+ Schema innerSchema = null;
+ if (type0.equals(Schema.Type.NULL)) {
+ innerSchema = fieldSchema.getTypes().get(1);
+ } else {
+ innerSchema = fieldSchema.getTypes().get(0);
+ }
+
+ LOG.debug("Load from ODocument (UNION), schemaType:{}, docField:{},
storeType:{}",
+ new Object[]{innerSchema.getType(), docf, storeType});
+
+ result = convertDocFieldToAvroField(innerSchema, storeType, field, docf,
doc);
+ } else {
+ throw new GoraException("ArangoDBStore only supports Union of two types
field.");
+ }
+ return result;
+ }
+
+ private Object convertAvroBeanToArangoDBDoc(final Schema fieldSchema,
+ final BaseDocument doc) throws
GoraException {
+ Object result;
+ Class<?> clazz = null;
+ try {
+ clazz = ClassLoadingUtils.loadClass(fieldSchema.getFullName());
+ } catch (Exception e) {
+ throw new GoraException(e);
+ }
+ PersistentBase record = (PersistentBase) new BeanFactoryImpl(keyClass,
clazz).newPersistent();
+ for (Schema.Field recField : fieldSchema.getFields()) {
+ Schema innerSchema = recField.schema();
+ ArangoDBMapping.DocumentFieldType innerStoreType = arangoDBMapping
+ .getDocumentFieldType(recField.name());
+ String innerDocField = arangoDBMapping.getDocumentField(recField.name())
!= null ? arangoDBMapping
+ .getDocumentField(recField.name()) : recField.name();
+ LOG.debug("Load from ODocument (RECORD), field:{}, schemaType:{},
docField:{}, storeType:{}",
+ new Object[]{recField.name(), innerSchema.getType(),
innerDocField,
+ innerStoreType});
+ record.put(recField.pos(),
+ convertDocFieldToAvroField(innerSchema, innerStoreType,
recField, innerDocField,
+ doc));
+ }
+ result = record;
+ return result;
+ }
+
+ private Object convertDocFieldToAvroList(final String docf,
+ final Schema fieldSchema,
+ final BaseDocument doc,
+ final Schema.Field f,
+ final
ArangoDBMapping.DocumentFieldType storeType) throws GoraException {
+
+ if (storeType == ArangoDBMapping.DocumentFieldType.LIST) {
+ List<Object> list = (List<Object>) doc.getAttribute(docf);
+ List<Object> rlist = new ArrayList<>();
+ if (list == null) {
+ return new DirtyListWrapper(rlist);
+ }
+
+ for (Object item : list) {
+ BaseDocument innerDoc = new BaseDocument();
+ innerDoc.addAttribute("item", item);
+ Object o = convertDocFieldToAvroField(fieldSchema.getElementType(),
storeType, f,
+ "item", innerDoc);
+ rlist.add(o);
+ }
+ return new DirtyListWrapper<>(rlist);
+ }
+ return null;
+ }
+
+ private Object convertDocFieldToAvroMap(final String docf, final Schema
fieldSchema,
+ final BaseDocument doc, final
Schema.Field f,
+ final
ArangoDBMapping.DocumentFieldType storeType) throws GoraException {
+ if (storeType == ArangoDBMapping.DocumentFieldType.MAP) {
+ Map<String, Object> map = (Map<String, Object>) doc.getAttribute(docf);
+ Map<Utf8, Object> rmap = new HashMap<>();
+ if (map == null) {
+ return new DirtyMapWrapper(rmap);
+ }
+
+ for (Map.Entry entry : map.entrySet()) {
+ String mapKey = entry.getKey().toString();
+ Object o = convertDocFieldToAvroField(fieldSchema.getValueType(),
storeType, f, mapKey,
+ decorateOTrackedMapToODoc(map));
+ rmap.put(new Utf8(mapKey), o);
+ }
+ return new DirtyMapWrapper<>(rmap);
+ } else {
Review comment:
No need to write an `else` after an `if` with `return`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Add datastore for ArangoDB
> --------------------------
>
> Key: GORA-650
> URL: https://issues.apache.org/jira/browse/GORA-650
> Project: Apache Gora
> Issue Type: New Feature
> Affects Versions: 0.9
> Reporter: Kevin Ratnasekera
> Priority: Major
> Labels: gsoc2020
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> May be we should consider extending our multimodal datastore support with
> ArangoDB. [1]
> [1] https://www.arangodb.com/why-arangodb/multi-model/
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
