Add bindVars & state in QueryEntity

* QueryEntity.getBindVars(): Map<String, Object>
* QueryEntity.getState(): QueryExecutionState

Author: mpv1989

ChangeLog

@@ -11,6 +11,8 @@ v4.3.3 (2018-xx-xx)
 * added TransactionOptions.maxTransactionSize(Long)
 * added TransactionOptions.intermediateCommitCount(Long)
 * added TransactionOptions.intermediateCommitSize(Long)
+* added QueryEntity.getBindVars(): Map<String, Object>
+* added QueryEntity.getState(): QueryExecutionState
 
 v4.3.2 (2017-11-30)
 ---------------------------

src/main/java/com/arangodb/entity/QueryEntity.java

@@ -21,6 +21,7 @@
 package com.arangodb.entity;
 
 import java.util.Date;
+import java.util.Map;
 
 /**
  * @author Mark Vollmary
@@ -34,6 +35,8 @@ public class QueryEntity {
 	private String query;
 	private Date started;
 	private Double runTime;
+	private Map<String, Object> bindVars;
+	private QueryExecutionState state;
 
 	public QueryEntity() {
 		super();
@@ -68,4 +71,18 @@ public Double getRunTime() {
 		return runTime;
 	}
 
+	/**
+	 * @return the bind parameter values used by the query
+	 */
+	public Map<String, Object> getBindVars() {
+		return bindVars;
+	}
+
+	/**
+	 * @return the query's current execution state
+	 */
+	public QueryExecutionState getState() {
+		return state;
+	}
+
 }

src/main/java/com/arangodb/entity/QueryExecutionState.java

@@ -0,0 +1,38 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2018 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity;
+
+/**
+ * @author Mark Vollmary
+ *
+ */
+public enum QueryExecutionState {
+	INITIALIZING,
+	PARSING,
+	OPTIMIZING_AST,
+	LOADING_COLLECTIONS,
+	INSTANTIATING_PLAN,
+	OPTIMIZING_PLAN,
+	EXECUTING,
+	FINALIZING,
+	FINISHED,
+	INVALID
+}

src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java

@@ -36,6 +36,7 @@
 import com.arangodb.entity.CollectionType;
 import com.arangodb.entity.LogLevel;
 import com.arangodb.entity.Permissions;
+import com.arangodb.entity.QueryExecutionState;
 import com.arangodb.velocypack.VPackDeserializationContext;
 import com.arangodb.velocypack.VPackDeserializer;
 import com.arangodb.velocypack.VPackSlice;
@@ -157,4 +158,14 @@ public Permissions deserialize(
 			return Permissions.valueOf(vpack.getAsString().toUpperCase());
 		}
 	};
+
+	public static final VPackDeserializer<QueryExecutionState> QUERY_EXECUTION_STATE = new VPackDeserializer<QueryExecutionState>() {
+		@Override
+		public QueryExecutionState deserialize(
+			final VPackSlice parent,
+			final VPackSlice vpack,
+			final VPackDeserializationContext context) throws VPackException {
+			return QueryExecutionState.valueOf(vpack.getAsString().toUpperCase().replaceAll(" ", "_"));
+		}
+	};
 }

src/main/java/com/arangodb/internal/velocypack/VPackDriverModule.java

@@ -32,6 +32,7 @@
 import com.arangodb.entity.LogLevel;
 import com.arangodb.entity.Permissions;
 import com.arangodb.entity.QueryEntity;
+import com.arangodb.entity.QueryExecutionState;
 import com.arangodb.internal.velocystream.internal.AuthenticationRequest;
 import com.arangodb.model.TraversalOptions;
 import com.arangodb.velocypack.VPackFieldNamingStrategy;
@@ -78,6 +79,7 @@ public String translateName(final Field field) {
 		context.registerDeserializer(LogLevel.class, VPackDeserializers.LOG_LEVEL);
 		context.registerDeserializer(ArangoDBVersion.License.class, VPackDeserializers.LICENSE);
 		context.registerDeserializer(Permissions.class, VPackDeserializers.PERMISSIONS);
+		context.registerDeserializer(QueryExecutionState.class, VPackDeserializers.QUERY_EXECUTION_STATE);
 	}
 
 	@Override

src/test/java/com/arangodb/ArangoDatabaseTest.java

@@ -66,6 +66,7 @@
 import com.arangodb.entity.QueryCachePropertiesEntity;
 import com.arangodb.entity.QueryCachePropertiesEntity.CacheMode;
 import com.arangodb.entity.QueryEntity;
+import com.arangodb.entity.QueryExecutionState;
 import com.arangodb.entity.QueryTrackingPropertiesEntity;
 import com.arangodb.entity.ServerRole;
 import com.arangodb.entity.TraversalEntity;
@@ -843,6 +844,7 @@ public void run() {
 			assertThat(currentlyRunningQueries.size(), is(1));
 			final QueryEntity queryEntity = currentlyRunningQueries.iterator().next();
 			assertThat(queryEntity.getQuery(), is("return sleep(0.2)"));
+			assertThat(queryEntity.getState(), is(QueryExecutionState.EXECUTING));
 		} finally {
 			t.join();
 		}