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.1.tar.gz
(16.9 kB
view hashes)
Built Distribution
Close
Hashes for graphene-sqlalchemy-2.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f492a0b4b490ffb32636b85b4d926d1d074393d2d737ba518aa62eac3c9aa672 |
|
MD5 | 749e48a87263da046531ba6944931ffd |
|
BLAKE2b-256 | 64f5757dbd530ed452dcf1f4bf280ad9af122b2fdbfdd5ed18372659ebb9de24 |
Close
Hashes for graphene_sqlalchemy-2.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e643f4f3c5f1a136f4a26c8e9d7a0f6dfe930bbae4fb4f6cb526df3b03cd749e |
|
MD5 | 1e2392e9afbb8d45548f631d7d776ea4 |
|
BLAKE2b-256 | ecae9c7201361f4fe38f9e9df4ff5fdb9759e76fd8e4ba1c1ae893969587c5b7 |