# odata-v4-sql

> OData to SQL query compiler

Latest version **0.1.2** (published 2018-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install odata-v4-sql
pnpm add odata-v4-sql
yarn add odata-v4-sql
bun add odata-v4-sql
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-07-25 |
| First published | 2016-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 97.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | JayStack |
| Maintainers | jaystack, lazarv |
| Keywords | OData, V4, sql |

## Links

- npm: https://www.npmjs.com/package/odata-v4-sql
- Repository: https://github.com/jaystack/odata-v4-sql
- Homepage: https://github.com/jaystack/odata-v4-sql#readme
- Issues: https://github.com/jaystack/odata-v4-sql/issues
- npm.io page: https://npm.io/package/odata-v4-sql

## Dependencies (2)

- [odata-v4-parser](https://npm.io/package/odata-v4-parser.md) 0.1.13
- [odata-v4-literal](https://npm.io/package/odata-v4-literal.md) ^0.1.0

## Recent versions

- 0.1.2 (latest) — 2018-07-25
- 0.1.1-jenkins-5 (jenkins) — 2017-08-23
- 0.1.1 — 2016-11-21
- 0.1.0 — 2016-11-16

## 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

---
_Source: https://npm.io/package/odata-v4-sql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._