https://github.com/simonw/datasette-configure-fts

Datasette plugin for enabling full-text search against selected table columns
https://github.com/simonw/datasette-configure-fts

datasette datasette-io datasette-plugin

Last synced: 3 months ago
JSON representation

Datasette plugin for enabling full-text search against selected table columns

• Host: GitHub
• URL: https://github.com/simonw/datasette-configure-fts
• Owner: simonw
• License: apache-2.0
• Created: 2020-02-29T01:50:57.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-14T02:59:54.000Z (10 months ago)
• Last Synced: 2024-05-01T23:17:23.380Z (9 months ago)
• Topics: datasette, datasette-io, datasette-plugin
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datasette-configure-fts

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

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

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

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

Datasette plugin for enabling full-text search against selected table columns

## Installation

Install this plugin in the same environment as Datasette.

    $ datasette install datasette-configure-fts

## Usage

Having installed the plugin, visit `/-/configure-fts` on your Datasette instance to configure FTS for tables on attached writable databases.

Any time you have permission to configure FTS for a table a menu item will appear in the table actions menu on the table page.

By default only [the root actor](https://datasette.readthedocs.io/en/stable/authentication.html#using-the-root-actor) can access the page - so you'll need to run Datasette with the `--root` option and click on the link shown in the terminal to sign in and access the page.

The `configure-fts` permission governs access. You can use permission plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) to grant additional access to the write interface.