You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Schemio.Core|[](https://badge.fury.io/nu/Schemio.Core)| Provides `core` functionality to configure nested queries and transformers. With ability to map schema paths (XPath/JSONPath) to entity's object graph. `No QueryEngine` provided and requires implementing IQueryEngine to execute IQuery instances. |
12
12
| Schemio.SQL|[](https://badge.fury.io/nu/Schemio.SQL)| Provides schemio with query engine using `Dapper` to execute SQL queries. |
13
13
| Schemio.EntityFramework|[](https://badge.fury.io/nu/Schemio.EntityFramework)| Provides schemio with `Entity Framework` query engine to execute queries using DbContext. |
14
+
| Schemio.API|[](https://badge.fury.io/nu/Schemio.Api)| Provides schemio with `Web Api` query engine to execute apis using HttpClient. |
14
15
15
16
## Concept
16
17
### What is Schemio?
17
-
`Schemio` is a data aggregation framework that
18
-
- allows fetching `aggregated data` from `heterogeneous` data storages. You could combine queries targetting different data platforms (example. SQL, API, Cache) to return an aggregated data entity.
19
-
- allows `conditionally` fetching only `parts` of the data entity. You could retrieve an aggregated data entity with selective sections of its `object graph` populated depending on the context passed with the request.
18
+
`Schemio` is a data aggregation framework using queries that can target different data platforms.
19
+
20
+
Key benefits:
21
+
- allows fetching `aggregated` data from `heterogeneous` data storages. You could combine queries targetting different data platforms (example. `SQL`, `API`, `Cache`) to return an aggregated data `entity`.
22
+
- allows `selectively` fetching only `parts` of the aggregated data entity. You could retrieve an aggregated data entity with only `sections` of its `object graph` populated with data depending upon the `schema paths` passed with the request.
20
23
21
24
### When to use Schemio?
22
25
Schemio is perfect fit for many use cases. Few examples that require the service tier to dynamically fetch aggregated data with high performance, availability and scalability are
@@ -28,21 +31,24 @@ Schemio is perfect fit for many use cases. Few examples that require the service
28
31
29
32
## Getting Started?
30
33
### i. Installation
31
-
Install the latest nuget package as appropriate for Core, SQL using Dapper or EntityFramework.
34
+
Install the latest nuget package as appropriate for `Core`, `Web API`, `SQL` using `Dapper` or `EntityFramework` using commands below.
32
35
33
36
`Scemio.Core` - for installing schemio for `bespoke` implementation of query engine.
34
37
```
35
38
NuGet\Install-Package Schemio.Core
36
39
```
37
40
`Schemio.SQL` - for installing schemio for SQL with `Dapper` engine.
38
41
```
39
-
NuGet\Install-Package Schemio.SQL
42
+
NuGet\Install-Package Schemio.SQL
40
43
```
41
44
`Schemio.EntityFramework` - for installing schemio for SQL with `EntityFramework` engine.
42
45
```
43
46
NuGet\Install-Package Schemio.EntityFramework
44
47
```
45
-
48
+
`Schemio.API` - for installing schemio for Web API with `HttpClient` engine.
49
+
```
50
+
NuGet\Install-Package Schemio.API
51
+
```
46
52
### ii. Developer Guide
47
53
48
54
Please see [Developer Guide](https://codeshayk.github.io/Schemio/) for details on how to implement schemio in your project.
@@ -56,11 +62,11 @@ If you are having problems, please let me know by [raising a new issue](https://
56
62
This project is licensed with the [MIT license](LICENSE).
57
63
58
64
## Version History
59
-
The main branch is now on .NET 8.0. The following previous versions are available:
65
+
The main branch is now on .NET 9.0. The following previous versions are available:
0 commit comments