From da811dc40380a3ece794de17e0acdfa4ca614dce Mon Sep 17 00:00:00 2001
From: jussisaurio <jussi.saurio@gmail.com>
Date: Wed, 27 Nov 2024 19:30:07 +0200
Subject: [PATCH] add doc comments for members of Plan struct

---
 core/translate/plan.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/core/translate/plan.rs b/core/translate/plan.rs
index ac75981f6..2922b9fdb 100644
--- a/core/translate/plan.rs
+++ b/core/translate/plan.rs
@@ -21,14 +21,23 @@ pub struct ResultSetColumn {
 
 #[derive(Debug)]
 pub struct Plan {
+    /// A tree of sources (tables).
     pub source: SourceOperator,
+    /// the columns inside SELECT ... FROM
     pub result_columns: Vec<ResultSetColumn>,
+    /// where clause split into a vec at 'AND' boundaries.
     pub where_clause: Option<Vec<ast::Expr>>,
+    /// group by clause
     pub group_by: Option<Vec<ast::Expr>>,
+    /// order by clause
     pub order_by: Option<Vec<(ast::Expr, Direction)>>,
+    /// all the aggregates collected from the result columns, order by, and (TODO) having clauses
     pub aggregates: Option<Vec<Aggregate>>,
+    /// limit clause
     pub limit: Option<usize>,
+    /// all the tables referenced in the query
     pub referenced_tables: Vec<BTreeTableReference>,
+    /// all the indexes available
     pub available_indexes: Vec<Rc<Index>>,
 }