本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

Postgre 可信任語言擴充功能的函數參考 SQL

檢視下列有關 Postgre SQL 信任語言擴充功能中可用之函數的參考文件。使用這些功能來安裝、註冊、更新和管理您的TLE擴充功能，也就是您使用受信任語言SQL擴充功能開發套件開發的 Postgre 擴充功能。

pgtle.available_extensions

pgtle.available_extensions 函數是一個設定-傳回函數。它返回數據庫中的所有可用TLE擴展。每個傳回的資料列都包含單一TLE副檔名的相關資訊

函數原型

pgtle.available_extensions()

角色

無。

引數

無。

輸出

使用範例

SELECT * FROM pgtle.available_extensions();

pgtle.available_extension_versions

available_extension_versions 函數是一個設定-傳回函數。它返回所有可用TLE擴展及其版本的列表。每一列都包含指定TLE擴充功能之特定版本的相關資訊，包括是否需要特定角色。

函數原型

pgtle.available_extension_versions()

角色

無。

引數

無。

輸出

如需有關輸出值的詳細資訊，請參閱 Postgre SQL 文件中的將相關物件封裝至延伸功能 > 延伸功能檔案。

使用範例

SELECT * FROM pgtle.available_extension_versions();

pgtle.extension_update_paths

extension_update_paths 函數是一個設定-傳回函數。它返回一個TLE擴展的所有可能的更新路徑的列表。每一列都包含該TLE擴充功能的可用升級或降級。

函數原型

pgtle.extension_update_paths(name)

角色

無。

引數

name— 要從中取得升級路徑的TLE擴充功能名稱。

輸出

使用範例

SELECT * FROM pgtle.extension_update_paths('your-TLE');

pgtle.install_extension

該install_extension功能允許您在數據庫中安裝構成TLE擴展程序的成品，然後可以使用CREATE EXTENSION命令創建它。

函數原型

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

角色

無。

引數

這些引數中的許多引數與包含在 Postgre 實例的檔案系統上安裝 Postgre SQL 副檔名時所包含的引數相同。SQL如需詳細資訊，請參閱 Postgre SQL 文件中的將相關物件封裝至延伸模組中的延伸檔案。

輸出

此函數會在成功時傳回 OK，以及在發生錯誤時傳回 NULL。

使用範例

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

pgtle.install_update_path

該install_update_path函數提供了TLE擴展的兩個不同版本之間的更新路徑。此功能允許TLE擴展程序的用戶通過使用ALTER EXTENSION ... UPDATE語法更新其版本。

函數原型

pgtle.install_update_path(name text, fromvers text, tovers text, ext text)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT pgtle.install_update_path('pg_tle_test', '0.1', '0.2',
  $_pgtle_$
    CREATE OR REPLACE FUNCTION my_test()
    RETURNS INT
    AS $$
      SELECT 21;
    $$ LANGUAGE SQL IMMUTABLE;
  $_pgtle_$
);

pgtle.register_feature

該register_feature函數將指定的內部 Postgre SQL 功能添加到pgtle.feature_info表中。後SQL掛鉤是內部 Postgre 特徵的一個範例。SQL受信任的語言擴充功能開發套件支援 Postgre SQL 掛接的使用。目前，此函數支援下列功能。

函數原型

pgtle.register_feature(proc regproc, feature pg_tle_feature)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT pgtle.register_feature('pw_hook', 'passcheck');

pgtle.register_feature_if_not_exists

此pgtle.register_feature_if_not_exists函數會將指定的 Postgre SQL 特徵新增至pgtle.feature_info表格，並識別使用該功能的TLE副檔名或其他程序或函數。如需掛鉤和受信任語言延伸模組的詳細資訊，請參閱 使用後SQL掛鉤與您TLE的擴展。

函數原型

pgtle.register_feature_if_not_exists(proc regproc, feature pg_tle_feature)

角色

pgtle_admin

引數

輸出

在針對指定的延伸模組註冊功能之後傳回 true。如果此功能已註冊，則會傳回 false。

使用範例

SELECT pgtle.register_feature_if_not_exists('pw_hook', 'passcheck');

pgtle.set_default_version

此set_default_version函數可讓您default_version為TLE擴充功能指定。您可以使用此函數來定義升級路徑，並將版本指定為TLE擴充功能的預設版本。當資料庫使用者在CREATE EXTENSION和ALTER EXTENSION ... UPDATE命令中指定您的TLE擴充功能時，該版本的TLE擴充功能就會在該使用者的資料庫中建立。

成功時此函數會傳回 true。如果在name引數中指定的TLE擴展名不存在，該函數返回一個錯誤。同樣地，如果TLE擴充功能不存在，則會傳回錯誤。version

函數原型

pgtle.set_default_version(name text, version text)

角色

pgtle_admin

引數

輸出

使用範例

SELECT * FROM pgtle.set_default_version('my-extension', '1.1');

pgtle.uninstall_extension(name)

該uninstall_extension函數從數據庫中刪除TLE擴展的所有版本。此功能可防止 future 的CREATE EXTENSION呼叫安裝TLE擴充功能。如果TLE擴充功能不存在於資料庫中，就會引發錯誤。

該uninstall_extension函數不會刪除當前在數據庫中活動的TLE擴展。要刪除當前活動的TLE擴展程序，您需要明確調用DROP EXTENSION以刪除它。

函數原型

pgtle.uninstall_extension(extname text)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT * FROM pgtle.uninstall_extension('pg_tle_test');

pgtle.uninstall_extension(name, version)

該uninstall_extension(name, version)函數從數據庫中刪除TLE擴展的指定版本。此功能可防ALTER EXTENSION止CREATE EXTENSION並安裝或更新指定版本的TLE擴充功能。此函數也會移除指定TLE擴充功能版本的所有更新路徑。如果TLE擴充功能目前在資料庫中處於作用中狀態，則此功能不會解除安裝。您必須明確呼叫DROP EXTENSION以移除TLE擴充功能。若要解除安裝TLE擴充功能的所有版本，請參閱pgtle.uninstall_extension(name)。

函數原型

pgtle.uninstall_extension(extname text, version text)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT * FROM pgtle.uninstall_extension('pg_tle_test', '0.2');

pgtle.uninstall_extension_if_exists

該uninstall_extension_if_exists函數從給定的數據庫中刪除TLE擴展的所有版本。如果TLE擴展不存在，該函數返回靜默（不引發錯誤消息）。如果指定的延伸模組目前在資料庫內作用中，則此函數不會捨棄它。在使用此函數DROP EXTENSION解除安裝其成品之前，您必須明確呼叫移除TLE擴充功能。

函數原型

pgtle.uninstall_extension_if_exists(extname text)

角色

pgtle_admin

引數

輸出

在解除安裝指定的延伸模組之後，uninstall_extension_if_exists 函數會傳回 true。如果指定的延伸模組不存在，函數會傳回 false。

使用範例

SELECT * FROM pgtle.uninstall_extension_if_exists('pg_tle_test');

pgtle.uninstall_update_path

該uninstall_update_path函數從TLE擴展中刪除特定的更新路徑。這樣可以防止 ALTER EXTENSION ... UPDATE TO 將其用作更新路徑。

如果此更新路徑上的其中一個版本目前正在使用此TLE延伸功能，則該擴充功能會保留在資料庫中。

如果指定的更新路徑不存在，此函數會引發錯誤。

函數原型

pgtle.uninstall_update_path(extname text, fromvers text, tovers text)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT * FROM pgtle.uninstall_update_path('pg_tle_test', '0.1', '0.2');

pgtle.uninstall_update_path_if_exists

該uninstall_update_path_if_exists函數類似於它從TLE擴展uninstall_update_path中刪除指定的更新路徑。不過，如果更新路徑不存在，則此函數不會引發錯誤訊息。反之，此函數會傳回 false。

函數原型

pgtle.uninstall_update_path_if_exists(extname text, fromvers text, tovers text)

角色

pgtle_admin

引數

輸出

使用範例

SELECT * FROM pgtle.uninstall_update_path_if_exists('pg_tle_test', '0.1', '0.2');

pgtle.unregister_feature

unregister_feature 函數會提供一種方法，來刪除已註冊為使用 pg_tle 功能 (例如掛鉤) 的函數。如需註冊功能的相關資訊，請參閱 pgtle.register_feature。

函數原型

pgtle.unregister_feature(proc regproc, feature pg_tle_features)

角色

pgtle_admin

引數

輸出

無。

使用範例

SELECT * FROM pgtle.unregister_feature('pw_hook', 'passcheck');

pgtle.unregister_feature_if_exists

unregister_feature 函數會提供一種方法，來刪除已註冊為使用 pg_tle 功能 (例如掛鉤) 的函數。如需詳細資訊，請參閱使用後SQL掛鉤與您TLE的擴展。在成功取消註冊功能之後傳回 true。如果功能未註冊，則會傳回 false。

如需為擴充pg_tle功能註冊功能的相關資TLE訊，請參閱pgtle.register_feature。

函數原型

pgtle.unregister_feature_if_exists('proc regproc', 'feature pg_tle_features')

角色

pgtle_admin

引數

輸出

傳回 true 或 false，如下所示。

使用範例

SELECT * FROM pgtle.unregister_feature_if_exists('pw_hook', 'passcheck');