Installations

npm install @steedos/odata-v4-sql

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.21.3

NPM Version

lerna/4.0.0/node@v14.21.3+x64 (linux)

Pull Requests

Open

3

Total

5

Closed

0

Merged

2

Issues

Open

6

Total

6

Closed

0

Releases

Unable to fetch releases

Languages

2

JavaScript

TypeScript

JavaScript (56.94%)

TypeScript (43.06%)

Developer

jaystack

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

21 Stars

13 Commits

19 Forks

11 Watchers

2 Branches

7 Contributors

Updated on Jun 24, 2025

Maintainers

5

View All 7 Contributors

Package Meta Information

Latest Version

2.6.38

Package Id

@steedos/odata-v4-sql@2.6.38

Unpacked Size

73.53 kB

Size

12.98 kB

File Count

17

NPM Version

lerna/4.0.0/node@v14.21.3+x64 (linux)

Node Version

14.21.3

Published on

May 04, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

@steedos/odata-v4-parser odata-v4-literal

Dev Dependencies

1

typescript

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

1import { createFilter } from '@steedos/odata-v4-sql'
2
3//example request:  GET /api/Users?$filter=Id eq 42
4app.get("/api/Users", (req: Request, res: Response) => {
5    const filter = createFilter(req.query.$filter);
6    // request instance from mssql module
7    request.query(`SELECT * FROM Users WHERE ${filter.where}`, function(err, data){
8        res.json({
9        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
10        	value: data
11        });
12    });
13});

Advanced TypeScript example available here.

Usage ES5

1var createFilter = require('@steedos/odata-v4-sql').createFilter;
2
3app.get("/api/Users", function(req, res) {
4    var filter = createFilter(req.query.$filter);
5    // request instance from mssql module
6    request.query(filter.from("Users"), function(err, data){
7        res.json({
8        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
9        	value: data
10        });
11    });
12})

Supported OData segments

$filter
$select
$skip
$top
$orderby
$expand

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.4

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More