Skip to content

Commit 1c9b954

Browse files
committed
Update pgtle.available_extensions and pgtle.install_extension doc
1 parent 17387db commit 1c9b954

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/03_managing_extensions.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ None.
4646

4747
* `name`: The name of the extension.
4848
* `default_version`: The version of the extension to use when `CREATE EXTENSION` is called without a version.
49+
* `superuser`: This is always `false` for a pg_tle-compatible extension.
50+
* `trusted`: This is always `false` for a pg_tle-compatible extension.
51+
* `relocatable`: This is always `false` for a pg_tle-compatible extension.
52+
* `schema`: This is set if the extension must be installed into a specific schema.
53+
* `requires`: An array of extension names that this extension depends on.
4954
* `comment`: A more detailed description about the extension.
5055

5156
#### Example
@@ -109,7 +114,7 @@ None.
109114
SELECT * FROM pgtle.extension_update_paths('pg_tle_test');
110115
```
111116

112-
### `pgtle.install_extension(name text, version text, description text, ext text, requires text[] DEFAULT NULL::text[])`
117+
### `pgtle.install_extension(name text, version text, description text, ext text, requires text[] DEFAULT NULL::text[], schema text DEFAULT NULL)`
113118

114119
`install_extension` lets users install a `pg_tle`-compatible extensions and make them available within a database.
115120

@@ -126,6 +131,7 @@ This functions returns `'OK'` on success and an error otherwise..
126131
* `description`: A detailed description about the extension. This is displayed in the `comment` field in `pgtle.available_extensions()`.
127132
* `ext`: The contents of the extension. This contains objects such as functions.
128133
* `requires`: An optional parameter that specifies dependencies for this extension. `pg_tle` is automatically added as a dependency.
134+
* `schema`: An optional parameter that specifies the schema that the extension must be installed in.
129135

130136
Many of the above values are part of the [extension control file](https://www.postgresql.org/docs/current/extend-extensions.html#id-1.8.3.20.11) used to provide information about how to install a PostgreSQL extension. For more information about how each of these values work, please see the PostgreSQL documentation on [extension control files](https://www.postgresql.org/docs/current/extend-extensions.html#id-1.8.3.20.11).
131137

0 commit comments

Comments
 (0)