Docsp-28793: count fundamentals #103

nickldp · 2023-06-21T15:30:23Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-28793
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/csharp/docsworker-xlarge/DOCSP-28793-count-fundamentals/fundamentals/crud/read-operations/count/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

source/fundamentals/crud/read-operations/count.txt

rustagir · 2023-06-21T16:11:30Z

source/fundamentals/crud/read-operations/count.txt

+You can also include the :manual:`$count </reference/operator/aggregation/count/>`
+stage to count the number of documents in an aggregation pipeline.


Issue: Instead of linking to the $count documentation, mention that this method uses the Count() builder method. In the additional information section, you could link to the Server documentation

rustagir · 2023-06-21T16:13:01Z

source/fundamentals/crud/read-operations/count.txt

+- Counts the number of documents where the ``finalGrade`` is greater than ``80``
+- Assigns the count to the ``count`` field


I: this isn't exactly what's happening in this code -- it seems like you are specifying a filter in the match stage and then appending a count stage.

rustagir · 2023-06-21T16:13:44Z

source/fundamentals/crud/read-operations/count.txt

+      var matchStage = Builders<Student>
+      .Filter.Gt(f => f.finalGrade, 80);
+      var pipeline = new EmptyPipelineDefinition<Student>()
+      .Match(matchStage).Count();
+      Console.WriteLine(pipeline);


I: format so that newlined method calls are indented. Also, this code should print the result of the aggregation. LMK if you want to review this code together.

rustagir · 2023-06-21T16:14:45Z

source/includes/code-examples/count-documents/Student.cs

@@ -0,0 +1,7 @@
+//start-grades-struct
+public class Student {
+    public ObjectId Id { get; set; }


I: Since in your sample data, the id field is ints, make sure that corresponds to the type here

Suggested change

public ObjectId Id { get; set; }

public int Id { get; set; }

source/fundamentals/crud/read-operations/count.txt

rustagir

a few more things

rustagir · 2023-06-23T13:59:30Z

source/fundamentals/crud/read-operations/count.txt

+   { "_id": 6, "name": "Demarcus Smith", "finalGrade": 88.8 }
+
+The following ``Student`` class models the documents in this
+collection.


Suggested change

collection.

collection:

rustagir · 2023-06-23T14:00:18Z

source/fundamentals/crud/read-operations/count.txt

+      var filter = Builders<Student>.Filter.Lt(s => s.FinalGrade, 80.0);
+	  var count = _myColl.CountDocuments(filter);
+	  Console.WriteLine("Number of documents with a final grade less than 80: " + count);


I: fix indentation formatting

rustagir · 2023-06-23T14:00:57Z

source/fundamentals/crud/read-operations/count.txt

+
+      var filter = Builders<Student>.Filter.Empty;
+      CountOptions opts = new CountOptions(){Hint = "_id_"};
+      var counter = collection.CountDocuments(filter, opts);


Suggested change

var counter = collection.CountDocuments(filter, opts);

var count = collection.CountDocuments(filter, opts);

rustagir · 2023-06-23T14:01:09Z

source/fundamentals/crud/read-operations/count.txt

+
+.. note:: 
+
+    The ``EstimatedDocumentCount()`` method is quicker than the


Suggested change

The ``EstimatedDocumentCount()`` method is quicker than the

The ``EstimatedDocumentCount()`` method is more efficient than the

rustagir · 2023-06-23T14:01:59Z

source/fundamentals/crud/read-operations/count.txt

+.. io-code-block::
+   :copyable: true
+
+   .. input::
+      :language: csharp
+      :dedent:
+
+     var count = _myColl.EstimatedDocumentCount();
+     Console.WriteLine("Estimated number of documents in the students collection: " + count);
+
+   .. output::
+      :language: none
+      :visible: false
+
+      Estimated number of documents in the students collection: 6


I: example is not showing up in staging because of indentation errors
S: fix errors (text should be aligned with directive)

rustagir · 2023-06-23T14:02:15Z

source/fundamentals/crud/read-operations/count.txt

+Aggregation
+-----------
+
+You can also include the ``Count()`` builder method to count the number


Suggested change

You can also include the ``Count()`` builder method to count the number

You can use the ``Count()`` builder method to count the number

rustagir · 2023-06-23T14:03:52Z

source/fundamentals/crud/read-operations/count.txt

+- Specifies a filter in the match stage
+- Appends a count stage using ``Count()``


S: describe what is happening in each stage

Suggested change

- Specifies a filter in the match stage

- Appends a count stage using ``Count()``

- Specifies a match stage to find documents with a ``FinalGrade`` value greater than ``80``

- Counts the number of documents that match the criteria

rustagir · 2023-06-23T14:04:39Z

source/fundamentals/crud/read-operations/count.txt

+     var matchStage = Builders<Student>
+		.Filter.Gt(s => s.FinalGrade, 80);
+     var result = _myColl.Aggregate().Match(matchStage).Count();
+	 Console.WriteLine("Number of documents with a final grade more than 80: " + result.First().Count);


I: indentation error, also, these variables should be renamed correctly

Suggested change

var matchStage = Builders<Student>

.Filter.Gt(s => s.FinalGrade, 80);

var result = _myColl.Aggregate().Match(matchStage).Count();

Console.WriteLine("Number of documents with a final grade more than 80: " + result.First().Count);

var filter = Builders<Student>

.Filter.Gt(s => s.FinalGrade, 80);

var result = _myColl.Aggregate().Match(filter).Count();

Console.WriteLine("Number of documents with a final grade more than 80: " + result.First().Count);

rustagir · 2023-06-23T14:05:28Z

source/includes/fundamentals/code-examples/CountDocuments.cs

+            new() { Id= 1, Name = "Jonathon Howard ", FinalGrade = 87.5 },
+            new() { Id= 2, Name = "ABCDEF Howard ", FinalGrade = 10.5 },
+            new() { Id= 3, Name = "aeufh Howard ", FinalGrade = 90.5 }


I: since this is a public repo, make sure that the sample code matches what's in the page.
S: replace with the same sample data as in the page.

Bumping this comment since I dont think you saw it!

rustagir

lgtm but consider changing the two outstanding comments! great work here

rustagir · 2023-06-23T15:06:55Z

source/fundamentals/crud/read-operations/count.txt

+- :ref:`csharp-bson`
+- :ref:`csharp-guids`
+- :ref:`csharp-builders` 
+- :ref:`csharp-poco`


Suggestion: add a link to the $count documentation in the Server manual

rustagir · 2023-06-23T15:08:18Z

source/includes/fundamentals/code-examples/CountDocuments.cs

+            new() { Id= 1, Name = "Jonathon Howard ", FinalGrade = 87.5 },
+            new() { Id= 2, Name = "ABCDEF Howard ", FinalGrade = 10.5 },
+            new() { Id= 3, Name = "aeufh Howard ", FinalGrade = 90.5 }


Bumping this comment since I dont think you saw it!

This reverts commit 173895b.

* DOCSP-28793: Count Fundementals * test * test * test * test * test * up through estimated * up through estimated * aggregate * final? * final? * final? * final * api fix * final except error * final * post review * check before and after * post review * error fix * error fix * error fix * error fix * error fix * error fix * examples too long fix * changes requested * changes requested (cherry picked from commit 173895b)

* DOCSP-28793: Count Fundementals * test * test * test * test * test * up through estimated * up through estimated * aggregate * final? * final? * final? * final * api fix * final except error * final * post review * check before and after * post review * error fix * error fix * error fix * error fix * error fix * error fix * examples too long fix * changes requested * changes requested

nickldp added 16 commits June 20, 2023 13:50

DOCSP-28793: Count Fundementals

23fab2d

test

b0b223f

test

1e45996

test

1d827d1

test

0afcb50

test

0478f45

up through estimated

9e191ad

up through estimated

b342bf5

aggregate

6b03c37

final?

7e5d5fe

final?

e8c5835

final?

511616e

final

e6a1418

api fix

1957fd5

final except error

9024334

final

098ad48

rustagir suggested changes Jun 21, 2023

View reviewed changes

nickldp added 5 commits June 21, 2023 13:33

post review

a3af65f

check before and after

b1f104f

post review

c7d9eee

error fix

b64717a

error fix

6d8fec0

nickldp requested a review from rustagir June 21, 2023 20:05

error fix

8bbbe71

rustagir suggested changes Jun 23, 2023

View reviewed changes

nickldp added 4 commits June 23, 2023 10:22

error fix

62775d0

error fix

0e94854

error fix

2bedbcc

examples too long fix

7ef0fab

nickldp requested a review from rustagir June 23, 2023 14:51

changes requested

469a5de

rustagir approved these changes Jun 23, 2023

View reviewed changes

changes requested

b77ceae

nickldp merged commit 173895b into mongodb:master Jun 23, 2023

nickldp added a commit that referenced this pull request Jun 23, 2023

Revert "Docsp-28793: count fundamentals (#103)"

44f1511

This reverts commit 173895b.

		You can also include the :manual:`$count </reference/operator/aggregation/count/>`
		stage to count the number of documents in an aggregation pipeline.

		- Counts the number of documents where the ``finalGrade`` is greater than ``80``
		- Assigns the count to the ``count`` field

	var counter = collection.CountDocuments(filter, opts);
	var count = collection.CountDocuments(filter, opts);


		.. note::

		The ``EstimatedDocumentCount()`` method is quicker than the

	You can also include the ``Count()`` builder method to count the number
	You can use the ``Count()`` builder method to count the number

		- Specifies a filter in the match stage
		- Appends a count stage using ``Count()``

Docsp-28793: count fundamentals #103

Docsp-28793: count fundamentals #103

Uh oh!

Conversation

nickldp commented Jun 21, 2023

Pull Request Info

Self-Review Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants