{"id": "plugin_hooks:plugin-hook-get-metadata", "page": "plugin_hooks", "ref": "plugin-hook-get-metadata", "title": "get_metadata(datasette, key, database, table)", "content": "datasette  -  Datasette class \n                     \n                         You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) . \n                     \n                 \n                 \n                     actor  - dictionary or None \n                     \n                         The currently authenticated  actor . \n                     \n                 \n                 \n                     database  - string or None \n                     \n                         The name of the database metadata is being asked for. \n                     \n                 \n                 \n                     table  - string or None \n                     \n                         The name of the table. \n                     \n                 \n                 \n                     key  - string or None \n                     \n                         The name of the key for which data is being asked for. \n                     \n                 \n             \n             This hook is responsible for returning a dictionary corresponding to Datasette  Metadata . This function is passed the  database ,  table  and  key  which were passed to the upstream internal request for metadata. Regardless, it is important to return a global metadata object, where  \"databases\": []  would be a top-level key. The dictionary returned here, will be merged with, and overwritten by, the contents of the physical  metadata.yaml  if one is present. \n             \n                 The design of this plugin hook does not currently provide a mechanism for interacting with async code, and may change in the future. See  issue 1384 . \n             \n             @hookimpl\ndef get_metadata(datasette, key, database, table):\n    metadata = {\n        \"title\": \"This will be the Datasette landing page title!\",\n        \"description\": get_instance_description(datasette),\n        \"databases\": [],\n    }\n    for db_name, db_data_dict in get_my_database_meta(\n        datasette, database, table, key\n    ):\n        metadata[\"databases\"][db_name] = db_data_dict\n    # whatever we return here will be merged with any other plugins using this hook and\n    # will be overwritten by a local metadata.yaml if one exists!\n    return metadata \n             Example:  datasette-remote-metadata plugin", "breadcrumbs": "[\"Plugin hooks\"]", "references": "[{\"href\": \"https://github.com/simonw/datasette/issues/1384\", \"label\": \"issue 1384\"}, {\"href\": \"https://datasette.io/plugins/datasette-remote-metadata\", \"label\": \"datasette-remote-metadata plugin\"}]"}