Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

Metadata

Release files for graphene-sqlalchemy 2.0.dev2017083101

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.0.dev2017083101
File Size Uploaded Provenance
graphene-sqlalchemy-2.0.dev2017083101.tar.gz 11.7 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 30.1 kB

Release files / graphene-sqlalchemy-2.0.dev2017083101.tar.gz

Download URL graphene-sqlalchemy-2.0.dev2017083101.tar.gz
Size 11.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1dd14431126712af990127197d7c3330450524b273532c939c84f058f1eefc11
BLAKE2b-256 checksum
How to use checksums
1385167b308fe638d4b69e5dedae012a2d69a515db269b80f43fc498779686fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / graphene_sqlalchemy-2.0.dev2017083101-py2.py3-none-any.whl

Download URL graphene_sqlalchemy-2.0.dev2017083101-py2.py3-none-any.whl
Size 18.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
6a1b1eb658893e5d1ad5c2a040c97decf5101cd386ec21a8828dc54e0fae8adf
BLAKE2b-256 checksum
How to use checksums
5dc3e96b714062d34e9e81d8838d68a9485aabf564c39ec3e9eab45d1ca78917
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for graphene-sqlalchemy 2.0.dev2017083101

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1

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