Please read UPGRADE-v2.0.md
to learn how to upgrade to Graphene 2.0.
AlchQL
A SQLAlchemy integration for Graphene.
Installation
For instaling graphene, just run this command in your shell
pip install "alchql>=3.0"
Examples
Here is a simple SQLAlchemy model:
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class UserModel(Base):
__tablename__ = 'user'
id = Column(Integer, primary_key=True)
name = Column(String)
last_name = Column(String)
To create a GraphQL schema for it you simply have to write the following:
import graphene
from alchql import SQLAlchemyObjectType
class User(SQLAlchemyObjectType):
class Meta:
model = UserModel
# use `only_fields` to only expose specific fields ie "name"
# only_fields = ("name",)
# use `exclude_fields` to exclude specific fields ie "last_name"
# exclude_fields = ("last_name",)
class Query(graphene.ObjectType):
users = graphene.List(User)
def resolve_users(self, info):
query = await User.get_query(info) # SQLAlchemy query
return query.all()
schema = graphene.Schema(query=Query)
Then you can simply query the schema:
query = '''
query {
users {
name,
lastName
}
}
'''
result = schema.execute(query, context_value={'session': db_session})
You may also subclass SQLAlchemyObjectType by providing abstract = True in
your subclasses Meta:
from alchql import SQLAlchemyObjectType
import sqlalchemy as sa
import graphene
class ActiveSQLAlchemyObjectType(SQLAlchemyObjectType):
class Meta:
abstract = True
@classmethod
async def get_node(cls, info, id):
return (await cls.get_query(info)).filter(
sa.and_(
cls._meta.model.deleted_at == None,
cls._meta.model.id == id
)
).first()
class User(ActiveSQLAlchemyObjectType):
class Meta:
model = UserModel
class Query(graphene.ObjectType):
users = graphene.List(User)
def resolve_users(self, info):
query = await User.get_query(info) # SQLAlchemy query
return query.all()
schema = graphene.Schema(query=Query)
Full Examples
To learn more check out the following examples:
1 maintainer
Metadata
1 maintainer
Release files for alchql 3.2.0.1658319577
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| alchql-3.2.0.1658319577-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Release files / alchql-3.2.0.1658319577-py2.py3-none-any.whl
| Download URL | alchql-3.2.0.1658319577-py2.py3-none-any.whl |
|---|---|
| Size | 50.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
0cf92d6f082e9309ffd239636b687f8bfe636031ae26b76e2104c9f41f752756
|
|
BLAKE2b-256 checksum How to use checksums |
98a1d1ae2b836a49c91e91f50ecff77d8e655631658db2a8f817c3ecbdaa7c87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
