{"id": "metadata:database-level-metadata", "page": "metadata", "ref": "database-level-metadata", "title": "Database-level metadata", "content": "\"Database-level\" metadata refers to fields that can be specified for each database in a Datasette instance. These attributes should be listed under a database inside the  \"databases\"  field. \n                 The following are the full list of allowed database-level metadata fields: \n                 \n                     \n                         source \n                     \n                     \n                         source_url \n                     \n                     \n                         license \n                     \n                     \n                         license_url \n                     \n                     \n                         about \n                     \n                     \n                         about_url", "breadcrumbs": "[\"Metadata\", \"Metadata reference\"]", "references": "[]"}
{"id": "metadata:id2", "page": "metadata", "ref": "id2", "title": "Metadata reference", "content": "A full reference of every supported option in a  metadata.json  or  metadata.yaml  file.", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:label-columns", "page": "metadata", "ref": "label-columns", "title": "Specifying the label column for a table", "content": "Datasette's HTML interface attempts to display foreign key references as\n                labelled hyperlinks. By default, it looks for referenced tables that only have\n                two columns: a primary key column and one other. It assumes that the second\n                column should be used as the link label. \n             If your table has more than two columns you can specify which column should be\n                used for the link label with the  label_column  property: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"label_column\": \"title\"\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]]", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:metadata-column-descriptions", "page": "metadata", "ref": "metadata-column-descriptions", "title": "Column descriptions", "content": "You can include descriptions for your columns by adding a  \"columns\": {\"name-of-column\": \"description-of-column\"}  block to your table metadata: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"columns\": {\n                        \"column1\": \"Description of column 1\",\n                        \"column2\": \"Description of column 2\"\n                    }\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             These will be displayed at the top of the table page, and will also show in the cog menu for each column. \n             You can see an example of how these look at  latest.datasette.io/fixtures/roadside_attractions .", "breadcrumbs": "[\"Metadata\"]", "references": "[{\"href\": \"https://latest.datasette.io/fixtures/roadside_attractions\", \"label\": \"latest.datasette.io/fixtures/roadside_attractions\"}]"}
{"id": "metadata:metadata-default-sort", "page": "metadata", "ref": "metadata-default-sort", "title": "Setting a default sort order", "content": "By default Datasette tables are sorted by primary key. You can over-ride this default for a specific table using the  \"sort\"  or  \"sort_desc\"  metadata properties: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"mydatabase\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"sort\": \"created\"\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             Or use  \"sort_desc\"  to sort in descending order: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"mydatabase\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"sort_desc\": \"created\"\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]]", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:metadata-hiding-tables", "page": "metadata", "ref": "metadata-hiding-tables", "title": "Hiding tables", "content": "You can hide tables from the database listing view (in the same way that FTS and\n                SpatiaLite tables are automatically hidden) using  \"hidden\": true : \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"hidden\": True\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]]", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:metadata-page-size", "page": "metadata", "ref": "metadata-page-size", "title": "Setting a custom page size", "content": "Datasette defaults to displaying 100 rows per page, for both tables and views. You can change this default page size on a per-table or per-view basis using the  \"size\"  key in  metadata.json : \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"mydatabase\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"size\": 10\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             This size can still be over-ridden by passing e.g.  ?_size=50  in the query string.", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:metadata-sortable-columns", "page": "metadata", "ref": "metadata-sortable-columns", "title": "Setting which columns can be used for sorting", "content": "Datasette allows any column to be used for sorting by default. If you need to\n                control which columns are available for sorting you can do so using the optional\n                 sortable_columns  key: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"sortable_columns\": [\n                        \"height\",\n                        \"weight\"\n                    ]\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             This will restrict sorting of  example_table  to just the  height  and\n                 weight  columns. \n             You can also disable sorting entirely by setting  \"sortable_columns\": [] \n             You can use  sortable_columns  to enable specific sort orders for a view called  name_of_view  in the database  my_database  like so: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"my_database\": {\n            \"tables\": {\n                \"name_of_view\": {\n                    \"sortable_columns\": [\n                        \"clicks\",\n                        \"impressions\"\n                    ]\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]]", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:metadata-source-license-about", "page": "metadata", "ref": "metadata-source-license-about", "title": "Source, license and about", "content": "The three visible metadata fields you can apply to everything, specific databases or specific tables are source, license and about. All three are optional. \n             source  and  source_url  should be used to indicate where the underlying data came from. \n             license  and  license_url  should be used to indicate the license under which the data can be used. \n             about  and  about_url  can be used to link to further information about the project - an accompanying blog entry for example. \n             For each of these you can provide just the  *_url  field and Datasette will treat that as the default link label text and display the URL directly on the page.", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:per-database-and-per-table-metadata", "page": "metadata", "ref": "per-database-and-per-table-metadata", "title": "Per-database and per-table metadata", "content": "Metadata at the top level of the file will be shown on the index page and in the\n                footer on every page of the site. The license and source is expected to apply to\n                all of your data. \n             You can also provide metadata at the per-database or per-table level, like this: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"source\": \"Alternative source\",\n            \"source_url\": \"http://example.com/\",\n            \"tables\": {\n                \"example_table\": {\n                    \"description_html\": \"Custom <em>table</em> description\",\n                    \"license\": \"CC BY 3.0 US\",\n                    \"license_url\": \"https://creativecommons.org/licenses/by/3.0/us/\"\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             Each of the top-level metadata fields can be used at the database and table level.", "breadcrumbs": "[\"Metadata\"]", "references": "[]"}
{"id": "metadata:specifying-units-for-a-column", "page": "metadata", "ref": "specifying-units-for-a-column", "title": "Specifying units for a column", "content": "Datasette supports attaching units to a column, which will be used when displaying\n                values from that column. SI prefixes will be used where appropriate. \n             Column units are configured in the metadata like so: \n             [[[cog\nmetadata_example(cog, {\n    \"databases\": {\n        \"database1\": {\n            \"tables\": {\n                \"example_table\": {\n                    \"units\": {\n                        \"column1\": \"metres\",\n                        \"column2\": \"Hz\"\n                    }\n                }\n            }\n        }\n    }\n}) \n             ]]] \n             [[[end]]] \n             Units are interpreted using  Pint , and you can see the full list of available units in\n                Pint's  unit registry . You can also add  custom units  to the metadata, which will be\n                registered with Pint: \n             [[[cog\nmetadata_example(cog, {\n    \"custom_units\": [\n        \"decibel = [] = dB\"\n    ]\n}) \n             ]]] \n             [[[end]]]", "breadcrumbs": "[\"Metadata\"]", "references": "[{\"href\": \"https://pint.readthedocs.io/\", \"label\": \"Pint\"}, {\"href\": \"https://github.com/hgrecco/pint/blob/master/pint/default_en.txt\", \"label\": \"unit registry\"}, {\"href\": \"http://pint.readthedocs.io/en/latest/defining.html\", \"label\": \"custom units\"}]"}
{"id": "metadata:table-level-metadata", "page": "metadata", "ref": "table-level-metadata", "title": "Table-level metadata", "content": "\"Table-level\" metadata refers to fields that can be specified for each table in a Datasette instance. These attributes should be listed under a specific table using the  \"tables\"  field. \n                 The following are the full list of allowed table-level metadata fields: \n                 \n                     \n                         source \n                     \n                     \n                         source_url \n                     \n                     \n                         license \n                     \n                     \n                         license_url \n                     \n                     \n                         about \n                     \n                     \n                         about_url \n                     \n                     \n                         hidden \n                     \n                     \n                         sort/sort_desc \n                     \n                     \n                         size \n                     \n                     \n                         sortable_columns \n                     \n                     \n                         label_column \n                     \n                     \n                         facets \n                     \n                     \n                         fts_table \n                     \n                     \n                         fts_pk \n                     \n                     \n                         searchmode \n                     \n                     \n                         columns", "breadcrumbs": "[\"Metadata\", \"Metadata reference\"]", "references": "[]"}
{"id": "metadata:top-level-metadata", "page": "metadata", "ref": "top-level-metadata", "title": "Top-level metadata", "content": "\"Top-level\" metadata refers to fields that can be specified at the root level  of a metadata file. These attributes are meant to describe the entire Datasette instance. \n                 The following are the full list of allowed top-level metadata fields: \n                 \n                     \n                         title \n                     \n                     \n                         description \n                     \n                     \n                         description_html \n                     \n                     \n                         license \n                     \n                     \n                         license_url \n                     \n                     \n                         source \n                     \n                     \n                         source_url", "breadcrumbs": "[\"Metadata\", \"Metadata reference\"]", "references": "[]"}