Add docs for autoload and autoinstall

duckdb · Dec 10, 2024 · 92b2f6c · 92b2f6c
1 parent e49d9a5
commit 92b2f6c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/extensions.md b/docs/extensions.md
@@ -14,7 +14,9 @@ Installing other extensions may work, but is at your own risk.
 
 ## Installing an extension
 
-Installing an extension requires superuser.
+By default known extensions are allowed to be automatically installed and loaded when a DuckDB query depends on them. This behaviour can be configured using the [`duckdb.autoinstall_known_extensions`](settings.md#duckdbautoinstall_known_extensions) and [`duckdb.autoload_known_extensions`](settings.md#duckdbautoload_known_extensions) settings.
+
+It's also possible to manually install an extension. This can be useful when this autoinstall/autoaload behaviour is disabled, or when DuckDB fails to realise an extension is necessary to execute the query. Installing an extension requires superuser.
 
 ```sql
 SELECT duckdb.install_extension('extname');

diff --git a/docs/settings.md b/docs/settings.md
@@ -67,6 +67,20 @@ Default: `"LocalFileSystem"`
 
 Access: Superuser-only
 
+### `duckdb.autoinstall_known_extensions`
+
+Whether known extensions are allowed to be automatically installed when a DuckDB query depends on them.
+
+Default: `true`
+
+Access: Superuser-only
+
+### `duckdb.autoload_known_extensions`
+
+Whether known extensions are allowed to be automatically loaded when a DuckDB query depends on them.
+
+Default: `true`
+
 ### `duckdb.enable_external_access` (experimental)
 
 Allow the DuckDB to access external access (e.g., HTTP, S3, etc.). This setting is not tested very well yet and disabling it may break unintended `pg_duckdb` functionality.