Skip to main content

Mixin for connecting DataTables to MongoDB with MongoEngine.

Project description

MongoEngine DataTables

The DataTablesManager class can be used instead of the default MongoEngine QuerySet class to add a datatables method for returning results as required by the jQuery plugin DataTables.

Installation

pip install datatables-mongoengine

Example

Here's an example for Flask.

models.py

from mongoengine import Document, StringField, ListField
from datatables_mongoengine import DataTablesManager


class Links(Document):
    """The MongoEngine ODM class for the links collection."""

    meta = {
        "queryset_class": DataTablesManager
    }
    name = StringField()
    category = StringField()
    link = StringField()
    group = ListField()

routes.py

from flask import request, g, jsonify

from app import app
from app.models import Links


@app.route("/ajax/links", methods=["POST"])
def ajax_links():
    """Get results from MongoDB for DataTables."""

    data = request.get_json()
    custom_filter = {
        'group': g.user.group
    }

    results = Links.objects.datatables(data, **custom_filter)
    return jsonify(results)

Note that you can inject any filter you want server-side, like I do above to make sure the results all match the current user's group.

app.js

$(document).ready( function () {
    $('#example').DataTable({
        processing: true,
        serverSide: true,
        ajax: {
            url: '/ajax/links',
            dataSrc: 'data',
            type: 'POST',
            contentType: 'application/json',
            data: function (d) {
                return  JSON.stringify(d)
            }
        },
        columns: [
            { data: 'name'},
            { data: 'category'},
            { data: 'link'}
        ],
    });

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datatables_mongoengine-0.1.5.tar.gz (3.5 kB view hashes)

Uploaded Source

Built Distribution

datatables_mongoengine-0.1.5-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page