Skip to main content

An OData query parser and transpiler.

Project description

Documentation Status Code style: black

odata-query is a library that parses OData v4 filter strings, and can convert them to other forms such as Django Queries, SQLAlchemy Queries, or just plain SQL.

Installation

odata-query is available on pypi, so can be installed with the package manager of your choice:

pip install odata-query
# OR
poetry add odata-query
# OR
pipenv install odata-query

The package defines the following optional extra’s:

  • django: If you want to pin a compatible Django version.

  • sqlalchemy: If you want to pin a compatible SQLAlchemy version.

The following extra’s relate to the development of this library:

  • linting: The linting and code style tools.

  • testing: Packages for running the tests.

  • docs: For building the project documentation.

You can install extra’s by adding them between square brackets during installation:

pip install odata-query[sqlalchemy]

Quickstart

The most common use case is probably parsing an OData query string, and applying it to a query your ORM understands. For this purpose there is an all-in-one function: apply_odata_query.

Example for Django:

from odata_query.django import apply_odata_query

orm_query = MyModel.objects  # This can be a Manager or a QuerySet.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_query(orm_query, odata_query)
results = query.all()

Example for SQLAlchemy ORM:

from odata_query.sqlalchemy import apply_odata_query

orm_query = select(MyModel)  # This is any form of Query or Selectable.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_query(orm_query, odata_query)
results = session.execute(query).scalars().all()

Example for SQLAlchemy Core:

from odata_query.sqlalchemy import apply_odata_core

core_query = select(MyTable)  # This is any form of Query or Selectable.
odata_query = "name eq 'test'"  # This will usually come from a query string parameter.

query = apply_odata_core(core_query, odata_query)
results = session.execute(query).scalars().all()

Advanced Usage

Not all use cases are as simple as that. Luckily, odata-query is modular and extendable. See the documentation for advanced usage or extending the library for other cases.

Contact

Got any questions or ideas? We’d love to hear from you. Check out our contributing guidelines for ways to offer feedback and contribute.

License

Copyright © Gorillini NV. All rights reserved.

Licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odata_query-0.10.0.tar.gz (28.0 kB view details)

Uploaded Source

Built Distribution

odata_query-0.10.0-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file odata_query-0.10.0.tar.gz.

File metadata

  • Download URL: odata_query-0.10.0.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.19 Darwin/23.5.0

File hashes

Hashes for odata_query-0.10.0.tar.gz
Algorithm Hash digest
SHA256 230d847d334fc36dc072164886711ad794bedec6d864c2600de614c596fc1c4f
MD5 1f54183552dba98b203238a88fd6052a
BLAKE2b-256 ae58b87a8f36b372af232a21b0bde5737506c84544365ad81d4998e1e23b2f3c

See more details on using hashes here.

File details

Details for the file odata_query-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: odata_query-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 34.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.19 Darwin/23.5.0

File hashes

Hashes for odata_query-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eeb9061e87fb047c40bc3e59c5f1fbf5dbf4ea0f7ff2fd510d365d6c33fe7fcb
MD5 30aa730b91fd8c732c7d3da771958710
BLAKE2b-256 01f691d52932a61a8605b3569788c494c1aaeb8f3423084659ca76041bcd3fe0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page