pgtle.install_extension - Amazon Aurora
Function prototypeRoleArgumentsOutputUsage example
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

pgtle.install_extension

The install_extension function lets you install the artifacts that make up your TLE extension in the database, after which it can be created using the CREATE EXTENSION command.

Function prototype

pgtle.install_extension(name text, version text, description text, ext text, requires text[] DEFAULT NULL::text[])

Role

None.

Arguments

  • name – The name of the TLE extension. This value is used when calling CREATE EXTENSION.

  • version – The version of the TLE extension.

  • description – A detailed description about the TLE extension. This description is displayed in the comment field in pgtle.available_extensions().

  • ext – The contents of the TLE extension. This value contains objects such as functions.

  • requires – An optional parameter that specifies dependencies for this TLE extension. The pg_tle extension is automatically added as a dependency.

Many of these arguments are the same as those that are included in an extension control file for installing a PostgreSQL extension on the file system of a PostgreSQL instance. For more information, see the Extension Files in Packaging Related Objects into an Extension in the PostgreSQL documentation.

Output

This functions returns OK on success and NULL on error.

  • OK – The TLE extension has been successfully installed in the database.

  • NULL – The TLE extension hasn't been successfully installed in the database.

Usage example

SELECT pgtle.install_extension(
 pg_tle_test,
 0.1,
 My first pg_tle extension,
$_pgtle_$
  CREATE FUNCTION my_test()
  RETURNS INT
  AS $$
    SELECT 42;
  $$ LANGUAGE SQL IMMUTABLE;
$_pgtle_$
);