odata-query

odata-query

OData v4 query builder that uses a simple object-based syntax similar to MongoDB and js-data

Install

yarn add odata-query

or

npm install --save odata-query

and then use the library

import buildQuery from 'odata-query'

const query = buildQuery({...})
fetch(`http://localhost?${query}`)

where the query object syntax for {...} is defined below. There is also react-odata which utilizies this library for a declarative component.

Usage

See tests for examples as well

Filtering

buildQuery({ filter: {...} })
=> '$filter=...'

Simple filter

const filter = { PropName: 1 };
buildQuery({ filter })
=> '$filter=PropName eq 1'

Comparison operators

const filter = { PropName: { gt: 5 } };
buildQuery({ filter })
=> '$filter=PropName gt 5'

Supported operators: eq, ne, gt, ge, lt, le, in

Logical operators

// `and` implied by user an array
const filter = [{ SomeProp: 1 }, { AnotherProp: 2 }, 'startswith(Name, "foo")'];

// or you can be explicit
const filter = {
  and: [
    { SomeProp: 1 },
    { AnotherProp: 2 },
    'startswith(Name, "foo")'
  ]
};
    
buildQuery({ filter })
=> '$filter=SomeProp eq 1 and AnotherProp eq 2 and startswith(Name, "foo")'

Supported operators: and, or

Collection operators

const filter = {
  SomeCollection: {
    any: [{
      SomeProp: 1,
      AnotherProp: 2
    }]
  }
};
    
buildQuery({ filter })
=> '$filter=SomeCollection/any(t:(t/SomeProp eq 1 and t/AnotherProp eq 2)'

Supported operators: any, all

Functions

String functions returning boolean

const filter = { PropName: { contains: 'foo' } };
buildQuery({ filter })
=> "$filter=contains(PropName, 'foo')"

Supported operators: startswith, endswith, contains

Functions returning non-boolean values (string, int)

const filter = { 'length(PropName)': { gt: 10 } };
buildQuery({ filter })
=> "$filter=length(PropName) gt 10"

Supported operators: length, tolower, toupper, trim, day, month, year, hour, minute, second, round, floor, ceiling

Functions returning non-boolean values (string, int) with parameters

const filter = { "indexof(PropName, 'foo')": { eq: 3 } };
buildQuery({ filter })
=> "$filter=indexof(PropName, 'foo') eq 3"

Supported operators: indexof, substring

Data types

Coming soon

Strings

A string can also be passed as the value of the filter and it will be taken as is. This can be useful when using something like odata-filter-builder or if you want to just write the OData filter sytnax yourself but use the other benefits of the library, such as groupBy, expand, etc.

import f from 'odata-filter-builder';

const filter = f().eq('TypeId', '1')
                  .contains(x => x.toLower('Name'), 'a')
                  .toString();
buildQuery({ filter })

Selecting

Coming soon

Ordering

Coming soon

Expanding

Coming soon

Pagination (skip and top)

Coming soon

Counting

Coming soon

Grouping / aggregation

Coming soon