From 3034be98b395aecf6c2fe06021aec8fadcf1ec42 Mon Sep 17 00:00:00 2001 From: Raminder Singh Date: Tue, 3 Oct 2023 12:28:09 +0530 Subject: [PATCH] vscode format on save --- docs/extension_structure.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/extension_structure.md b/docs/extension_structure.md index 31104ee7..5f8bb832 100644 --- a/docs/extension_structure.md +++ b/docs/extension_structure.md @@ -5,22 +5,23 @@ A Postgres [trusted lanuguage extension](https://github.com/aws/pg_tle) (TLE) co For an extension to be valid, one file of each type must be present in an extension. For example, if you want to create an extension named `my-extension`, create the following folder structure: -* my-extension - * my-extension.control - * my-extension--0.0.1.sql +- my-extension + - my-extension.control + - my-extension--0.0.1.sql -In the above example, the `my-extension` folder contains the extension files. Names of the files are important. The control file should be named `.control` and the script file should be named `--.sql`. +In the above example, the `my-extension` folder contains the extension files. Names of the files are important. The control file should be named `.control` and the script file should be named `--.sql`. ## Control Files + A control file contains metadata about the extension in key-value pairs. The most common keys that you should consider setting are the following: -* default_version (string). The version to use if the user doesn't provide one in the `create extension` command. -* comment (string). Think of this as the description of the extension. -* requires (string). A comma separated list of extensions that this extension depends on. -* relocatable (boolean). Set to true if the extension's objects can be moved to a different schema after they are created. -* superuser (boolean). Set to true if only superusers should be able to create this extension. +- default_version (string). The version to use if the user doesn't provide one in the `create extension` command. +- comment (string). Think of this as the description of the extension. +- requires (string). A comma separated list of extensions that this extension depends on. +- relocatable (boolean). Set to true if the extension's objects can be moved to a different schema after they are created. +- superuser (boolean). Set to true if only superusers should be able to create this extension. -For example, the [pgjwt extenion's control file](https://github.com/michelp/pgjwt/blob/master/pgjwt.control) looks like this: +For example, the [pgjwt extension's control file](https://github.com/michelp/pgjwt/blob/master/pgjwt.control) looks like this: ```control # pgjwt extension @@ -34,4 +35,5 @@ superuser = false For a complete list of keys available in a control file, refer to [Postgres documentation](https://www.postgresql.org/docs/current/extend-extensions.html#EXTEND-EXTENSIONS-FILES). ## Script Files + Script files contain the SQL objects to be created by the extension.