Skip to main content

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 abc_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

Release files for abc-graphene-sqlalchemy 2.2.4

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

Source distribution (sdist)

Source distribution for abc-graphene-sqlalchemy 2.2.4
File Size Uploaded
abc-graphene-sqlalchemy-2.2.4.tar.gz 30.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for abc-graphene-sqlalchemy 2.2.4
File Interpreter ABI Platform
abc_graphene_sqlalchemy-2.2.4-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 68.5 kB

Release files / abc-graphene-sqlalchemy-2.2.4.tar.gz

Download URL abc-graphene-sqlalchemy-2.2.4.tar.gz
Size 30.0 kB
Tags Source
SHA-256 checksum
How to use checksums
969148ea254094c8b22e9b6b7d60b2600d29cfa3b02d42abfa81de889e673741
BLAKE2b-256 checksum
How to use checksums
b2de226ee59725e1f12d2124bd58eec3873cd2648b158c8e3eb1550f5b8dedc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.0

Release files / abc_graphene_sqlalchemy-2.2.4-py2.py3-none-any.whl

Download URL abc_graphene_sqlalchemy-2.2.4-py2.py3-none-any.whl
Size 38.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4f03220b99ddd1d706f9af20ff097a39129bd591076f27779ca199f7806bd99f
BLAKE2b-256 checksum
How to use checksums
39a4f2079c063c6396a625b4a23cf9114457014ba6b4a799dd0b907acaec760f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.0

Release history Release notifications | RSS feed

This release

2.2.4 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page