home / docs / sections

sections: plugin_hooks:plugin-hook-prepare-connection

This data as json

id page ref title content breadcrumbs references
plugin_hooks:plugin-hook-prepare-connection plugin_hooks plugin-hook-prepare-connection prepare_connection(conn, database, datasette) conn - sqlite3 connection object The connection that is being opened database - string The name of the database datasette - Datasette class You can use this to access plugin configuration options via datasette.plugin_config(your_plugin_name) This hook is called when a new SQLite database connection is created. You can use it to register custom SQL functions , aggregates and collations. For example: from datasette import hookimpl import random @hookimpl def prepare_connection(conn): conn.create_function( "random_integer", 2, random.randint ) This registers a SQL function called random_integer which takes two arguments and can be called like this: select random_integer(1, 10); prepare_connection() hooks are not called for Datasette's internal database . Examples: datasette-jellyfish , datasette-jq , datasette-haversine , datasette-rure ["Plugin hooks"] [{"href": "https://docs.python.org/2/library/sqlite3.html#sqlite3.Connection.create_function", "label": "register custom SQL functions"}, {"href": "https://datasette.io/plugins/datasette-jellyfish", "label": "datasette-jellyfish"}, {"href": "https://datasette.io/plugins/datasette-jq", "label": "datasette-jq"}, {"href": "https://datasette.io/plugins/datasette-haversine", "label": "datasette-haversine"}, {"href": "https://datasette.io/plugins/datasette-rure", "label": "datasette-rure"}]
Powered by Datasette · Queries took 1.254ms