datasette-explain

Name	datasette-explain JSON
Version	0.2 JSON
	download
home_page	https://github.com/simonw/datasette-explain
Summary	Explain SQL queries executed using Datasette
upload_time	2024-02-28 16:37:06
maintainer
docs_url	None
author	Simon Willison
requires_python	>=3.7
license	Apache License, Version 2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # datasette-explain

[![PyPI](https://img.shields.io/pypi/v/datasette-explain.svg)](https://pypi.org/project/datasette-explain/)
[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-explain?include_prereleases&label=changelog)](https://github.com/simonw/datasette-explain/releases)
[![Tests](https://github.com/simonw/datasette-explain/workflows/Test/badge.svg)](https://github.com/simonw/datasette-explain/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-explain/blob/main/LICENSE)

Explain SQL queries executed using Datasette

## Installation

Install this plugin in the same environment as Datasette.

    datasette install datasette-explain

This plugin requires a Datasette 1.0 alpha or higher.

## Usage

The plugin adds JavaScript to the query editor page which will constantly update the page with information gained from running EXPLAIN QUERY PLAN queries against the entered SQL.

This may result in an error message, or it may show the query plan along with any tables used by the query.

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

    cd datasette-explain
    python3 -m venv venv
    source venv/bin/activate

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simonw/datasette-explain",
    "name": "datasette-explain",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Simon Willison",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e3/9d/ef16457560afb0c86ff4cf85151f166864d05cb5656bb360ae51f4748a0d/datasette-explain-0.2.tar.gz",
    "platform": null,
    "description": "# datasette-explain\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-explain.svg)](https://pypi.org/project/datasette-explain/)\n[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-explain?include_prereleases&label=changelog)](https://github.com/simonw/datasette-explain/releases)\n[![Tests](https://github.com/simonw/datasette-explain/workflows/Test/badge.svg)](https://github.com/simonw/datasette-explain/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-explain/blob/main/LICENSE)\n\nExplain SQL queries executed using Datasette\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n\n    datasette install datasette-explain\n\nThis plugin requires a Datasette 1.0 alpha or higher.\n\n## Usage\n\nThe plugin adds JavaScript to the query editor page which will constantly update the page with information gained from running EXPLAIN QUERY PLAN queries against the entered SQL.\n\nThis may result in an error message, or it may show the query plan along with any tables used by the query.\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n\n    cd datasette-explain\n    python3 -m venv venv\n    source venv/bin/activate\n\nNow install the dependencies and test dependencies:\n\n    pip install -e '.[test]'\n\nTo run the tests:\n\n    pytest\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Explain SQL queries executed using Datasette",
    "version": "0.2",
    "project_urls": {
        "CI": "https://github.com/simonw/datasette-explain/actions",
        "Changelog": "https://github.com/simonw/datasette-explain/releases",
        "Homepage": "https://github.com/simonw/datasette-explain",
        "Issues": "https://github.com/simonw/datasette-explain/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b44fce490c4e1fbded613d43283ddaf7caa57171d0f3792817901a05aad1792",
                "md5": "5cac50f8372c85574bec509bc1d52940",
                "sha256": "2d66e6805290005a441017b3bec44328aa7c631a6a52d9fe9875e813a07f47e7"
            },
            "downloads": -1,
            "filename": "datasette_explain-0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5cac50f8372c85574bec509bc1d52940",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 8339,
            "upload_time": "2024-02-28T16:37:05",
            "upload_time_iso_8601": "2024-02-28T16:37:05.395696Z",
            "url": "https://files.pythonhosted.org/packages/7b/44/fce490c4e1fbded613d43283ddaf7caa57171d0f3792817901a05aad1792/datasette_explain-0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e39def16457560afb0c86ff4cf85151f166864d05cb5656bb360ae51f4748a0d",
                "md5": "b207f56ee1d82efbaa91c7ebbb48fc00",
                "sha256": "10a94703884420598ab61527b97659dece970554520f4fee3b8fbdb5273a1ec3"
            },
            "downloads": -1,
            "filename": "datasette-explain-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b207f56ee1d82efbaa91c7ebbb48fc00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 8508,
            "upload_time": "2024-02-28T16:37:06",
            "upload_time_iso_8601": "2024-02-28T16:37:06.993084Z",
            "url": "https://files.pythonhosted.org/packages/e3/9d/ef16457560afb0c86ff4cf85151f166864d05cb5656bb360ae51f4748a0d/datasette-explain-0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-28 16:37:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonw",
    "github_project": "datasette-explain",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datasette-explain"
}