https://github.com/insolite/graphene-peewee-async

Graphene peewee-async integration
https://github.com/insolite/graphene-peewee-async

graphene graphql peewee peewee-async

Last synced: 3 months ago
JSON representation

Graphene peewee-async integration

• Host: GitHub
• URL: https://github.com/insolite/graphene-peewee-async
• Owner: insolite
• Created: 2016-11-18T09:07:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T14:52:54.000Z (over 3 years ago)
• Last Synced: 2024-03-14T23:20:11.580Z (8 months ago)
• Topics: graphene, graphql, peewee, peewee-async
• Language: Python
• Size: 75.2 KB
• Stars: 36
• Watchers: 8
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
=====================

graphene-peewee-async

=====================

`graphene `_ + `peewee-async `_ integration :heart:

`Changelog `_

Features

========

- Querying

    - Fields selection (considered by ``SELECT`` statement)

    - Related entities subselection (using foreign key joins)

    - Filters (django-style lookups, like ``peewee.SelectQuery.filter`` args)

    - Order (multiple fields, asc/dsc support)

    - Pagination (``page``, ``paginate_by`` support plus unpaginated ``total`` count auto-fetching)

- Mutations (both single object and bulk operating, filtering just like for querying)

    - Create

    - Update

    - Delete

    - Clone

Usage sample

============

.. code-block:: python

    # Define models

    class Author(Model):

        name = CharField()

        rating = IntegerField()

    class Book(Model):

        name = CharField()

        year = IntegerField()

        author = ForeignKeyField(Author)

    # Create nodes

    class BookNode(PeeweeObjectType):

        class Meta:

            model = Book

            manager = db_manager

    class AuthorNode(PeeweeObjectType):

        class Meta:

            model = Author

            manager = db_manager

    # Create connections

    class BookConnection(PeeweeConnection):

        class Meta:

            node = BookNode

    # Aggregate queries

    class Query(ObjectType):

        books = PeeweeConnectionField(BookConnection)

    # Create schema

    schema = Schema(query=Query, auto_camelcase=False)

    # Execute graphql query

    result = schema.execute('''

        query {

            books (filters: {author__name__ilike: "%Lovecraft%"}) {

                total

                edges {

                    node {

                        id

                        name

                        author {

                            id

                            name

                        }

                    }

                }

            }

        }''',

        return_promise=True,

        executor=AsyncioExecutor()

    )

    # Await result if required (failed queries are usually returning result

    #                           synchronously with non-empty `result.errors`

    #                           while successful ones requires awaiting

    #                           of peewee/DB level queries of course)

    if not isinstance(result, ExecutionResult):

        result = await result

    # Enjoy the result :)

    print(result.data)

    #

    # ===>

    #

    # {'books': {

    #     'total': 2,

    #     'edges': [

    #         {'node': {

    #             'id': 5,

    #             'name': 'Dagon',

    #             'author': {

    #                 'id': 1,

    #                 'name': 'Howard Lovecraft'

    #             }

    #         }},

    #         {'node': {

    #             'id': 6,

    #             'name': 'At the Mountains of Madness',

    #             'author': {

    #                 'id': 1,

    #                 'name': 'H.P. Lovecraft'

    #             }

    #         }}

    #     ]

    # }}

Advanced usage

==============

Be sure to check `API tests `_

for advanced query/mutation usages and

`auto-generating `_

such schema for them.

Install

=======

Install as package:

.. code-block:: bash

    pip3 install graphene-peewee-async