DOCSP-43911 - Implicit Client-Side Projection #242

mongoKart · 2024-09-26T22:03:31Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-43911

Staging Links

whats-new

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?
Are the facets and meta keywords accurate?

netlify · 2024-09-26T22:03:49Z

✅ Deploy Preview for mongodb-docs-csharp ready!

Name	Link
🔨 Latest commit	`2b6bd0a`
🔍 Latest deploy log	https://app.netlify.com/sites/mongodb-docs-csharp/deploys/66fee3f12b7556000832f03f
😎 Deploy Preview	https://deploy-preview-242--mongodb-docs-csharp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jordan-smith721

LGTM

rstam · 2024-09-27T22:07:25Z

source/whats-new.txt

-
+  API reference page on MSDN.
+
+- Adds support for implicit client-side projection when using the ``Find()`` and


It won't be implicit.

Client-side projections are potentially undesirable and the current thinking is that they will have to "enable" client side projections in order to use them.

The current PR is not merged to master yet, but the two places client-side projections can be enabled are in the MongoClientSettings or in the FindOptions or AggregateOptions for an individual query.

Theoretically they could be implicit, but that's not the current thinking.

Thanks for clarifying! I was trying to figure this out from the relevant ticket and PR but must have missed this aspect. I hope I got it right in these code samples, but please correct me if I'm wrong.

rstam · 2024-09-27T22:08:35Z

source/whats-new.txt

+  API reference page on MSDN.
+
+- Adds support for implicit client-side projection when using the ``Find()`` and
+  ``Select()`` methods. In previous versions of the driver, you could perform client-side


Beside the Find and Select methods this will apply to the Project pipeline stage builder (which is analogous to the Select method).

rstam · 2024-09-27T22:10:12Z

source/whats-new.txt

+
+     var find = collection
+         .Find(doc => doc.Id == 1)
+         .ToEnumerable()


This is not driver supported client-side projections. This is the user doing an EXPLICIT client-side projection by splitting their query into server-side and client-side parts and separating them by ToEnumerable.

My understanding was that this is currently the only way to do it, which is why I presented it as the "before" example. Is that wrong?

Either way, I rearranged things to hopefully make it clearer.

rstam · 2024-09-27T22:10:29Z

source/whats-new.txt

+
+     var enumerable = collection.AsQueryable()
+         .Where(doc => doc.Id == 1)
+         .AsEnumerable()


Also EXPLICIT like the Find example above.

rstam · 2024-09-27T22:11:20Z

source/whats-new.txt

+         .Select(doc => new { R = MyFunction(doc.Name) });
+
+  In {+driver-short+} v3.0, you can perform client-side projection directly in the
+  ``Find()`` and ``Select()`` methods, as shown in the following examples:


Yes but... they have to enable client-side projections to do this.

…projection

mongoKart · 2024-10-02T21:07:50Z

source/whats-new.txt

+          };
+
+          var aggregate = collection
+              .Aggregate(pipeline, aggregateOptions)


Some of your tests call Aggregate() with no arguments, but I couldn't find that method overload and wasn't sure whether it accepted an options argument--hence the pipeline argument.

The correct syntax is:

collection.Aggregate(aggregateOptions)

There is no overload that takes a pipeline.

Aggregate is an extension method:

public static IAggregateFluent<TDocument> Aggregate<TDocument>(this IMongoCollection<TDocument> collection, AggregateOptions options = null)

and the options argument is optional so:

collection.Aggregate()

is the same as:

collection.Aggregate(options: null)

Maybe I confused it with Aggregate<TResult>: https://mongodb.github.io/mongo-csharp-driver/2.29.0/api/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Aggregate.html

mongoKart · 2024-10-02T21:08:04Z

source/whats-new.txt

+  :ref:`csharp-aggregation`.
+
+For more information about this release, see the :github:`v3.0 release notes
+</mongodb/mongo-csharp-driver/releases/tag/v3.0.0>`.


Link will be broken until actual release.

rstam · 2024-10-02T22:36:20Z

source/whats-new.txt

+          };
+
+          var aggregate = collection
+              .Aggregate(pipeline, aggregateOptions)


The correct syntax is:

collection.Aggregate(aggregateOptions)

There is no overload that takes a pipeline.

Aggregate is an extension method:

public static IAggregateFluent<TDocument> Aggregate<TDocument>(this IMongoCollection<TDocument> collection, AggregateOptions options = null)

and the options argument is optional so:

collection.Aggregate()

is the same as:

collection.Aggregate(options: null)

rstam · 2024-10-02T22:39:11Z

source/whats-new.txt

+  the ``Select()`` method, or the ``Project()`` aggregation stage.
+  In previous versions of the driver, you could perform client-side
+  projection only after calling the ``ToEnumerable()`` or ``AsEnumerable()`` method, and
+  only within the ``Select()`` method.


In previous versions of the driver behavior depended on which LINQ provider you were using:

LINQ2: implicit client-side projections in Find, Project and Select

LINQ3: explicit client-side projections only

In the 3.0 version of the driver implicit client-side projections are supported but only if EnableClientSideProjections == true

By "explicit client-side projections" I mean calling ToEnumerable() or AsEnumerable() to specify where the client-side part of the query starts.

Thanks. I reworded this section. Is it accurate to say that v3.0 supports implicit client-side projection when using the LINQ3 provider, so long as that setting is true?

rstam · 2024-10-02T22:40:35Z

source/whats-new.txt

+       .. code-block:: csharp
+
+          // Enable client-side projection
+          var findOptions = new FindOptions;


var findOptions = new FindOptions();

missing parenthesis

I'm looking forward to IT renewing my Rider license so I can write these samples in an IDE...

rstam · 2024-10-02T22:45:11Z

source/whats-new.txt

+          };
+
+          var queryable = collection
+              .AsQueryable(translationOptions)


This is subtle but the actual argument to AsQueryable is an AggregateOptions value, not an ExpressionTranslationOptions value.

We might want to be explicit about that.

AsQueryable(translationOptions) does work but only because there is an implicit conversion from ExpressionTranslationOptions to AggregateOptions, and I'm not sure we're going to keep that implicit conversion.

rstam

Sorry one small question I should have asked in a previous review.

rstam · 2024-10-03T17:47:38Z

source/whats-new.txt

+  the ``Select()`` method, or the ``Project()`` aggregation stage with the LINQ3 provider.
+  In previous versions of the driver, you could perform client-side
+  projection with the LINQ3 provider only after calling the ``ToEnumerable()`` or
+  ``AsEnumerable()`` method, and only within the ``Select()`` method.


and only within the Select() method

Why would this be the case? Once you're client-side you can do anything.

I suspect I inferred this from something in the Jira ticket.

rstam

LGTM

first draft

617c38a

jordan-smith721 approved these changes Sep 27, 2024

View reviewed changes

mongoKart requested a review from rstam September 27, 2024 16:26

rstam suggested changes Sep 27, 2024

View reviewed changes

mongoKart added 4 commits October 2, 2024 11:26

Merge remote-tracking branch 'upstream/v3.0' into docsp-43911-client-…

1b12da7

…projection

feedback

f8e0179

Merge remote-tracking branch 'upstream/v3.0' into docsp-43911-client-…

7c5003d

…projection

fix

ab63a51

mongoKart commented Oct 2, 2024

View reviewed changes

clarify

995ca45

mongoKart requested a review from rstam October 2, 2024 21:12

rstam suggested changes Oct 2, 2024

View reviewed changes

feedback

5eb9f40

mongoKart requested a review from rstam October 3, 2024 16:39

rstam suggested changes Oct 3, 2024

View reviewed changes

remove select method

2b6bd0a

mongoKart requested a review from rstam October 3, 2024 18:35

rstam approved these changes Oct 3, 2024

View reviewed changes

mongoKart merged commit 45a6d4a into mongodb:v3.0 Oct 3, 2024
6 checks passed

mongoKart deleted the docsp-43911-client-projection branch October 3, 2024 21:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-43911 - Implicit Client-Side Projection #242

DOCSP-43911 - Implicit Client-Side Projection #242

mongoKart commented Sep 26, 2024 •

edited by github-actions bot

Loading

netlify bot commented Sep 26, 2024 •

edited

Loading

jordan-smith721 left a comment

rstam Sep 27, 2024

mongoKart Oct 2, 2024 •

edited

Loading

rstam Sep 27, 2024

rstam Sep 27, 2024

mongoKart Oct 2, 2024 •

edited

Loading

rstam Sep 27, 2024

rstam Sep 27, 2024

mongoKart Oct 2, 2024

rstam Oct 2, 2024

mongoKart Oct 3, 2024 •

edited

Loading

mongoKart Oct 2, 2024

rstam Oct 2, 2024

rstam Oct 2, 2024

mongoKart Oct 3, 2024

rstam Oct 2, 2024

mongoKart Oct 3, 2024

rstam Oct 2, 2024

rstam left a comment

rstam Oct 3, 2024

mongoKart Oct 3, 2024

rstam left a comment


		API reference page on MSDN.

		- Adds support for implicit client-side projection when using the ``Find()`` and

DOCSP-43911 - Implicit Client-Side Projection #242

DOCSP-43911 - Implicit Client-Side Projection #242

Conversation

mongoKart commented Sep 26, 2024 • edited by github-actions bot Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented Sep 26, 2024 • edited Loading

✅ Deploy Preview for mongodb-docs-csharp ready!

jordan-smith721 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rstam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rstam left a comment

Choose a reason for hiding this comment

mongoKart commented Sep 26, 2024 •

edited by github-actions bot

Loading

netlify bot commented Sep 26, 2024 •

edited

Loading

mongoKart Oct 2, 2024 •

edited

Loading

mongoKart Oct 2, 2024 •

edited

Loading

mongoKart Oct 3, 2024 •

edited

Loading