add comment

vesoft-inc · Mar 15, 2022 · 3f74015 · 3f74015
1 parent 4fc5a0c
commit 3f74015
Show file tree

Hide file tree

Showing 17 changed files with 61 additions and 102 deletions.
diff --git a/src/graph/executor/query/AggregateExecutor.cpp b/src/graph/executor/query/AggregateExecutor.cpp
@@ -1,16 +1,8 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/AggregateExecutor.h"
-
-#include "common/datatypes/List.h"
-#include "common/expression/AggregateExpression.h"
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryExpressionContext.h"
-#include "graph/context/Result.h"
-#include "graph/planner/plan/PlanNode.h"
 #include "graph/planner/plan/Query.h"
 
 namespace nebula {

diff --git a/src/graph/executor/query/AggregateExecutor.h b/src/graph/executor/query/AggregateExecutor.h
@@ -1,13 +1,13 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_AGGREGATEEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_AGGREGATEEXECUTOR_H_
 
 #include "graph/executor/Executor.h"
-
+// calculate a set of data uniformly. use values from multiple records as input
+// and convert those values into one value to aggregate all records
 namespace nebula {
 namespace graph {
 

diff --git a/src/graph/executor/query/AppendVerticesExecutor.cpp b/src/graph/executor/query/AppendVerticesExecutor.cpp
@@ -1,7 +1,6 @@
-/* Copyright (c) 2021 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2021 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/AppendVerticesExecutor.h"
 

diff --git a/src/graph/executor/query/AppendVerticesExecutor.h b/src/graph/executor/query/AppendVerticesExecutor.h
@@ -1,13 +1,14 @@
-/* Copyright (c) 2021 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_APPENDVERTICESEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_APPENDVERTICESEXECUTOR_H_
 
 #include "graph/executor/query/GetPropExecutor.h"
 #include "graph/planner/plan/Query.h"
+// only used in match scenarios
+// and convert those values into one value to aggregate all records
 
 namespace nebula {
 namespace graph {

diff --git a/src/graph/executor/query/AssignExecutor.cpp b/src/graph/executor/query/AssignExecutor.cpp
@@ -1,10 +1,8 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/AssignExecutor.h"
-
 #include "graph/planner/plan/Query.h"
 
 namespace nebula {

diff --git a/src/graph/executor/query/AssignExecutor.h b/src/graph/executor/query/AssignExecutor.h
@@ -1,13 +1,12 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_ASSIGNEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_ASSIGNEXECUTOR_H_
 
 #include "graph/executor/Executor.h"
-
+// assign value to variable
 namespace nebula {
 namespace graph {
 

diff --git a/src/graph/executor/query/DataCollectExecutor.cpp b/src/graph/executor/query/DataCollectExecutor.cpp
@@ -4,8 +4,6 @@
  */
 
 #include "graph/executor/query/DataCollectExecutor.h"
-
-#include "common/time/ScopedTimer.h"
 #include "graph/planner/plan/Query.h"
 
 namespace nebula {

diff --git a/src/graph/executor/query/DedupExecutor.cpp b/src/graph/executor/query/DedupExecutor.cpp
@@ -1,14 +1,10 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/DedupExecutor.h"
 
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryExpressionContext.h"
 #include "graph/planner/plan/Query.h"
-
 namespace nebula {
 namespace graph {
 folly::Future<Status> DedupExecutor::execute() {

diff --git a/src/graph/executor/query/DedupExecutor.h b/src/graph/executor/query/DedupExecutor.h
@@ -1,13 +1,13 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_DEDUPEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_DEDUPEXECUTOR_H_
 
 #include "graph/executor/Executor.h"
-
+// When there are duplicate rows in the dataset, delete the corresponding iterator
+// and then save the filtered iterator to the result
 namespace nebula {
 namespace graph {
 

diff --git a/src/graph/executor/query/FilterExecutor.cpp b/src/graph/executor/query/FilterExecutor.cpp
@@ -1,12 +1,8 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/FilterExecutor.h"
-
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryExpressionContext.h"
 #include "graph/planner/plan/Query.h"
 
 namespace nebula {

diff --git a/src/graph/executor/query/FilterExecutor.h b/src/graph/executor/query/FilterExecutor.h
@@ -1,13 +1,14 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_FILTEREXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_FILTEREXECUTOR_H_
 
 #include "graph/executor/Executor.h"
 
+// delete the corresponding iterator when the row in the dataset does not meet the conditions
+// and save the filtered iterator to the result
 namespace nebula {
 namespace graph {
 

diff --git a/src/graph/executor/query/GetEdgesExecutor.cpp b/src/graph/executor/query/GetEdgesExecutor.cpp
@@ -1,14 +1,9 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/GetEdgesExecutor.h"
-
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryContext.h"
 #include "graph/planner/plan/Query.h"
-#include "graph/util/SchemaUtil.h"
 
 using nebula::storage::StorageClient;
 using nebula::storage::StorageRpcResponse;

diff --git a/src/graph/executor/query/GetEdgesExecutor.h b/src/graph/executor/query/GetEdgesExecutor.h
@@ -1,13 +1,13 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_GETEDGESEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_GETEDGESEXECUTOR_H_
 
 #include "graph/executor/query/GetPropExecutor.h"
 
+// get user-specified edge attributes
 namespace nebula {
 namespace graph {
 class GetEdges;

diff --git a/src/graph/executor/query/GetNeighborsExecutor.cpp b/src/graph/executor/query/GetNeighborsExecutor.cpp
@@ -1,17 +1,8 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/GetNeighborsExecutor.h"
-
-#include <sstream>
-
-#include "clients/storage/StorageClient.h"
-#include "common/datatypes/List.h"
-#include "common/datatypes/Vertex.h"
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryContext.h"
 #include "graph/service/GraphFlags.h"
 
 using nebula::storage::StorageClient;

diff --git a/src/graph/executor/query/GetNeighborsExecutor.h b/src/graph/executor/query/GetNeighborsExecutor.h
@@ -1,18 +1,17 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_GETNEIGHBORSEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_GETNEIGHBORSEXECUTOR_H_
 
 #include "graph/executor/StorageAccessExecutor.h"
 #include "graph/planner/plan/Query.h"
-#include "interface/gen-cpp2/storage_types.h"
 
+// get the attributes of the start vertex and edges specified by the user from the storage layer
+// the returned result is a list<dataset>, the format of each dataset refers to the storage.thrift
 namespace nebula {
 namespace graph {
-
 class GetNeighborsExecutor final : public StorageAccessExecutor {
  public:
   GetNeighborsExecutor(const PlanNode* node, QueryContext* qctx)

diff --git a/src/graph/executor/query/GetVerticesExecutor.cpp b/src/graph/executor/query/GetVerticesExecutor.cpp
@@ -1,14 +1,9 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #include "graph/executor/query/GetVerticesExecutor.h"
 
-#include "common/time/ScopedTimer.h"
-#include "graph/context/QueryContext.h"
-#include "graph/util/SchemaUtil.h"
-
 using nebula::storage::StorageClient;
 using nebula::storage::StorageRpcResponse;
 using nebula::storage::cpp2::GetPropResponse;

diff --git a/src/graph/executor/query/GetVerticesExecutor.h b/src/graph/executor/query/GetVerticesExecutor.h
@@ -1,14 +1,13 @@
-/* Copyright (c) 2020 vesoft inc. All rights reserved.
- *
- * This source code is licensed under Apache 2.0 License.
- */
+// Copyright (c) 2022 vesoft inc. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
 
 #ifndef GRAPH_EXECUTOR_QUERY_GETVERTICESEXECUTOR_H_
 #define GRAPH_EXECUTOR_QUERY_GETVERTICESEXECUTOR_H_
 
 #include "graph/executor/query/GetPropExecutor.h"
 #include "graph/planner/plan/Query.h"
-
+// get user-specified edge attributes
 namespace nebula {
 namespace graph {