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.3.0.dev0.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

graphene_sqlalchemy-2.3.0.dev0-py2.py3-none-any.whl (36.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphene-sqlalchemy-2.3.0.dev0.tar.gz.

File metadata

  • Download URL: graphene-sqlalchemy-2.3.0.dev0.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/2.7.15

File hashes

Hashes for graphene-sqlalchemy-2.3.0.dev0.tar.gz
Algorithm Hash digest
SHA256 69d91e27045c4d366369a16edbd73c7e16401d466192d70ce795b01a1da0845b
MD5 14dd304e9471bd3e4c8f206f8f3ca48a
BLAKE2b-256 5cf152c23766cda17663aedda7e6612add6e995ebe9a1e95d6de602475c815ab

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: graphene_sqlalchemy-2.3.0.dev0-py2.py3-none-any.whl
  • Upload date:
  • Size: 36.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/2.7.15

File hashes

Hashes for graphene_sqlalchemy-2.3.0.dev0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a4fe5f99e9a7d2b820b27c7eefd60ce5e4a26f5996f4c02b8eb6391b8a042a2e
MD5 39e99a7e0cfa2124da3564734934765e
BLAKE2b-256 6850edf1a0bce441091623bc3ed3f4c5adccc65d3bde2dcccc30b07cff5781d8

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