https://github.com/microsoft/dynamic-odata
Dynamic OData is a query library built upon OData Web API that allows you to query dynamically created Entity Data Models.
https://github.com/microsoft/dynamic-odata
dynamic odata
Last synced: 3 months ago
JSON representation
Dynamic OData is a query library built upon OData Web API that allows you to query dynamically created Entity Data Models.
- Host: GitHub
- URL: https://github.com/microsoft/dynamic-odata
- Owner: microsoft
- License: mit
- Created: 2021-02-09T07:09:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T22:14:03.000Z (over 1 year ago)
- Last Synced: 2025-06-20T00:13:27.509Z (7 months ago)
- Topics: dynamic, odata
- Language: C#
- Homepage:
- Size: 107 KB
- Stars: 25
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/microsoft/dynamic-odata/actions/workflows/dotnetcore-build.yml)
[](https://nuget.org/packages/Dynamic.OData)
[](https://nuget.org/packages/Dynamic.OData)
# Dynamic OData Query Library
## Overview
Dynamic OData is a query library built upon [OData Web API](https://github.com/OData/WebApi) that allows you to query dynamically created
Entity Data Models.
OData expects the return schema to be static at compile time, there are scenarios where applications would want to construct the return response on the go.
This library helps to achieve that with configurable model and providing metadata which are used at runtime to create dynamic response schema.
This provides flexibity to have a dynamic schema and still enable the OData magic to work. The library enables you to construct a Controller method of IEnumerable < IEdmEntityObject > return type and then construct this Object using a mapped Dictionary.
## Installation
To install this library, please download the latest version of [NuGet Package](https://www.nuget.org/packages/Dynamic.OData) from [nuget.org](https://www.nuget.org/) and refer it into your project.
## How to use
Refer to the samples at https://github.com/microsoft/dynamic-odata/blob/main/samples
## Testing
.\src>dotnet test
|Status|Failed|Passed|Skipped|Total|Duration|
|------|------|------|-------|-----|--------|
|Passed!|0|40|0|40|3 s|
#### Coverage
| |Not Covered (Blocks)|Not Covered (%Blocks)|Covered (Blocks)|Covered (%Blocks)|
|---------|--------------------|---------------------|----------------|-----------------|
|.coverage|540|12.73%|3703|87.27%|
## Benchmark
.\src\benchmark\Dynamic.OData.Benchmarks> dotnet run -c Release --filter *
BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
Intel Core i7 CPU 860 2.80GHz (Nehalem), 1 CPU, 8 logical and 4 physical cores
.NET Core SDK=5.0.200-preview.20614.14
[Host] : .NET Core 3.1.11 (CoreCLR 4.700.20.56602, CoreFX 4.700.20.56604), X64 RyuJIT
DefaultJob : .NET Core 3.1.11 (CoreCLR 4.700.20.56602, CoreFX 4.700.20.56604), X64 RyuJIT
|Method|Mean|Error|StdDev|
|------|----|-----|------|
|ODataGroupByAndAggregate|179.2 ms|10.53 ms|30.20 ms|
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.