github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Facet documentation tweaks

Browse source
This commit is contained in:
Simon Willison 2018-05-16 08:45:12 -07:00
commit 96aac7f9e9
No known key found for this signature in database
GPG key ID: 17E2DEA2588B7F52
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/facets.rst
View file

@ -3,18 +3,18 @@
Facets 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. Datasette facets can be used to add a faceted browse interface to any database 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 .. image:: facets.png
Facets can be specified in two ways: using queryset parameters, or in ``metadata.json`` configuration for the table. Facets can be specified in two ways: using querystring parameters, or in ``metadata.json`` configuration for the table.
Facets in querystrings Facets in querystrings
---------------------- ----------------------
To turn on faceting for specific columns on a Datasette table view, add one or more ``_facet=COLUMN`` parameters to the URL. For example, if you want to turn on facets for the ``city`` and ``state`` columns, construct a URL that looks like this:: To turn on faceting for specific columns on a Datasette table view, add one or more ``_facet=COLUMN`` parameters to the URL. For example, if you want to turn on facets for the ``city_id`` and ``state`` columns, construct a URL that looks like this::
/dbname/tablename?_facet=state&_facet=city /dbname/tablename?_facet=state&_facet=city_id
This works for both the HTML interface and the ``.json`` view. When enabled, facets will cause a ``facet_results`` block to be added to the JSON output, looking something like this:: This works for both the HTML interface and the ``.json`` view. When enabled, facets will cause a ``facet_results`` block to be added to the JSON output, looking something like this::