File tree Expand file tree Collapse file tree 6 files changed +154
-0
lines changed
Expand file tree Collapse file tree 6 files changed +154
-0
lines changed Original file line number Diff line number Diff line change 1+ .. _ref_cli_gel_extension :
2+
3+ =============
4+ gel extension
5+ =============
6+
7+ The :gelcmd: `extension ` command group contains commands for managing standalone extensions.
8+
9+ .. toctree ::
10+ :maxdepth: 2
11+ :hidden:
12+
13+ list
14+ list-available
15+ install
16+ uninstall
17+
18+ Subcommands
19+ ===========
20+
21+ .. list-table ::
22+ :class: synopsis
23+
24+ * - :ref: `ref_cli_gel_extension_list `
25+ - List installed extensions.
26+ * - :ref: `ref_cli_gel_extension_list_available `
27+ - List available extensions.
28+ * - :ref: `ref_cli_gel_extension_install `
29+ - Install an extension.
30+ * - :ref: `ref_cli_gel_extension_uninstall `
31+ - Uninstall an extension.
32+
33+ See :ref: `Connection options <ref_cli_gel_connopts >` for options applicable to all subcommands.
Original file line number Diff line number Diff line change 1+ .. _ref_cli_gel_extension_install :
2+
3+ =====================
4+ gel extension install
5+ =====================
6+
7+ Install an extension.
8+
9+ .. cli :synopsis ::
10+
11+ gel extension install <extension> [<options>]
12+
13+ Arguments
14+ =========
15+
16+ :cli:synopsis: `<extension> `
17+ The name of the extension to install.
18+
19+ Options
20+ =======
21+
22+ See :ref: `Connection options <ref_cli_gel_connopts >` for global options.
23+
24+ Examples
25+ ========
26+
27+ Install the ``postgis `` extension:
28+
29+ .. code-block :: bash
30+
31+ $ gel extension install postgis
32+ Found extension package: postgis version 3.4.3+6b82d77
33+ 00:00:03 [==================== ] 22.49 MiB/22.49 MiB
34+ Extension ' postgis' installed successfully.
Original file line number Diff line number Diff line change 1+ .. _ref_cli_gel_extension_list_available :
2+
3+ ============================
4+ gel extension list-available
5+ ============================
6+
7+ List available extensions.
8+
9+ .. cli :synopsis ::
10+
11+ gel extension list-available [<options>]
12+
13+ Options
14+ =======
15+
16+ See :ref: `Connection options <ref_cli_gel_connopts >` for global options.
17+
18+ Examples
19+ ========
20+
21+ .. code-block :: bash
22+
23+ $ gel extension list-available
24+ ┌─────────┬───────────────┐
25+ │ Name │ Version │
26+ │ postgis │ 3.4.3+6b82d77 │
27+ └─────────┴───────────────┘
Original file line number Diff line number Diff line change 1+ .. _ref_cli_gel_extension_list :
2+
3+ ==================
4+ gel extension list
5+ ==================
6+
7+ List installed extensions.
8+
9+ .. cli :synopsis ::
10+
11+ gel extension list [<options>]
12+
13+ Options
14+ =======
15+
16+ See :ref: `Connection options <ref_cli_gel_connopts >` for global options.
17+
18+ Examples
19+ ========
20+
21+ .. code-block :: bash
22+
23+ $ gel extension list
24+ ┌─────────┬───────────────┐
25+ │ Name │ Version │
26+ │ postgis │ 3.4.3+6b82d77 │
27+ └─────────┴───────────────┘
Original file line number Diff line number Diff line change 1+ .. _ref_cli_gel_extension_uninstall :
2+
3+ =======================
4+ gel extension uninstall
5+ =======================
6+
7+ Uninstall an extension.
8+
9+ .. cli :synopsis ::
10+
11+ gel extension uninstall <extension> [<options>]
12+
13+ Arguments
14+ =========
15+
16+ :cli:synopsis: `<extension> `
17+ The name of the extension to uninstall.
18+
19+ Options
20+ =======
21+
22+ See :ref: `Connection options <ref_cli_gel_connopts >` for global options.
23+
24+ Examples
25+ ========
26+
27+ Uninstall the ``postgis `` extension:
28+
29+ .. code-block :: bash
30+
31+ $ gel extension uninstall postgis
32+ Extension ' postgis' uninstalled successfully.
Original file line number Diff line number Diff line change @@ -151,6 +151,7 @@ The ``cli.toml`` has the following structure. All fields are optional:
151151 gel_list
152152 gel_info
153153 gel_cli_upgrade
154+ gel_extension/index
154155 gel_server/index
155156 gel_describe/index
156157 gel_instance/index
You can’t perform that action at this time.
0 commit comments