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.1.2.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

graphene_sqlalchemy-2.1.2-py2.py3-none-any.whl (21.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-sqlalchemy-2.1.2.tar.gz.

File metadata

  • Download URL: graphene-sqlalchemy-2.1.2.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for graphene-sqlalchemy-2.1.2.tar.gz
Algorithm Hash digest
SHA256 1524eace8823dc6e91d26942666db8706a1d877dfad4b47f3dec007312014e05
MD5 036e381bbfdf93636a03465af6352b64
BLAKE2b-256 cce919b95cb72669cd2c262651bfa114f76d51bced9407d8b31eb951c45ed8cc

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: graphene_sqlalchemy-2.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for graphene_sqlalchemy-2.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 107cba4248e69de95bd03cd50485b9d998fac449ece5ef9f44b8b7e09dac6db7
MD5 2c6427e6610321f472a518850579f6e6
BLAKE2b-256 6bcd4cd6eadb630f14ce7253037eab8f4bd901971d68b5286e35120d573a0b74

See more details on using hashes here.

Provenance

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