Skip to content

Query builder for EdgeQL that may looks familiar to SQLAlchemy Core users

License

Notifications You must be signed in to change notification settings

Pentusha/edgeql-qb

Repository files navigation

PyPI - Python Version PyPI version Tests Maintainability Rating Coverage

EdgeQL Query Builder

Query builder for EdgeDB

Description

  • This project is currently in pre-alpha status, meaning that it is not yet production-ready and may be buggy and unstable.
  • Please note that this project is not affiliated with the official developers of EdgeDB.
  • Additionally, it is important to know that this project only supports a small part of the EdgeDB syntax.
  • The library does not include any code for connecting to the database or executing queries.
  • It also does not provide database introspection, so it will not check for typos in column names. What you write is what you get.
  • Python version 3.10 or higher is required to use this library, and there are currently no plans for backporting to earlier versions.
  • There are no external dependencies, including EdgeDB itself.

Usage examples

Many examples of queries are given in the documentation directory.

from edgeql_qb import EdgeDBModel
from edgeql_qb.types import int16
from edgedb.blocking_client import create_client


client = create_client()
Movie = EdgeDBModel('Movie')
Person = EdgeDBModel('Person')

insert = Movie.insert.values(
    title='Blade Runner 2049',
    year=int16(2017),
    director=(
        Person.select()
        .where(Person.c.id == director_id)
        .limit1
    ),
    actors=Person.insert.values(
        first_name='Harrison',
        last_name='Ford',
    ),
).build()


select = (
    Movie.select(
        Movie.c.title,
        Movie.c.year,
        Movie.c.director(
            Movie.c.director.first_name,
            Movie.c.director.last_name,
        ),
        Movie.c.actors(
            Movie.c.actors.first_name,
            Movie.c.actors.last_name,
        ),
    )
    .where(Movie.c.title == 'Blade Runner 2049')
    .build()
)

delete = Movie.delete.where(Movie.c.title == 'Blade Runner 2049').build()

decade = (Movie.c.year // 10).label('decade')
group = Movie.group().using(decade).by(decade).build()

client.query(insert.query, **insert.context)
result = client.query(select.query, **select.context)

movies_by_decade = client.query(group.query, **group.context)

client.query(delete.query, **delete.context)

Status

  • Queries:

  • Types:

    • type casts
    • cal::date_duration
    • cal::relative_duration
    • std::array
    • std::json
    • std::range
    • std::set
    • std::tuple
    • cal::local_date
    • cal::local_date
    • cal::local_datetime
    • cal::local_time
    • std::bigint
    • std::bool
    • std::bytes
    • std::datetime
    • std::decimal
    • std::duration
    • std::float32
    • std::float64
    • std::int16
    • std::int32
    • std::int64
    • std::str
    • std::uuid
  • Functions

    • cal
    • math
    • std
    • sys

About

Query builder for EdgeQL that may looks familiar to SQLAlchemy Core users

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •