pgtle.install_extension

Mit dieser install_extension-Funktion können Sie die Artefakte, aus denen Ihre TLE-Erweiterung besteht, in der Datenbank installieren. Anschließend können sie mit dem CREATE EXTENSION-Befehl erstellt werden.

Funktionsprototyp

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

Rolle

Keine.

Argumente

• name – Der Name der TLE-Erweiterung. Dieser Wert wird beim Aufrufen von CREATE EXTENSION verwendet.

• version – Die Version der TLE-Erweiterung.

• description – Eine ausführliche Beschreibung der TLE-Erweiterung. Diese Beschreibung wird im Feld comment in pgtle.available_extensions() angezeigt.

• ext – Der Inhalt der TLE-Erweiterung. Dieser Wert enthält Objekte wie Funktionen.

• requires – Ein optionaler Parameter, der Abhängigkeiten für diese TLE-Erweiterung angibt. Die pg_tle-Erweiterung wird automatisch als Abhängigkeit hinzugefügt.

Viele dieser Argumente entsprechen denen, die in einer Erweiterungskontrolldatei für die Installation einer PostgreSQL-Erweiterung im Dateisystem einer PostgreSQL-Instance enthalten sind. Weitere Informationen finden Sie unter Extension Files in Packaging Related Objects in a Extension in der PostgreSQL-Dokumentation.

Ausgabe

Diese Funktion gibt bei Erfolg OK und bei Fehler NULL zurück.

• OK – Die TLE-Erweiterung wurde erfolgreich in der Datenbank installiert.

• NULL – Die TLE-Erweiterung wurde nicht erfolgreich in der Datenbank installiert.

Verwendungsbeispiel

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