Skip to content

microsoft/dynamic-odata

Repository files navigation

build NuGet package NuGet downloads

Dynamic OData Query Library

Overview

Dynamic OData is a query library built upon OData Web API 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 from 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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact 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. 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.

About

Dynamic OData is a query library built upon OData Web API that allows you to query dynamically created Entity Data Models.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages