https://github.com/jaystack/odata-v4-mssql
OData to MS-SQL query compiler
https://github.com/jaystack/odata-v4-mssql
Last synced: about 2 months ago
JSON representation
OData to MS-SQL query compiler
- Host: GitHub
- URL: https://github.com/jaystack/odata-v4-mssql
- Owner: jaystack
- Created: 2016-11-16T10:46:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-23T02:52:01.000Z (over 3 years ago)
- Last Synced: 2025-03-27T08:11:22.456Z (2 months ago)
- Language: TypeScript
- Size: 13.7 KB
- Stars: 6
- Watchers: 18
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OData V4 Service modules - SQL Connector
Service OData v4 requests from an SQL data store.
## Synopsis
The OData V4 SQL Connector provides functionality to convert the various types of OData segments
into SQL query statements, that you can execute over an SQL database.
## Potential usage scenarios
- Create high speed, standard compliant data sharing APIs
## Usage as server - TypeScript
```javascript
import { createFilter } from 'odata-v4-sql'
//example request: GET /api/Users?$filter=Id eq 42
app.get("/api/Users", (req: Request, res: Response) => {
const filter = createFilter(req.query.$filter);
// request instance from mssql module
request.query(`SELECT * FROM Users WHERE ${filter.where}`, function(err, data){
res.json({
'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
value: data
});
});
});
```
Advanced TypeScript example available [here](https://raw.githubusercontent.com/jaystack/odata-v4-sql/master/src/example/sql.ts).
## Usage ES5
```javascript
var createFilter = require('odata-v4-sql').createFilter;
app.get("/api/Users", function(req, res) {
var filter = createFilter(req.query.$filter);
// request instance from mssql module
request.query(filter.from("Users"), function(err, data){
res.json({
'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
value: data
});
});
})
```
## Supported OData segments
* $filter
* $select
* $skip
* $top
* $orderby
* $expand