Skip to content

Commit b9eb1d6

Browse files
committed
wip Add installation instructions for standalone extensions
1 parent 5995a50 commit b9eb1d6

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

docs/reference/datamodel/extensions.rst

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -53,40 +53,44 @@ Standalone extensions
5353

5454
.. api-index:: postgis
5555

56-
Additionally, standalone extension packages can be installed on local project-managed instances via the CLI, with ``postgis`` being a notable example.
56+
Unlike the built-in extensions, standalone extensions must be installed on the instance before they can be used in your instance's branches schemas. The manner in which you install these extensions will depend on whether you are using a local, remote instance, or are using |Gel| Cloud.
5757

58-
List installed extensions:
58+
Once you've installed them, standalone extensions can be declared in the schema, same as built-in extensions:
59+
60+
.. code-block:: sdl
61+
62+
using extension postgis;
63+
64+
.. note::
65+
66+
To restore a dump that uses a standalone extension, that extension must be installed before the restore process.
67+
68+
69+
Gel Cloud
70+
---------
71+
72+
If you are using |Gel| Cloud, standalone extentions...
73+
74+
Local instances
75+
---------------
76+
77+
Additionally, standalone extension packages can be installed on local project-managed instances via the CLI :gelcmd:`extension` command group, with ``postgis`` being a notable example.
5978

6079
.. code-block:: bash
6180
6281
$ gel extension list
6382
┌─────────┬─────────┐
6483
│ Name │ Version │
6584
└─────────┴─────────┘
66-
67-
List available extensions:
68-
69-
.. code-block:: bash
70-
7185
$ gel extension list-available
7286
┌─────────┬───────────────┐
7387
│ Name │ Version │
7488
│ postgis │ 3.4.3+6b82d77 │
7589
└─────────┴───────────────┘
76-
77-
Install the ``postgis`` extension:
78-
79-
.. code-block:: bash
80-
8190
$ gel extension install postgis
8291
Found extension package: postgis version 3.4.3+6b82d77
8392
00:00:03 [====================] 22.49 MiB/22.49 MiB
8493
Extension 'postgis' installed successfully.
85-
86-
Check that extension is installed:
87-
88-
.. code-block:: bash
89-
9094
$ gel extension list
9195
┌─────────┬───────────────┐
9296
│ Name │ Version │
@@ -99,16 +103,10 @@ After installing extensions, make sure to restart your instance:
99103
100104
$ gel instance restart
101105
102-
Standalone extensions can now be declared in the schema, same as
103-
built-in extensions:
104-
105-
.. code-block:: sdl
106-
107-
using extension postgis;
106+
Remote instances
107+
----------------
108108

109-
.. note::
110-
To restore a dump that uses a standalone extension, that extension must
111-
be installed before the restore process.
109+
If you are using a remote instance, see the :ref:`relevant deployment guide <ref_guide_deployment>` for instructions on how to install extensions.
112110

113111
.. _ref_eql_sdl_extensions:
114112

0 commit comments

Comments
 (0)