mirror
/
datasette
kopia lustrzana https://github.com/simonw/datasette
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Updated custom facet docs, closes #482

pull/556/head
Simon Willison 2019-07-07 16:19:02 -07:00
rodzic 912ce848b9
commit 9998f92cc0
1 zmienionych plików z 6 dodań i 5 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

11
docs/plugins.rst
Wyświetl plik

@ -712,9 +712,9 @@ Each Facet subclass implements a new type of facet operation. The class should l
# This key must be unique across all facet classes: # This key must be unique across all facet classes:
type = "special" type = "special"
async def suggest(self, sql, params, filtered_table_rows_count): async def suggest(self):
# Use self.sql and self.params to suggest some facets
suggested_facets = [] suggested_facets = []
# Perform calculations to suggest facets
suggested_facets.append({ suggested_facets.append({
"name": column, # Or other unique name "name": column, # Or other unique name
# Construct the URL that will enable this facet: # Construct the URL that will enable this facet:
@ -726,8 +726,9 @@ Each Facet subclass implements a new type of facet operation. The class should l
}) })
return suggested_facets return suggested_facets
async def facet_results(self, sql, params): async def facet_results(self):
# This should execute the facet operation and return results # This should execute the facet operation and return results, again
# using self.sql and self.params as the starting point
facet_results = {} facet_results = {}
facets_timed_out = [] facets_timed_out = []
# Do some calculations here... # Do some calculations here...
@ -752,7 +753,7 @@ Each Facet subclass implements a new type of facet operation. The class should l
return facet_results, facets_timed_out return facet_results, facets_timed_out
See ``datasette/facets.py`` for examples of how these classes can work. See `datasette/facets.py <https://github.com/simonw/datasette/blob/master/datasette/facets.py>`__ for examples of how these classes can work.
The plugin hook can then be used to register the new facet class like this: The plugin hook can then be used to register the new facet class like this: