Support for OData $count operations as per v4.01 spec section 11.2.10 #1298

joshcomley · 2018-10-21T13:50:08Z

Issues

I am unable to find an open issue relating to this.

Description

As per the title, this is to implement support for $count operations such as:

GET http://host/service/Products/$count
GET http://host/service/Products/$count?$filter=Price lt 10.00
GET http://host/service/Customers?$filter=Interests/$count gt 5
GET http://host/service/Categories?$filter=Products/$count($filter=Price gt 5.0) gt 1

With this change, the following is still unsupported:

GET http://host/service/Products/$filter=@foo/$count?@foo=Price lt 10.00

Specification reference:
http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_RequestingtheNumberofItemsinaCollect

Checklist (Uncheck if it is not completed)

Test cases added (although only URI builder tests)
Build and test with one-click build and test script passed

Additional work necessary

Functional tests need to be written.

Unsure if docs need to be updated.

msftclas · 2018-10-21T13:50:20Z

All CLA requirements met.

xuzhg · 2018-10-23T20:29:37Z

@joshcomley Would you please file two issues:

One issue is to describe the functionality/requirement/problem/etc implemented in this PR.
The other is for the remaining unsupported scenario

xuzhg · 2018-10-31T20:53:23Z

@joshcomley I see there are some build errors:

src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,69): Error CS1026: ) expected
src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,84): Error CS1002: ; expected
src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,84): Error CS1513: } expected
src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,86): Error CS1525: Invalid expression term '||'
src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,115): Error CS1002: ; expected
src\Microsoft.OData.Core\JsonLight\ODataJsonLightWriter.cs(562,115): Error CS1513: } expected
Process 'msbuild.exe' exited with code '1'.

Would you please help take a look?

biaol-odata · 2018-10-31T23:39:49Z

test/FunctionalTests/Microsoft.OData.Core.Tests/ScenarioTests/UriBuilder/CountBuilderTests.cs

+            Assert.Equal(new Uri("http://gobbledygook/People?$expand=MyPaintings%2F%24count"), actualUri);
+        }
+
+        // This is not supported, yet


We need to support parameter alias. :)

xuzhg · 2018-11-27T00:54:27Z

src/Microsoft.OData.Core/UriParser/SemanticAst/ExpandedReferenceSelectItem.cs

+        }
+
+        public ExpandedCountSelectItem(ODataExpandPath pathToNavigationProperty, IEdmNavigationSource navigationSource) : base(pathToNavigationProperty, navigationSource) { }
+        public ExpandedCountSelectItem(ODataExpandPath pathToNavigationProperty, IEdmNavigationSource navigationSource, FilterClause filterOption, OrderByClause orderByOption, long? topOption, long? skipOption, bool? countOption, SearchClause searchOption) : base(pathToNavigationProperty, navigationSource, filterOption, orderByOption, topOption, skipOption, countOption, searchOption) { }


@joshcomley The spec says " The $count segment can be appended to a navigation property name or type-cast segment following a navigation property name to return just the count of the related entities. The $filter and $search system query options can be used to limit the number or related entities included in the count. ",

So, it seems it only accepts "filterOption" and "SearchOption" in "ExpandedCountSelectItem" ?

@xuzhg It should only accept filter and search, yes

joshcomley · 2020-01-03T18:15:30Z

I've just realised this issue is still outstanding (have been using my own patched version of OData for a while). What do I need to do to get this merged?

xuzhg · 2020-01-08T00:54:52Z

@joshcomley Thanks for tracking on this. I have fixed some failure test cases and recreate a PR at: #1336.

We do like this feature to be implemented. However, for your changes, i'd like to change some design and implementation. Owing to other high priority task, this change is postpone. It seems you are interested it again, maybe we can find some time to sync it.

joshcomley · 2020-01-08T11:55:09Z

Hi @xuzhg, thanks for getting back to me. As it's been a year since these changes, some things have changed, but I have re-applied my changes to the latest version of the code-base. Should I delete this PR and create a new one with the new amendments?

* fix OData#2003 * fix OData#2003 * fix OData#2003 * fix OData#2003 Co-authored-by: Maxim Voronov <[email protected]>

…Data#2002) * Extend TextWriterWrapper abstract class with equivalent async methods and provide the implementation in the derived NonIndentedTextWriter class Co-authored-by: John Gathogo <[email protected]>

# Conflicts: # src/Microsoft.OData.Core/JsonLight/ODataJsonLightWriter.cs

joshcomley · 2021-03-04T20:08:09Z

This PR has today been rebased on master, the changes added in #1336 have been merged in and I have added support for $select=Collection/$count (it already supported $expand=Collection/$count)

KenitoInc · 2021-05-12T08:20:17Z

@joshcomley
We merged these 2 PRs #2051 and #2069
They will be out in v7.9 release.
Check if they resolve your issue

joshcomley added 3 commits October 21, 2018 13:57

Support for OData $count operations as per v4.01 spec section 11.2.10

334b18c

Added more URI tests

d69487c

Added failing test for future reference

88bf887

joshcomley added a commit to joshcomley/WebApi that referenced this pull request Oct 21, 2018

Support for $count functions, pending OData/odata.net#1298

df86be2

xuzhg requested review from mikepizzo, xuzhg, biaol-odata, KanishManuja-MS and raheph October 23, 2018 20:28

joshcomley added 2 commits October 24, 2018 11:28

Fixed printing @odata.count

4dd038b

Comments

cd28927

xuzhg added this to the 7.6 milestone Oct 24, 2018

xuzhg added the under-review label Oct 24, 2018

biaol-odata reviewed Oct 31, 2018

View reviewed changes

KanishManuja-MS removed the Ready for review label Nov 6, 2018

biaol-odata added the feature label Nov 19, 2018

xuzhg mentioned this pull request Nov 26, 2018

Continue on [#1298] Support for OData $count operations as per v4.01 spec section 11.2.10 feature #1336

Closed

2 tasks

xuzhg approved these changes Nov 27, 2018

View reviewed changes

Build version

eb05f53

xuzhg force-pushed the master branch 2 times, most recently from f9519fd to 14a4b12 Compare September 22, 2019 21:12

xuzhg and others added 3 commits March 1, 2021 10:11

Fix some build warnings

3807511

Remove unused cache files

40f78a9

Fix ODataUriExtensions.BuildUri produce invalid uri (OData#2004)

104a01f

* fix OData#2003 * fix OData#2003 * fix OData#2003 * fix OData#2003 Co-authored-by: Maxim Voronov <[email protected]>

habbes and others added 15 commits March 3, 2021 13:24

Update version to 7.8.3 (OData#2015)

09fa803

Expand TextWriterWrapper abstract class with equivalent async method (O…

8522ce4

…Data#2002) * Extend TextWriterWrapper abstract class with equivalent async methods and provide the implementation in the derived NonIndentedTextWriter class Co-authored-by: John Gathogo <[email protected]>

Reverted build version

89ce97e

Support for OData $count operations as per v4.01 spec section 11.2.10

cee8796

Added more URI tests

3d8c57e

Added failing test for future reference

68d6f5a

Fixed printing @odata.count

b640f2e

Comments

abad602

Build version

b68b78e

Reverted build version

0805592

Merge branch 'master' of https://github.com/joshcomley/odata.net

c4a5cbc

# Conflicts: # src/Microsoft.OData.Core/JsonLight/ODataJsonLightWriter.cs

Rebased with upstream master

2768f08

Restored code lost in rebase

575e9f2

Fix test

076acdb

Support for $select=Collection/$count

64bfd74

KenitoInc closed this Jul 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for OData $count operations as per v4.01 spec section 11.2.10 #1298

Support for OData $count operations as per v4.01 spec section 11.2.10 #1298

joshcomley commented Oct 21, 2018 •

edited

Loading

msftclas commented Oct 21, 2018 •

edited

Loading

xuzhg commented Oct 23, 2018

xuzhg commented Oct 31, 2018

biaol-odata Oct 31, 2018

xuzhg Nov 27, 2018

joshcomley Jan 3, 2020

joshcomley commented Jan 3, 2020

xuzhg commented Jan 8, 2020

joshcomley commented Jan 8, 2020

joshcomley commented Mar 4, 2021 •

edited

Loading

KenitoInc commented May 12, 2021

Support for OData $count operations as per v4.01 spec section 11.2.10 #1298

Support for OData $count operations as per v4.01 spec section 11.2.10 #1298

Conversation

joshcomley commented Oct 21, 2018 • edited Loading

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

msftclas commented Oct 21, 2018 • edited Loading

xuzhg commented Oct 23, 2018

xuzhg commented Oct 31, 2018

biaol-odata Oct 31, 2018

Choose a reason for hiding this comment

xuzhg Nov 27, 2018

Choose a reason for hiding this comment

joshcomley Jan 3, 2020

Choose a reason for hiding this comment

joshcomley commented Jan 3, 2020

xuzhg commented Jan 8, 2020

joshcomley commented Jan 8, 2020

joshcomley commented Mar 4, 2021 • edited Loading

KenitoInc commented May 12, 2021

joshcomley commented Oct 21, 2018 •

edited

Loading

msftclas commented Oct 21, 2018 •

edited

Loading

joshcomley commented Mar 4, 2021 •

edited

Loading