graphene-sqlalchemy

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

Graphene-SQLAlchemy

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

Metadata

Release files for graphene-sqlalchemy 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphene-sqlalchemy 2.3.0
File	Size	Uploaded
graphene-sqlalchemy-2.3.0.tar.gz	28.4 kB	Jun 4, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for graphene-sqlalchemy 2.3.0
File	Interpreter	ABI	Platform	Reset
graphene_sqlalchemy-2.3.0-py2.py3-none-any.whl 38.8 kB Jun 4, 2020	Python 3, Python 2	none	any	Details

Total release size: 67.1 kB

Release files / graphene-sqlalchemy-2.3.0.tar.gz

Download URL	graphene-sqlalchemy-2.3.0.tar.gz
Size	28.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`2b1a9cf4ed44aec78140605f38061a79b51be5902400d10c3d19b2cf64046215`
BLAKE2b-256 checksum How to use checksums	`68a92ba20a7d9c6d34bc2bdc0b5dfdf4ff33be16fead8a0593cd3b0454bb96d1`
Upload date	Jun 4, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/2.7.15`

Release files / graphene_sqlalchemy-2.3.0-py2.py3-none-any.whl

Download URL	graphene_sqlalchemy-2.3.0-py2.py3-none-any.whl
Size	38.8 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`97ed52bc0d01d757df50d25b5bdd490a2327778d41223d4e084d38a239925e8e`
BLAKE2b-256 checksum How to use checksums	`d28d4ab1c77e46a0d1ad2bedbb4b9d514025def8cbbf1f738db4343224cda80e`
Upload date	Jun 4, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/2.7.15`