Skip to main content

Resource Query Language to ORM

Project description

Quality Gate Status Coverage

ReQueLa

ReQueLa, your data assistant!

What is ReQueLa?

ReQueLa is a Python library that allows you to build complex queries to filter and order data in your database. Query are written using RQL, Resource Query Language, a query language expecially designed for RESTful resources.

Installation

pip install requela

Supported RQL operators

Syntax Explanation
eq(field,value) Equal to
ne(field,value) Not Equal to
gt(field,value) Greater Than
gte(field,value) Greater Than or Equal
lt(field,value) Less Than
lte(field,value) Less Than or Equal
in(field,(value1,value2,...)) In list
out(field,(value1,value2,...)) Not In list
like(field,value) Like
ilike(field,value) Case-insensitive Like
and(expression1,expression2,...) Logical AND
or(expression1,expression2,...) Logical OR
not(expression) Logical NOT
any(relationship,expression) ANY operator for to-many relationships
order_by(field1,field2,...) Order By fields

Examples

c

  • Filtering: and(eq(name,John),gt(age,30))
  • Navigation through relationships using dot notation: eq(account.name,My Account) to filter on a related field.
  • Filtering with ANY operator: any(users,eq(users.name,John))
  • Ordering: order_by(name,age)
  • To order in descendant order, prefix the property name with a minus sign: order_by(-age)
  • Combining filtering and ordering: and(eq(name,John),gt(age,30))&order_by(name,age)
  • Using logical operators: or(eq(name,John),eq(name,Jane))&order_by(name)
  • Using NOT operator: not(eq(name,John))&order_by(name)
  • Using LIKE operator with wildcard symbol *: like(name,*John*)
  • Using ILIKE operator with wildcard symbol *: ilike(name,*John*)

Usage

Query Builder

SQLAlchemy

from requela.builders.sqlalchemy import SQLAlchemyQueryBuilder

from app.db import get_session
from app.models import MyModel

builder = SQLAlchemyQueryBuilder(MyModel)
statement = builder.build_query("and(eq(name,John),gt(age,30))&order_by(name,-age)")

with get_session() as session:
    result = session.execute(statement)
    for model in result:
        print(model)

Django

from requela.builders.django import DjangoQueryBuilder

from app.models import MyModel

builder = DjangoQueryBuilder(MyModel)
result = builder.build_query("and(eq(name,John),gt(age,30))&order_by(name,-age)")

for model in result:
    print(model)

License

ReQueLa is licensed under the Apache 2.0 License and is copyright SoftwareOne AG.

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

requela-0.1.0.tar.gz (151.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

requela-0.1.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file requela-0.1.0.tar.gz.

File metadata

  • Download URL: requela-0.1.0.tar.gz
  • Upload date:
  • Size: 151.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for requela-0.1.0.tar.gz
Algorithm Hash digest
SHA256 76999d034eaaf2ec95ca11265f16384f9910754a387357ed5d7bfc7174a4ee1d
MD5 ce245b1119b8b90bc44aea6154b4ea80
BLAKE2b-256 90bc764624045987a7196cbd97ae72229010183e254f3afcf45441cb9392052e

See more details on using hashes here.

Provenance

The following attestation bundles were made for requela-0.1.0.tar.gz:

Publisher: on-release-main.yml on softwareone-platform/requela

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file requela-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: requela-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for requela-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48529f97584cfa92afa5731a9ab1ca293cba2fd8ef53786ba5631bb432a06579
MD5 1f9c1b81dd4a573e1e46dd601e0b0b71
BLAKE2b-256 690cb869cd70099a69fb62189908ed0d86e6bc9c8559fbdc7689074e51978ed3

See more details on using hashes here.

Provenance

The following attestation bundles were made for requela-0.1.0-py3-none-any.whl:

Publisher: on-release-main.yml on softwareone-platform/requela

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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