Support graph read mode and set list aggregate property (#1332)

* add GraphReadMode
* add ReadFrequency
* support aggregate type set and list
* upgrade api version to 0.59

Change-Id: I5db5a1bc91c14b659bbba27c2ad15b40245bc62a

hugegraph-api/pom.xml

@@ -125,7 +125,7 @@
                             </addDefaultSpecificationEntries>
                         </manifest>
                         <manifestEntries>
-                            <Implementation-Version>0.58.0.0</Implementation-Version>
+                            <Implementation-Version>0.59.0.0</Implementation-Version>
                         </manifestEntries>
                     </archive>
                 </configuration>

hugegraph-api/src/main/java/com/baidu/hugegraph/api/profile/GraphsAPI.java

@@ -49,6 +49,7 @@
 import com.baidu.hugegraph.core.GraphManager;
 import com.baidu.hugegraph.server.RestServer;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.GraphReadMode;
 import com.baidu.hugegraph.util.E;
 import com.baidu.hugegraph.util.Log;
 import com.codahale.metrics.annotation.Timed;
@@ -167,4 +168,39 @@ public Map<String, GraphMode> mode(@Context GraphManager manager,
         HugeGraph g = graph(manager, name);
         return ImmutableMap.of("mode", g.mode());
     }
+
+    @PUT
+    @Timed
+    @Path("{name}/graph_read_mode")
+    @Consumes(APPLICATION_JSON)
+    @Produces(APPLICATION_JSON_WITH_CHARSET)
+    @RolesAllowed("admin")
+    public Map<String, GraphReadMode> graphReadMode(
+                                      @Context GraphManager manager,
+                                      @PathParam("name") String name,
+                                      GraphReadMode readMode) {
+        LOG.debug("Set graph read mode to: '{}' of graph '{}'",
+                  readMode, name);
+
+        E.checkArgument(readMode != null,
+                        "Graph read mode can't be null");
+        HugeGraph g = graph(manager, name);
+        g.readMode(readMode);
+        return ImmutableMap.of("graph_read_mode", readMode);
+    }
+
+    @GET
+    @Timed
+    @Path("{name}/graph_read_mode")
+    @Consumes(APPLICATION_JSON)
+    @Produces(APPLICATION_JSON_WITH_CHARSET)
+    @RolesAllowed({"admin", "$owner=$name"})
+    public Map<String, GraphReadMode> graphReadMode(
+                                      @Context GraphManager manager,
+                                      @PathParam("name") String name) {
+        LOG.debug("Get graph read mode of graph '{}'", name);
+
+        HugeGraph g = graph(manager, name);
+        return ImmutableMap.of("graph_read_mode", g.readMode());
+    }
 }

hugegraph-api/src/main/java/com/baidu/hugegraph/api/schema/PropertyKeyAPI.java

@@ -49,6 +49,7 @@
 import com.baidu.hugegraph.type.define.Cardinality;
 import com.baidu.hugegraph.type.define.DataType;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.ReadFrequency;
 import com.baidu.hugegraph.util.E;
 import com.baidu.hugegraph.util.Log;
 import com.codahale.metrics.annotation.Timed;
@@ -182,6 +183,8 @@ private static class JsonPropertyKey implements Checkable {
         public DataType dataType;
         @JsonProperty("aggregate_type")
         public AggregateType aggregateType;
+        @JsonProperty("read_frequency")
+        public ReadFrequency readFrequency;
         @JsonProperty("properties")
         public String[] properties;
         @JsonProperty("user_data")
@@ -221,6 +224,9 @@ private PropertyKey.Builder convert2Builder(HugeGraph g) {
             if (this.aggregateType != null) {
                 builder.aggregateType(this.aggregateType);
             }
+            if (this.readFrequency != null) {
+                builder.readFrequency(this.readFrequency);
+            }
             if (this.userdata != null) {
                 builder.userdata(this.userdata);
             }
@@ -234,10 +240,10 @@ private PropertyKey.Builder convert2Builder(HugeGraph g) {
         public String toString() {
             return String.format("JsonPropertyKey{name=%s, cardinality=%s, " +
                                  "dataType=%s, aggregateType=%s, " +
-                                 "properties=%s}",
+                                 "readFrequency=%s, properties=%s}",
                                  this.name, this.cardinality,
                                  this.dataType, this.aggregateType,
-                                 this.properties);
+                                 this.readFrequency, this.properties);
         }
     }
 }

hugegraph-api/src/main/java/com/baidu/hugegraph/auth/HugeGraphAuthProxy.java

@@ -86,6 +86,7 @@
 import com.baidu.hugegraph.type.HugeType;
 import com.baidu.hugegraph.type.Namifiable;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.GraphReadMode;
 import com.baidu.hugegraph.type.define.NodeRole;
 import com.baidu.hugegraph.util.E;
 import com.baidu.hugegraph.util.Log;
@@ -596,6 +597,18 @@ public void mode(GraphMode mode) {
         this.hugegraph.mode(mode);
     }
 
+    @Override
+    public GraphReadMode readMode() {
+        this.verifyPermission(HugePermission.READ, ResourceType.STATUS);
+        return this.hugegraph.readMode();
+    }
+
+    @Override
+    public void readMode(GraphReadMode readMode) {
+        this.verifyPermission(HugePermission.WRITE, ResourceType.STATUS);
+        this.hugegraph.readMode(readMode);
+    }
+
     @Override
     public void waitStarted() {
         this.verifyPermission(HugePermission.READ, ResourceType.STATUS);

hugegraph-api/src/main/java/com/baidu/hugegraph/version/ApiVersion.java

@@ -108,10 +108,11 @@ public final class ApiVersion {
      * [0.57] Issue-1105: Allow not rebuild index when create index label
      * [0.58] Issue-1173: Supports customized kout/kneighbor,
      *        multi-node-shortest-path, jaccard-similar and template-paths
+     * [0.59] Issue-1333: Support graph read mode for olap property
      */
 
     // The second parameter of Version.of() is for IDE running without JAR
-    public static final Version VERSION = Version.of(ApiVersion.class, "0.58");
+    public static final Version VERSION = Version.of(ApiVersion.class, "0.59");
 
     public static final void check() {
         // Check version of hugegraph-core. Firstly do check from version 0.3

hugegraph-cassandra/src/main/java/com/baidu/hugegraph/backend/store/cassandra/CassandraFeatures.java

@@ -121,4 +121,9 @@ public boolean supportsAggregateProperty() {
     public boolean supportsTtl() {
         return true;
     }
+
+    @Override
+    public boolean supportsOlapProperties() {
+        return false;
+    }
 }

hugegraph-cassandra/src/main/java/com/baidu/hugegraph/backend/store/cassandra/CassandraTables.java

@@ -206,6 +206,7 @@ public void init(CassandraSessionPool.Session session) {
                     .put(HugeKeys.DATA_TYPE, DataType.tinyint())
                     .put(HugeKeys.CARDINALITY, DataType.tinyint())
                     .put(HugeKeys.AGGREGATE_TYPE, DataType.tinyint())
+                    .put(HugeKeys.READ_FREQUENCY, DataType.tinyint())
                     .put(HugeKeys.PROPERTIES, DataType.set(TYPE_PK))
                     .put(HugeKeys.USER_DATA, TYPE_UD)
                     .put(HugeKeys.STATUS, DataType.tinyint())

hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java

@@ -52,6 +52,7 @@
 import com.baidu.hugegraph.traversal.optimize.HugeVertexStepStrategy;
 import com.baidu.hugegraph.type.HugeType;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.GraphReadMode;
 import com.baidu.hugegraph.type.define.NodeRole;
 
 /**
@@ -136,6 +137,9 @@ public interface HugeGraph extends Graph {
     public GraphMode mode();
     public void mode(GraphMode mode);
 
+    public GraphReadMode readMode();
+    public void readMode(GraphReadMode readMode);
+
     public void waitStarted();
     public void serverStarted(Id serverId, NodeRole serverRole);
     public boolean started();

hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraphParams.java

@@ -30,6 +30,7 @@
 import com.baidu.hugegraph.event.EventHub;
 import com.baidu.hugegraph.task.ServerInfoManager;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.GraphReadMode;
 import com.google.common.util.concurrent.RateLimiter;
 
 /**
@@ -40,6 +41,7 @@ public interface HugeGraphParams {
     public HugeGraph graph();
     public String name();
     public GraphMode mode();
+    public GraphReadMode readMode();
 
     public SchemaTransaction schemaTransaction();
     public GraphTransaction systemTransaction();

hugegraph-core/src/main/java/com/baidu/hugegraph/StandardHugeGraph.java

@@ -83,6 +83,7 @@
 import com.baidu.hugegraph.task.TaskScheduler;
 import com.baidu.hugegraph.type.HugeType;
 import com.baidu.hugegraph.type.define.GraphMode;
+import com.baidu.hugegraph.type.define.GraphReadMode;
 import com.baidu.hugegraph.type.define.NodeRole;
 import com.baidu.hugegraph.util.DateUtil;
 import com.baidu.hugegraph.util.E;
@@ -123,6 +124,7 @@ public class StandardHugeGraph implements HugeGraph {
     private volatile boolean started;
     private volatile boolean closed;
     private volatile GraphMode mode;
+    private volatile GraphReadMode readMode;
     private volatile HugeVariables variables;
 
     private final String name;
@@ -179,6 +181,7 @@ public StandardHugeGraph(HugeConfig config) {
         this.started = false;
         this.closed = false;
         this.mode = GraphMode.NONE;
+        this.readMode = GraphReadMode.OLTP_ONLY;
 
         LockUtil.init(this.name);
 
@@ -265,6 +268,16 @@ public void mode(GraphMode mode) {
         this.mode = mode;
     }
 
+    @Override
+    public GraphReadMode readMode() {
+        return this.readMode;
+    }
+
+    @Override
+    public void readMode(GraphReadMode readMode) {
+        this.readMode = readMode;
+    }
+
     @Override
     public void waitStarted() {
         // Just for trigger Tx.getOrNewTransaction, then load 3 stores
@@ -957,6 +970,11 @@ public GraphMode mode() {
             return StandardHugeGraph.this.mode();
         }
 
+        @Override
+        public GraphReadMode readMode() {
+            return StandardHugeGraph.this.readMode();
+        }
+
         @Override
         public SchemaTransaction schemaTransaction() {
             return StandardHugeGraph.this.schemaTransaction();

hugegraph-core/src/main/java/com/baidu/hugegraph/backend/serializer/BinarySerializer.java

@@ -62,6 +62,7 @@
 import com.baidu.hugegraph.type.define.HugeKeys;
 import com.baidu.hugegraph.type.define.IdStrategy;
 import com.baidu.hugegraph.type.define.IndexType;
+import com.baidu.hugegraph.type.define.ReadFrequency;
 import com.baidu.hugegraph.type.define.SchemaStatus;
 import com.baidu.hugegraph.type.define.SerialEnum;
 import com.baidu.hugegraph.util.Bytes;
@@ -997,6 +998,7 @@ public BinaryBackendEntry writePropertyKey(PropertyKey schema) {
             writeEnum(HugeKeys.DATA_TYPE, schema.dataType());
             writeEnum(HugeKeys.CARDINALITY, schema.cardinality());
             writeEnum(HugeKeys.AGGREGATE_TYPE, schema.aggregateType());
+            writeEnum(HugeKeys.READ_FREQUENCY, schema.readFrequency());
             writeIds(HugeKeys.PROPERTIES, schema.properties());
             writeEnum(HugeKeys.STATUS, schema.status());
             writeUserdata(schema);
@@ -1016,6 +1018,8 @@ public PropertyKey readPropertyKey(HugeGraph graph,
                                              Cardinality.class));
             propertyKey.aggregateType(readEnum(HugeKeys.AGGREGATE_TYPE,
                                                AggregateType.class));
+            propertyKey.readFrequency(readEnum(HugeKeys.READ_FREQUENCY,
+                                               ReadFrequency.class));
             propertyKey.properties(readIds(HugeKeys.PROPERTIES));
             propertyKey.status(readEnum(HugeKeys.STATUS, SchemaStatus.class));
             readUserdata(propertyKey);

hugegraph-core/src/main/java/com/baidu/hugegraph/backend/serializer/TableSerializer.java

@@ -56,6 +56,7 @@
 import com.baidu.hugegraph.type.define.HugeKeys;
 import com.baidu.hugegraph.type.define.IdStrategy;
 import com.baidu.hugegraph.type.define.IndexType;
+import com.baidu.hugegraph.type.define.ReadFrequency;
 import com.baidu.hugegraph.type.define.SchemaStatus;
 import com.baidu.hugegraph.type.define.SerialEnum;
 import com.baidu.hugegraph.util.E;
@@ -464,6 +465,8 @@ public BackendEntry writePropertyKey(PropertyKey propertyKey) {
         entry.column(HugeKeys.CARDINALITY, propertyKey.cardinality().code());
         entry.column(HugeKeys.AGGREGATE_TYPE,
                      propertyKey.aggregateType().code());
+        entry.column(HugeKeys.READ_FREQUENCY,
+                     propertyKey.readFrequency().code());
         entry.column(HugeKeys.PROPERTIES,
                      this.toLongSet(propertyKey.properties()));
         this.writeUserdata(propertyKey, entry);
@@ -560,6 +563,7 @@ public PropertyKey readPropertyKey(HugeGraph graph,
         Number dataType = entry.column(HugeKeys.DATA_TYPE);
         Number cardinality = entry.column(HugeKeys.CARDINALITY);
         Number aggregateType = entry.column(HugeKeys.AGGREGATE_TYPE);
+        Number readFrequency = entry.column(HugeKeys.READ_FREQUENCY);
         Object properties = entry.column(HugeKeys.PROPERTIES);
         Number status = entry.column(HugeKeys.STATUS);
 
@@ -571,6 +575,9 @@ public PropertyKey readPropertyKey(HugeGraph graph,
         propertyKey.aggregateType(SerialEnum.fromCode(
                                   AggregateType.class,
                                   aggregateType.byteValue()));
+        propertyKey.readFrequency(SerialEnum.fromCode(
+                                  ReadFrequency.class,
+                                  readFrequency.byteValue()));
         propertyKey.properties(this.toIdArray(properties));
 
         this.readUserdata(propertyKey, entry);

hugegraph-core/src/main/java/com/baidu/hugegraph/backend/store/BackendFeatures.java

@@ -62,4 +62,6 @@ public default boolean supportsPersistence() {
     public boolean supportsAggregateProperty();
 
     public boolean supportsTtl();
+
+    public boolean supportsOlapProperties();
 }

hugegraph-core/src/main/java/com/baidu/hugegraph/backend/store/memory/InMemoryDBStore.java

@@ -461,5 +461,10 @@ public boolean supportsAggregateProperty() {
         public boolean supportsTtl() {
             return false;
         }
+
+        @Override
+        public boolean supportsOlapProperties() {
+            return false;
+        }
     };
 }

hugegraph-core/src/main/java/com/baidu/hugegraph/io/GraphSONSchemaSerializer.java

@@ -98,6 +98,7 @@ public Map<HugeKeys, Object> writePropertyKey(PropertyKey propertyKey) {
         map.put(HugeKeys.DATA_TYPE, propertyKey.dataType());
         map.put(HugeKeys.CARDINALITY, propertyKey.cardinality());
         map.put(HugeKeys.AGGREGATE_TYPE, propertyKey.aggregateType());
+        map.put(HugeKeys.READ_FREQUENCY, propertyKey.readFrequency());
         map.put(HugeKeys.PROPERTIES,
                 graph.mapPkId2Name(propertyKey.properties()));
         map.put(HugeKeys.STATUS, propertyKey.status());

hugegraph-core/src/main/java/com/baidu/hugegraph/job/schema/RebuildIndexCallable.java

@@ -190,4 +190,4 @@ private SchemaElement schemaElement() {
                           "Invalid HugeType '%s' for rebuild", type));
         }
     }
-}
+}

hugegraph-core/src/main/java/com/baidu/hugegraph/schema/PropertyKey.java

@@ -37,6 +37,7 @@
 import com.baidu.hugegraph.type.define.AggregateType;
 import com.baidu.hugegraph.type.define.Cardinality;
 import com.baidu.hugegraph.type.define.DataType;
+import com.baidu.hugegraph.type.define.ReadFrequency;
 import com.baidu.hugegraph.util.E;
 import com.baidu.hugegraph.util.LongEncoding;
 
@@ -45,12 +46,14 @@ public class PropertyKey extends SchemaElement implements Propfiable {
     private DataType dataType;
     private Cardinality cardinality;
     private AggregateType aggregateType;
+    private ReadFrequency readFrequency;
 
     public PropertyKey(final HugeGraph graph, Id id, String name) {
         super(graph, id, name);
         this.dataType = DataType.TEXT;
         this.cardinality = Cardinality.SINGLE;
         this.aggregateType = AggregateType.NONE;
+        this.readFrequency = ReadFrequency.OLTP;
     }
 
     @Override
@@ -82,6 +85,14 @@ public void aggregateType(AggregateType aggregateType) {
         this.aggregateType = aggregateType;
     }
 
+    public void readFrequency(ReadFrequency readFrequency) {
+        this.readFrequency = readFrequency;
+    }
+
+    public ReadFrequency readFrequency() {
+        return this.readFrequency;
+    }
+
     @Override
     public Set<Id> properties() {
         return Collections.emptySet();
@@ -108,7 +119,8 @@ public boolean hasSameContent(PropertyKey other) {
         return super.hasSameContent(other) &&
                this.dataType == other.dataType() &&
                this.cardinality == other.cardinality() &&
-               this.aggregateType == other.aggregateType();
+               this.aggregateType == other.aggregateType() &&
+               this.readFrequency == other.readFrequency();
     }
 
     public String clazz() {
@@ -370,6 +382,12 @@ public interface Builder extends SchemaBuilder<PropertyKey> {
 
         Builder calcOld();
 
+        Builder calcSet();
+
+        Builder calcList();
+
+        Builder readFrequency(ReadFrequency readFrequency);
+
         Builder cardinality(Cardinality cardinality);
 
         Builder dataType(DataType dataType);