Extension Flask Debug Toolbar SQLAlchemy


Extension Basics

Title
Flask Debug Toolbar SQLAlchemy
Name
ckanext-fdt-sqlalchemy
Type
Public extension
Description
Enables Flask-DebugToolbar's SQLAlchemy pane for CKAN. Shows all database queries with SELECT and EXPLAIN capabilities for debugging and performance analysis.
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-10-17 16:42:14)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

Flask Debug Toolbar SQLAlchemy Extension

Enable Flask-DebugToolbar’s SQLAlchemy pane for CKAN.

Requirements

  • CKAN 2.9 or 2.10
  • flask-sqlalchemy~=2.5.0

Note: The latest version (v3.0) of flask-sqlalchemy is only partially supported. While it shows all the queries, SELECT and EXPLAIN links for individual queries do not work.

Features

  • SQLAlchemy panel in Flask Debug Toolbar
  • View all database queries on a page
  • SELECT and EXPLAIN links for individual queries (requires flask-sqlalchemy~=2.5.0)
  • Performance debugging and analysis

Installation

pip install 'ckanext-fdt-sqlalchemy[deps]'

Add fdt_sqlalchemy to ckan.plugins in your CKAN config file.

Developer Installation

git clone https://github.com/ckan/ckanext-fdt-sqlalchemy.git
cd ckanext-fdt-sqlalchemy
python setup.py develop

Note

This is an official CKAN extension for development/debugging purposes. Do not use in production environments with the debug toolbar enabled.

Version
0.0.2
Version release date
2023-06-27
Contact name
CKAN Team
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘fdt_sqlalchemy’ to ckan.plugins. Requires flask-sqlalchemy~=2.5.0 for full functionality. Development/debugging tool - do not use in production.

Plugins to configure (ckan.ini)
fdt_sqlalchemy
CKAN Settings (ckan.ini)
# No specific configuration options - requires Flask Debug Toolbar to be enabled
DB migration to be executed
(not set)
<< back to Extensions