Docs for installing extensions

docs/datamodel/extensions.rst

@@ -8,9 +8,92 @@ Extensions are the way EdgeDB adds more functionality. In principle,
 extensions could add new types, scalars, functions, etc., but, more
 importantly, they can add new ways of interacting with the database.
 
-- ``edgeql_http``: enables :ref:`EdgeQL over HTTP <ref_edgeql_http>`
-- ``graphql``: enables :ref:`GraphQL <ref_graphql_index>`
-- ``auth``: enables :ref:`EdgeDB Auth <ref_guide_auth>`
+Built-in extensions
+-------------------
+
+There are a few built-in extensions available:
+
+- ``edgeql_http``: enables :ref:`EdgeQL over HTTP <ref_edgeql_http>`,
+- ``graphql``: enables :ref:`GraphQL <ref_graphql_index>`,
+- ``auth``: enables :ref:`EdgeDB Auth <ref_guide_auth>`,
+- ``ai``: enables :ref:`ext::ai module <ref_ai_reference>`,
+
+- ``pg_trgm``: enables ``ext::pg_trgm``, which re-exports
+  `pgtrgm <https://www.postgresql.org/docs/current/pgtrgm.html>`__,
+
+- ``pg_unaccent``: enables ``ext::pg_unaccent``, which re-exports
+  `unaccent <https://www.postgresql.org/docs/current/unaccent.html>`__,
+
+- ``pgcrypto``: enables ``ext::pgcrypto``, which re-exports
+  `pgcrypto <https://www.postgresql.org/docs/current/pgcrypto.html>`__,
+
+- ``pgvector``: enables ``ext::pgvector``, which re-exports
+  `pgvector <https://github.com/pgvector/pgvector/>`__,
+
+.. _ref_datamodel_using_extension:
+
+To enable these extensions, add a ``using`` statement at the top level of your schema:
+
+.. code-block:: sdl
+
+    using extension auth;
+
+
+
+Standalone extensions
+---------------------
+
+Additionally, standalone extension packages can be installed via the CLI.
+
+List installed extensions:
+
+.. code-block:: bash
+
+    $ edgedb extension list -I my_instance
+    ┌─────────┬─────────┐
+    │ Name    │ Version │
+    └─────────┴─────────┘
+
+List available extensions:
+
+.. code-block:: bash
+
+    $ edgedb extension list-available -I my_instance
+    ┌─────────┬───────────────┐
+    │ Name    │ Version       │
+    │ postgis │ 3.4.3+6b82d77 │
+    └─────────┴───────────────┘
+
+Install the ``postgis`` extension:
+
+.. code-block:: bash
+
+    $ edgedb extension install -I my_instance -E postgis
+    Found extension package: postgis version 3.4.3+6b82d77
+    00:00:03 [====================] 22.49 MiB/22.49 MiB
+    Extension 'postgis' installed successfully.
+
+Check that extension is installed:
+
+.. code-block:: bash
+
+    $ edgedb extension list -I my_instance
+    ┌─────────┬───────────────┐
+    │ Name    │ Version       │
+    │ postgis │ 3.4.3+6b82d77 │
+    └─────────┴───────────────┘
+
+After installing extensions, make sure to restart your instance:
+
+.. code-block:: bash
+
+    $ edgedb instance restart -I my_instance
+
+Standalone extensions can now be declared in the schema, same as :ref:`built-in
+extensions <ref_datamodel_using_extension>`.
+
+To restore a dump that uses a standalone extension, that extension must be installed
+before the restore process.
 
 
 .. list-table::

setup.py

@@ -550,7 +550,6 @@ def _compile_cli(build_base, build_temp):
         check=True,
     )
 
-
     for dest in ('gel', 'edgedb'):
         cli_dest = ROOT_PATH / 'edb' / 'cli' / dest
         # Delete the target first, to avoid "Text file busy" errors during