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.context) # 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
Built Distribution
File details
Details for the file graphene-sqlalchemy-2.0.dev2017073101.tar.gz
.
File metadata
- Download URL: graphene-sqlalchemy-2.0.dev2017073101.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3470e58aa8f4f7c40fc74e9a441e72a366f2f3ac392291a1f8fd451fd28d5a68 |
|
MD5 | ec5851de067f9bce4e8225d4ed56c0c9 |
|
BLAKE2b-256 | 6ae32c8eef3879d47d62aafcbf447edf061cf98e692540df5642753c460128e5 |
File details
Details for the file graphene_sqlalchemy-2.0.dev2017073101-py2.py3-none-any.whl
.
File metadata
- Download URL: graphene_sqlalchemy-2.0.dev2017073101-py2.py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 442949b8c65f9479c70acd945219b7bc14eb98fb5dfc9862624c9c0a5972dbc2 |
|
MD5 | 8239fcd1443b04faa970c3297816cb94 |
|
BLAKE2b-256 | d58ffb74244466c3ea4823ff91bffc21ec19a21bb973cc7c0adeb2d739ad7e45 |