Skip to main content

Graphene SQLAlchemy integration

Project description

Please read UPGRADE-v2.0.md to learn how to upgrade to Graphene 2.0.


Graphene Logo Graphene-SQLAlchemy Build Status PyPI version Coverage Status

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:

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


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.0.dev2017083101.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

graphene_sqlalchemy-2.0.dev2017083101-py2.py3-none-any.whl (18.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-sqlalchemy-2.0.dev2017083101.tar.gz.

File metadata

File hashes

Hashes for graphene-sqlalchemy-2.0.dev2017083101.tar.gz
Algorithm Hash digest
SHA256 1dd14431126712af990127197d7c3330450524b273532c939c84f058f1eefc11
MD5 e7fcc371aab9047010dfb9a4653c3d93
BLAKE2b-256 1385167b308fe638d4b69e5dedae012a2d69a515db269b80f43fc498779686fa

See more details on using hashes here.

File details

Details for the file graphene_sqlalchemy-2.0.dev2017083101-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for graphene_sqlalchemy-2.0.dev2017083101-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6a1b1eb658893e5d1ad5c2a040c97decf5101cd386ec21a8828dc54e0fae8adf
MD5 b8ed3108eb316c892ead1e3399b75f00
BLAKE2b-256 5dc3e96b714062d34e9e81d8838d68a9485aabf564c39ec3e9eab45d1ca78917

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page