Graphene SQLAlchemy integration
Project description
Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.
Graphene-SQLAlchemy
A SQLAlchemy integration for Graphene.
Installation
For instaling graphene, just run this command in your shell
pip install "graphene-sqlalchemy>=2.0"
Examples
Here is a simple SQLAlchemy model:
from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import backref, relationship
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class UserModel(Base):
__tablename__ = 'department'
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:
from graphene_sqlalchemy import SQLAlchemyObjectType
class User(SQLAlchemyObjectType):
class Meta:
model = UserModel
class Query(graphene.ObjectType):
users = graphene.List(User)
def resolve_users(self, info):
query = 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})
To learn more check out the following examples:
Full example: Flask SQLAlchemy example
Contributing
After cloning this repo, ensure dependencies are installed by running:
python setup.py install
After developing, the full test suite can be evaluated by running:
python setup.py test # Use --pytest-args="-v -s" for verbose mode
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
graphene-sqlalchemy-2.1.0.tar.gz
(15.0 kB
view hashes)
Built Distribution
Close
Hashes for graphene-sqlalchemy-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8260a128f360eda5437147a3cb72809e267fa8e2464f9996ff95ddc47239dcec |
|
MD5 | 1c39e286bc1400e44c72129301d7d490 |
|
BLAKE2b-256 | 996ec40b4fdeb7ad90082dcf52fa7ae26f35dfc30f94f67bd6d2b3507a777142 |
Close
Hashes for graphene_sqlalchemy-2.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bfc93986c5e6001861e8cdfe33eeb5094ca1f30efde6822387e13070ec3ab82 |
|
MD5 | 3bc9081113e9a61112df3e7c8ab93b6f |
|
BLAKE2b-256 | cc6a4b1bd01cc18c95b107319d9d7e48f584255abfe717a1a2893a63ef43d70f |