Skip to content

QuerySetGlue Guide

Purpose

QuerySetGlue allows the user to access a Django QuerySet from the front end.

When to use

  • When you need to access to multiple Django Model objects for front end functionality.
    • Ex: Glueing a Django QuerySet in order to select one from a glue select field.

When not to use

  • When jinja templates can also complete what you need to do.
    • Ex: Looping over a Django QuerySet to display information.

Shortcut Method

django_glue.shortcuts.glue_query_set

Source code in django_glue/shortcuts.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def glue_query_set(
        request: HttpRequest,
        unique_name: str,
        target: QuerySet,
        access: str = 'view',
        fields: Union[list, tuple] = (ALL_DUNDER_KEY,),
        exclude: Union[list, tuple] = (NONE_DUNDER_KEY,),
        methods: Union[list, tuple] = (NONE_DUNDER_KEY,),
):
    glue_query_set_entity = QuerySetGlue(
        unique_name=encode_unique_name(request, unique_name),
        query_set=target,
        access=access,
        included_fields=fields,
        excluded_fields=exclude,
        included_methods=methods
    )

    _glue_base_function(request, glue_query_set_entity)

How To Use

  1. Import django_glue. 

    import django_glue as dg

  2. Get the Django QuerySet you need access to on the front end. 

    import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

  3. Use the shortcut method glue_queryset_object(request, <str:unique_name>, <QuerySet:query_set>) to glue the model objects in the query set to the glue session data. 

    import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

    dg.glue_query_set(request=request, unique_name='adults', query_set=adults)

    ... update form logic ...

  4. On the front end using AlpineJS, initialize a new glue query set with the same unique name you specified in step 3. 

    <div 
    x-data="{
        adult_query_set: new GlueQuerySet('adults')
    }"
></div>

  5. Call the all method on the glue query set to retrieve the data from the Django Model Objects in the query set. 
    <div 
    x-data="{
        adults: [],
        adult_query_set: new GlueQuerySet('adults'),
        async init() {
            this.adults = await this.adult_query_set.all()
        }
    }"
></div>

Full Example

Back End

import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

    dg.glue_query_set(request=request, unique_name='adults', query_set=adults)

    ... update form logic ...

    return TemplateResponse(
        request=request,
        template='person/form/update_form.html',
        context={}
    )

Front End

<div 
    x-data="{
        adults: [],
        adult_query_set: new GlueQuerySet('adults'),
        async init() {
            this.adults = await this.adult_query_set.all()
        }
    }"
></div>

More Information

See QuerySetGlue for the different methods available for QuerySetGlue objects on the front end.