pgtle.install_extension - Amazon Relational Database Service
関数プロトタイプロール引数出力使用例

pgtle.install_extension

この install_extension 関数を使用すると、TLE 拡張機能を構成するアーティファクトをデータベースにインストールし、その後、CREATE EXTENSION コマンドを使用して作成できます。

関数プロトタイプ

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

ロール

なし。

引数

  • name – TLE 拡張機能の名前。この値は CREATE EXTENSION を呼び出すときに使用されます。

  • version – TLE 拡張機能のバージョン。

  • description – TLE 拡張機能に関する詳細な説明。この説明は、pgtle.available_extensions() の comment フィールドに表示されます。

  • ext – TLE 拡張機能の内容。この値には、関数などのオブジェクトが含まれます。

  • requires – この TLE 拡張機能の依存関係を指定するオプションパラメータ。pg_tle 拡張機能は、依存関係として自動的に追加されます。

これらの引数の多くは、PostgreSQL インスタンスのファイルシステムに PostgreSQL 拡張機能をインストールするための拡張制御ファイルに含まれている引数と同じです。詳細については、PostgreSQL ドキュメントの「拡張機能への関連オブジェクトのパッケージ化」にある「拡張ファイル」を参照してください。

出力

この関数は、正常時には OK を、エラー時には NULL を返します。

  • OK – TLE 拡張機能がデータベースに正常にインストールされました。

  • NULL – TLE 拡張機能がデータベースに正常にインストールされませんでした。

使用例

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_$
);