Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pjosols/datatables-mongoengine
MongoEngine QuerySet class that adds functionality for returning results for DataTables.
https://github.com/pjosols/datatables-mongoengine
Last synced: 5 days ago
JSON representation
MongoEngine QuerySet class that adds functionality for returning results for DataTables.
- Host: GitHub
- URL: https://github.com/pjosols/datatables-mongoengine
- Owner: pjosols
- License: mit
- Created: 2021-02-01T23:25:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T22:57:32.000Z (almost 4 years ago)
- Last Synced: 2024-11-10T13:54:07.931Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DataTables with MongoEngine
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'}
],
});
### A note about flask-mongoengine
If you're using flask-mongoengine but overriding the default QuerySet class like above,
you'll lose a few nice things like the `get_or_404` method, which works like Django's
`get_object_or_404`. You can add that back (and more), like this.
from flask import jsonify, abort, make_response
from mongoengine import DoesNotExist
from datatables_mongoengine import DataTablesManager
class MyQuerySet(DataTablesManager):
"""Some tricks from flask-mongoengine that we miss."""
def get_or_404(self, *args, **kwargs):
"""Get a document and raise a 404 Not Found error if it doesn't exist."""
try:
return self.get(*args, **kwargs)
except DoesNotExist:
abort(404)
def get_or_json_404(self, *args, **kwargs):
"""
Same as above but with a JSON response. This doesn't come from
flask-mongoengine.
"""
try:
return self.get(*args, **kwargs)
except DoesNotExist:
abort(make_response(jsonify(message="Not found"), 404))
def first_or_404(self):
"""Same as get_or_404, but uses .first, not .get."""
obj = self.first()
if obj is None:
abort(404)
return obj
Now set `queryset_class` to `MyQuerySet` and you can again do
`Model.objects.get_or_404(key="val")`. There's also a `paginate` method created by
flask-mongoengine but I haven't used it so I'm excluding it.