Referencia de funciones para Extensiones de lenguaje de confianza para PostgreSQL

Consulte la siguiente documentación de referencia sobre las funciones disponibles en Extensiones de lengua de confianza para PostgreSQL. Utilice estas funciones para instalar, registrar, actualizar y administrar sus extensiones TLE, es decir, las extensiones de PostgreSQL que desarrolla con el kit de desarrollo de Extensiones de lenguaje de confianza.

pgtle.available_extensions

La función pgtle.available_extensions es una función de devolución de conjuntos. Devuelve todas las extensiones TLE disponibles en la base de datos. Cada fila devuelta contiene información sobre una sola extensión TLE.

Prototipo de función

pgtle.available_extensions()

Rol

Ninguna.

Argumentos

Ninguna.

Salida

Ejemplo de uso

SELECT * FROM pgtle.available_extensions();

pgtle.available_extension_versions

La función available_extension_versions es una función de devolución de conjuntos. Esta función devuelve una lista de todas las extensiones de TLE disponibles y sus versiones. Cada fila contiene información sobre una versión específica de la extensión TLE dada, incluso si requiere un rol específico.

Prototipo de función

pgtle.available_extension_versions()

Rol

Ninguna.

Argumentos

Ninguna.

Salida

Para obtener más información acerca de los valores de salida, vea Packaging Related Objects into an Extension > Extension Files (Empaquetar objetos relacionados en una extensión > Archivos de extensión) en la documentación de PostgreSQL.

Ejemplo de uso

SELECT * FROM pgtle.available_extension_versions();

pgtle.extension_update_paths

La función extension_update_paths es una función de devolución de conjuntos. Devuelve una lista de todas las rutas de actualización posibles para una extensión TLE. Cada fila incluye las actualizaciones a un nivel superior o inferior disponibles para esa extensión TLE.

Prototipo de función

pgtle.extension_update_paths(name)

Rol

Ninguna.

Argumentos

name: nombre de la extensión TLE desde la que se obtienen las rutas de actualización.

Salida

Ejemplo de uso

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

pgtle.install_extension

La función install_extension le permite instalar los artefactos que componen la extensión TLE en la base de datos, después de lo cual se puede crear mediante el comando CREATE EXTENSION.

Prototipo de función

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

Rol

Ninguna.

Argumentos

Muchos de estos argumentos son los mismos que se incluyen en un archivo de control de extensiones para instalar una extensión de PostgreSQL en el sistema de archivos de una instancia de PostgreSQL. Para obtener más información acerca de las extensiones de PostgreSQL, vea Extension Files (Archivos de extensión) en Packaging Related Objects into an Extension (Empaquetar objetos relacionados en una extensión) en la documentación de PostgreSQL.

Salida

Esta función devuelve OK en caso de éxito y NULL en caso de error.

Ejemplo de uso

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

La función install_update_path proporciona una ruta de actualización entre dos versiones diferentes de una extensión TLE. Esta función permite a los usuarios de la extensión TLE actualizar su versión mediante la sintaxis ALTER EXTENSION ... UPDATE.

Prototipo de función

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

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

La función register_feature añade la característica interna de PostgreSQL especificada a la tabla pgtle.feature_info. Los enlaces de PostgreSQL son un ejemplo de una característica interna de PostgreSQL. El kit de desarrollo de Extensiones de lenguaje de confianza admite el uso de enlaces de PostgreSQL. Actualmente, esta función admite la siguiente característica.

Prototipo de función

pgtle.register_feature(proc regproc, feature pg_tle_feature)

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

pgtle.register_feature_if_not_exists

La función pgtle.register_feature_if_not_exists añade la función de PostgreSQL especificada a la tabla pgtle.feature_info e identifica la extensión TLE u otro procedimiento o función que utilice la característica. Para obtener más información sobre los enlaces y las extensiones de lenguaje de confianza, consulteUso de enlaces de PostgreSQL con sus extensiones TLE.

Prototipo de función

pgtle.register_feature_if_not_exists(proc regproc, feature pg_tle_feature)

Rol

pgtle_admin

Argumentos

Salida

Devuelve true después de registrar la característica para la extensión especificada. Devuelve false si la característica ya está registrada.

Ejemplo de uso

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

pgtle.set_default_version

La función set_default_version le permite especificar un default_version para su extensión TLE. Puede utilizar esta función para definir una ruta de actualización y designar la versión como la predeterminada para la extensión TLE. Cuando los usuarios de la base de datos especifican la extensión TLE en los comandos CREATE EXTENSION y ALTER EXTENSION ... UPDATE, esa versión de la extensión TLE se crea en la base de datos para ese usuario.

Esta función devuelve true en caso de realizarse correctamente. Si la extensión TLE especificada en el argumento name no existe, la función devuelve un error. Del mismo modo, si el version de la extensión TLE no existe, devuelve un error.

Prototipo de función

pgtle.set_default_version(name text, version text)

Rol

pgtle_admin

Argumentos

Salida

Ejemplo de uso

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

pgtle.uninstall_extension(name)

La función uninstall_extension elimina todas las versiones de una extensión TLE de una base de datos. Esta función evita futuras llamadas de CREATE EXTENSION para evitar instalar la extensión TLE. Si la extensión TLE no existe en la base de datos, se genera un error.

La función uninstall_extension no elimina una extensión TLE que esté activa actualmente en la base de datos. Para eliminar una extensión TLE que está activa actualmente, debes llamar explícitamente a DROP EXTENSION para eliminarla.

Prototipo de función

pgtle.uninstall_extension(extname text)

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

pgtle.uninstall_extension(nombre, versión)

La función uninstall_extension(name, version) elimina la versión especificada de la extensión TLE de la base de datos. Esta función impide a CREATE EXTENSION y ALTER EXTENSION instalar o actualizar una extensión TLE a la versión especificada. Esta función también elimina todas las rutas de actualización posibles de la extensión TLE especificada. Esta función no desinstala la extensión TLE si actualmente está activa en la base de datos. Debe llamar explícitamente a DROP EXTENSION para eliminar la extensión TLE. Para desinstalar todas las versiones de una extensión TLE, consulte pgtle.uninstall_extension(name).

Prototipo de función

pgtle.uninstall_extension(extname text, version text)

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

pgtle.uninstall_extension_if_exists

La función uninstall_extension_if_exists elimina todas las versiones de una extensión TLE de una base de datos determinada. Si la extensión TLE no existe, la función la devuelve en silencio (no se genera ningún mensaje de error). Si la extensión especificada está activa actualmente en una base de datos, esta función no la elimina. Debe llamar explícitamente a DROP EXTENSION para eliminar la extensión TLE antes de utilizar esta función para desinstalar sus artefactos.

Prototipo de función

pgtle.uninstall_extension_if_exists(extname text)

Rol

pgtle_admin

Argumentos

Salida

La función uninstall_extension_if_exists de vuelve true después de desinstalar la extensión especificada. Si la extensión especificada no existe, la función devuelve false.

Ejemplo de uso

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

pgtle.uninstall_update_path

La función uninstall_update_path elimina la ruta de actualización específica de una extensión TLE. Esto impide que ALTER EXTENSION ... UPDATE TO se utilice como ruta de actualización.

Si una de las versiones de esta ruta de actualización utiliza actualmente la extensión TLE, permanecerá en la base de datos.

Si la ruta de actualización especificada no existe, esta función genera un error.

Prototipo de función

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

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

pgtle.uninstall_update_path_if_exists

La función uninstall_update_path_if_exists es similar a uninstall_update_path en el sentido de que elimina la ruta de actualización especificada de una extensión TLE. Sin embargo, si la ruta de actualización no existe, esta función no generará ningún mensaje de error. En su lugar, la función devuelve false.

Prototipo de función

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

Rol

pgtle_admin

Argumentos

Salida

Ejemplo de uso

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

pgtle.unregister_feature

La función unregister_feature proporciona una forma de eliminar las funciones que se han registrado para usar características pg_tle, como los enlaces. Para obtener información sobre el registro de una característica, consulte pgtle.register_feature.

Prototipo de función

pgtle.unregister_feature(proc regproc, feature pg_tle_features)

Rol

pgtle_admin

Argumentos

Salida

Ninguna.

Ejemplo de uso

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

pgtle.unregister_feature_if_exists

La función unregister_feature proporciona una forma de eliminar las funciones que se registraron para usar funciones pg_tle, como los enlaces. Para obtener más información, consulte Uso de enlaces de PostgreSQL con sus extensiones TLE. Devuelve true después de anular satisfactoriamente el registro de la función. Devuelve false si la función no se ha registrado.

Para obtener información sobre el registro de funciones pg_tle para sus extensiones TLE, consulte pgtle.register_feature.

Prototipo de función

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

Rol

pgtle_admin

Argumentos

Salida

Devuelve true o false, de la siguiente manera.

Ejemplo de uso

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