Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-python/graphene-sqlalchemy
Graphene SQLAlchemy integration
https://github.com/graphql-python/graphene-sqlalchemy
graphene graphql python sqlalchemy
Last synced: 3 days ago
JSON representation
Graphene SQLAlchemy integration
- Host: GitHub
- URL: https://github.com/graphql-python/graphene-sqlalchemy
- Owner: graphql-python
- License: mit
- Created: 2016-09-18T01:50:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T12:00:52.000Z (about 1 month ago)
- Last Synced: 2024-12-25T22:03:23.596Z (17 days ago)
- Topics: graphene, graphql, python, sqlalchemy
- Language: Python
- Homepage: http://docs.graphene-python.org/projects/sqlalchemy/en/latest/
- Size: 493 KB
- Stars: 982
- Watchers: 32
- Forks: 228
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-starts - graphql-python/graphene-sqlalchemy - Graphene SQLAlchemy integration (Python)
README
Version 3.0 is in beta stage. Please read https://github.com/graphql-python/graphene-sqlalchemy/issues/348 to learn about progress and changes in upcoming
beta releases.
---
#  Graphene-SQLAlchemy
[](https://github.com/graphql-python/graphene-sqlalchemy/actions)
[](https://badge.fury.io/py/graphene-sqlalchemy)
[](https://codecov.io/gh/graphql-python/graphene-sqlalchemy)
A [SQLAlchemy](http://www.sqlalchemy.org/) integration for [Graphene](http://graphene-python.org/).
## Installation
For installing Graphene, just run this command in your shell.
```bash
pip install --pre "graphene-sqlalchemy"
```
## Examples
Here is a simple SQLAlchemy model:
```python
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class UserModel(Base):
__tablename__ = 'user'
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:
```python
import graphene
from graphene_sqlalchemy import SQLAlchemyObjectType
class User(SQLAlchemyObjectType):
class Meta:
model = UserModel
# use `only_fields` to only expose specific fields ie "name"
# only_fields = ("name",)
# use `exclude_fields` to exclude specific fields ie "last_name"
# exclude_fields = ("last_name",)
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)
```
We need a database session first:
```python
from sqlalchemy import (create_engine)
from sqlalchemy.orm import (scoped_session, sessionmaker)
engine = create_engine('sqlite:///database.sqlite3', convert_unicode=True)
db_session = scoped_session(sessionmaker(autocommit=False,
autoflush=False,
bind=engine))
# We will need this for querying, Graphene extracts the session from the base.
# Alternatively it can be provided in the GraphQLResolveInfo.context dictionary under context["session"]
Base.query = db_session.query_property()
```
Then you can simply query the schema:
```python
query = '''
query {
users {
name,
lastName
}
}
'''
result = schema.execute(query, context_value={'session': db_session})
```
You may also subclass SQLAlchemyObjectType by providing `abstract = True` in
your subclasses Meta:
```python
from graphene_sqlalchemy import SQLAlchemyObjectType
class ActiveSQLAlchemyObjectType(SQLAlchemyObjectType):
class Meta:
abstract = True
@classmethod
def get_node(cls, info, id):
return cls.get_query(info).filter(
and_(cls._meta.model.deleted_at==None,
cls._meta.model.id==id)
).first()
class User(ActiveSQLAlchemyObjectType):
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)
```
### Full Examples
To learn more check out the following [examples](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/):
- [Flask SQLAlchemy example](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/flask_sqlalchemy)
- [Nameko SQLAlchemy example](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/nameko_sqlalchemy)
## Contributing
See [CONTRIBUTING.md](https://github.com/graphql-python/graphene-sqlalchemy/blob/master/CONTRIBUTING.md)