odata-v4-sql

library0.1.2jsnpmunverified

An OData V4 request to SQL query compiler, converting OData query segments ($filter, $select, $skip, $top, $orderby, $expand) into SQL WHERE clauses or full SELECT statements. Version 0.1.2 is current, with basic support for $filter, $select, $skip, $top, $orderby, and $expand. It differs from alternatives by focusing solely on SQL generation, not full OData server implementations. Ships TypeScript types.

database serialization

npm install odata-v4-sql

github ↗package ↗

INSTALL

IMPORT

SIG · ODATA-V4-SQL

odata-v4-sql

databasejavascriptv0.1.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createFilter

✓ import { createFilter } from 'odata-v4-sql'

✗ const createFilter = require('odata-v4-sql')

ESM style requires destructuring; default export not available.

createQuery

✓ import { createQuery } from 'odata-v4-sql'

✗ import { CreateQuery } from 'odata-v4-sql'

Case-sensitive named export; export name is lower camelCase.

OData2Filter

✓ import { OData2Filter } from 'odata-v4-sql'

Shows how to convert an OData $filter string into a SQL WHERE clause using the createFilter function.

import { createFilter } from 'odata-v4-sql'; // Example OData $filter from request: "Id eq 42 and Status eq 'active'" const filter = createFilter("Id eq 42 and Status eq 'active'"); console.log(filter.where); // WHERE clause: "[Id] = 42 AND [Status] = 'active'" // Use with your SQL driver: // db.query(`SELECT * FROM Users WHERE ${filter.where}`);

Debug

Known issues

gotchaThe createFilter function does not sanitize input; SQL injection risk if used with raw user input.

fix

Always validate or parameterize queries when combining with user input.

affects: >0

deprecatedThe `from` method on the filter result is deprecated.

fix

Use `createQuery` instead to generate full SELECT statements.

affects: >=0.1.0

breakingIn version 0.1.0, the `createFilter` signature changed from accepting a single parameter to requiring an options object.

fix

Update calls to pass options object: createFilter(filterString, options).

affects: <0.1.0

gotchaOnly $filter, $select, $skip, $top, $orderby, and $expand are supported; $count, $search, $apply are not implemented.

fix

Use alternative packages or manually implement unsupported features.

affects: >0

Errors

Common errors & fixes

Cannot find module 'odata-v4-sql'

Package not installed or typo in package name.

fix

Run npm install odata-v4-sql

createFilter is not a function

Default import used instead of named import.

fix

Use import { createFilter } from 'odata-v4-sql'

TypeError: filter.from is not a function

Using deprecated `from` method on filter object.

fix

Use createQuery instead of filter.from()

Unexpected token in OData filter

Invalid OData filter syntax passed to createFilter.

fix

Validate filter string against OData spec or use odata-v4-parser for better error messages.

Upgrade

Version history

0.1.2latest on npm

Audit

Dependencies

odata-v4-parserrequiredParses OData query strings into AST for SQL compilation

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/jaystack/odata-v4-sql ↗

packagehttps://www.npmjs.com/package/odata-v4-sql ↗