Skip to content

Commit

Permalink
Added screenshots to facets and full_text_search docs, refs #255
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw authored and Simon Willison committed May 16, 2018
1 parent 858d79f commit 9959a9e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 0 deletions.
Binary file added docs/facets.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/facets.rst
Expand Up @@ -5,6 +5,8 @@ Facets

Datasette facets can be used to add a faceted browse interface to any Datasette table. With facets, tables are displayed along with a summary showing the most common values in specified columns. These values can be selected to further filter the table.

.. image:: facets.png

Facets can be specified in two ways: using queryset parameters, or in ``metadata.json`` configuration for the table.

Facets in querystrings
Expand Down
Binary file added docs/full_text_search.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/full_text_search.rst
Expand Up @@ -5,6 +5,8 @@ Full-text search

SQLite includes `a powerful mechanism for enabling full-text search <https://www.sqlite.org/fts3.html>`_ against SQLite records. Datasette can detect if a table has had full-text search configured for it in the underlying database and display a search interface for filtering that table.

.. image:: full_text_search.png

Datasette detects which tables have been configured for full-text search when it first inspects the database on startup (or via the ``datasette inspect`` command). You can visit the ``/-/inspect`` page on your Datasette instance to see the results of this inspection. Tables that have been configured for full-text search will have their ``fts_table`` property set to the name of another table (tables without full-text search will have this property set to ``null``).

FTS versions
Expand Down

0 comments on commit 9959a9e

Please sign in to comment.