{"id":21832894,"url":"https://github.com/null-none/graphene-pagination","last_synced_at":"2025-03-21T13:44:20.383Z","repository":{"id":57435802,"uuid":"454956778","full_name":"null-none/graphene-pagination","owner":"null-none","description":"Extras functionalities for Graphene-Django","archived":false,"fork":false,"pushed_at":"2022-02-05T07:08:06.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T00:50:55.723Z","etag":null,"topics":["django","graphql","pagination","python","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/null-none.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-02T22:30:14.000Z","updated_at":"2023-01-22T13:53:57.000Z","dependencies_parsed_at":"2022-09-01T16:52:02.598Z","dependency_job_id":null,"html_url":"https://github.com/null-none/graphene-pagination","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-none%2Fgraphene-pagination","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-none%2Fgraphene-pagination/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-none%2Fgraphene-pagination/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-none%2Fgraphene-pagination/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/null-none","download_url":"https://codeload.github.com/null-none/graphene-pagination/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244807285,"owners_count":20513608,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","graphql","pagination","python","python3"],"created_at":"2024-11-27T19:26:52.018Z","updated_at":"2025-03-21T13:44:20.323Z","avatar_url":"https://github.com/null-none.png","language":"Python","readme":"# graphene-pagination\n\n## Installation\n\n    $ pip graphene-pagination\n\n## Documentation\n\n**Fields:**\n\n**DjangoPaginationConnectionField**\n\n- It allows paginate the query using offset-based method and returns the `totalCount` field that indicates the total query results.\n- Also, it is possible to order list using the pattern `input,enum` just sendind `ordering` field.\n\n## Example\n\n#### 1 - Model (models.py)\n\n```python\nfrom django.db import models\n\n\nclass Customer(models.Model):\n    id = models.UUIDField(primary_key=True, default=uuid.uuid4)\n    name = models.CharField(max_length=100)\n```\n\n#### 2 - Type (types.py)\n\n```python\nfrom graphene_django.types import DjangoObjectType\nfrom .models import Customer\n\n\nclass CustomerType(DjangoObjectType):\n    class Meta:\n        model = Customer\n        filter_fields = {\n            \"name\": [\"istartswith\", \"exact\"]\n        }\n```\n\n#### 3 - Schema (schema.py)\n\n```python\nfrom graphene_pagination import DjangoPaginationConnectionField\nfrom graphene import ObjectType\nfrom .types import CustomerType\nfrom .models import Customer\n\n\nclass Query(ObjectType):\n    customers = DjangoPaginationConnectionField(CustomerType)\n\n    def resolve_customers(self, info, **kwargs):\n        return Customer.objects.all()\n```\n\n#### 4 - Queries\n\n##### 4.1 - Query without limit, offset and filter\n\n```graphql\nquery customers {\n  customers {\n    totalCount\n    results {\n      id\n      name\n    }\n  }\n}\n```\n\n```json\n{\n    \"data\": {\n        \"customers\": {\n            \"totalCount\": 6,\n            \"results\": [\n                {\n                    \"id\": 1,\n                    \"name\": \"Figo\"\n                },\n                {\n                    \"id\": 2,\n                    \"name\": \"Edson Arantes do Nascimento\"\n                }\n                {\n                    \"id\": 3,\n                    \"name\": \"Lionel Messi\"\n                }\n                {\n                    \"id\": 4,\n                    \"name\": \"Ibrahimović\"\n                }\n                {\n                    \"id\": 5,\n                    \"name\": \"Paul Pogba\"\n                }\n                {\n                    \"id\": 6,\n                    \"name\": \"Eden Hazard\"\n                }\n            ]\n        }\n    }\n}\n```\n\n##### 4.2 - Query with only limit and offset\n\n```graphql\nquery customers {\n  customers(limit: 3, offset: 0) {\n    totalCount\n    results {\n      id\n      name\n    }\n  }\n}\n```\n\n```json\n{\n  \"data\": {\n    \"customers\": {\n      \"totalCount\": 6,\n      \"results\": [\n        {\n          \"id\": 1,\n          \"name\": \"Figo\"\n        },\n        {\n          \"id\": 2,\n          \"name\": \"Edson Arantes do Nascimento\"\n        },\n        {\n          \"id\": 3,\n          \"name\": \"Lionel Messi\"\n        }\n      ]\n    }\n  }\n}\n```\n\n##### 4.3 - Query with limit, offset and filter\n\n```graphql\nquery customers {\n  customers(limit: 3, offset: 0, nickname_Istartswith: \"E\") {\n    totalCount\n    results {\n      id\n      name\n    }\n  }\n}\n```\n\n```json\n{\n  \"data\": {\n    \"customers\": {\n      \"totalCount\": 2,\n      \"results\": [\n        {\n          \"id\": 2,\n          \"name\": \"Edson Arantes do Nascimento\"\n        },\n        {\n          \"id\": 6,\n          \"name\": \"Eden Hazard\"\n        }\n      ]\n    }\n  }\n}\n```\n\n##### 4.4 - Query with ordering\n\n```graphql\nquery customers {\n  customers(ordering: \"name,asc\") {\n    totalCount\n    results {\n      id\n      name\n    }\n  }\n}\n```\n\n```json\n{\n  \"data\": {\n    \"customers\": {\n        \"totalCount\": 6,\n        \"results\": [\n          {\n            \"id\": 6,\n            \"name\": \"Eden Hazard\"\n          },\n          {\n            \"id\": 2,\n            \"name\": \"Edson Arantes do Nascimento\"\n          },\n          {\n            \"id\": 1,\n            \"name\": \"Figo\"\n          },\n          {\n            \"id\": 4,\n            \"name\": \"Ibrahimović\"\n          },\n          {\n            \"id\": 3,\n            \"name\": \"Lionel Messi\"\n          }\n          {\n            \"id\": 5,\n            \"name\": \"Paul Pogba\"\n          }\n        ]\n    }\n  }\n}\n```\n\n##### 4.5 - Query with ordering, limit and offset\n\n```graphql\nquery customers {\n  customers(ordering: \"id,desc\", limit: 3, offset: 0) {\n    totalCount\n    results {\n      id\n      name\n    }\n  }\n}\n```\n\n```json\n{\n  \"data\": {\n    \"customers\": {\n      \"totalCount\": 6,\n      \"results\": [\n        {\n          \"id\": 6,\n          \"name\": \"Eden Hazard\"\n        },\n        {\n          \"id\": 5,\n          \"name\": \"Paul Pogba\"\n        },\n        {\n          \"id\": 4,\n          \"name\": \"Ibrahimović\"\n        }\n      ]\n    }\n  }\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnull-none%2Fgraphene-pagination","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnull-none%2Fgraphene-pagination","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnull-none%2Fgraphene-pagination/lists"}