https://github.com/eyeseast/datasette-query-files

Write Datasette canned queries as plain SQL files
https://github.com/eyeseast/datasette-query-files

datasette datasette-plugin python sql sqlite

Last synced: 3 months ago
JSON representation

Write Datasette canned queries as plain SQL files

• Host: GitHub
• URL: https://github.com/eyeseast/datasette-query-files
• Owner: eyeseast
• License: apache-2.0
• Created: 2022-06-04T18:52:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-02T20:40:51.000Z (over 2 years ago)
• Last Synced: 2024-10-25T09:46:23.326Z (3 months ago)
• Topics: datasette, datasette-plugin, python, sql, sqlite
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 13
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datasette-query-files

[![PyPI](https://img.shields.io/pypi/v/datasette-query-files.svg)](https://pypi.org/project/datasette-query-files/)

[![Changelog](https://img.shields.io/github/v/release/eyeseast/datasette-query-files?include_prereleases&label=changelog)](https://github.com/eyeseast/datasette-query-files/releases)

[![Tests](https://github.com/eyeseast/datasette-query-files/workflows/Test/badge.svg)](https://github.com/eyeseast/datasette-query-files/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/eyeseast/datasette-query-files/blob/main/LICENSE)

Write Datasette canned queries as plain SQL files.

## Installation

Install this plugin in the same environment as Datasette.

    datasette install datasette-query-files

Or using `pip` or `pipenv`:

    pip install datasette-query-files

    pipenv install datasette-query-files

## Usage

This plugin will look for [canned queries](https://docs.datasette.io/en/stable/sql_queries.html#canned-queries) in the filesystem, in addition any defined in metadata.

Let's say you're working in a directory called `project-directory`, with a database file called `my-project.db`. Start by creating a `queries` directory with a `my-project` directory inside it. Any SQL file inside that `my-project` folder will become a canned query that can be run on the `my-project` database. If you have a `query-name.sql` file and a `query-name.json` (or `query-name.yml`) file in the same directory, the JSON file will be used as query metadata.

```

project-directory/

  my-project.db

  queries/

    my-project/

      query-name.sql # a query

      query-name.yml # query metadata

```

## Development

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

    cd datasette-query-files

    python3 -m venv venv

    source venv/bin/activate

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest