Skip to content

[Sync EN] Document new pgsql functions added in PHP 8.4 (#5351) #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
+427 −0
Open

[Sync EN] Document new pgsql functions added in PHP 8.4 (#5351) #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions reference/pgsql/functions/pg-change-password.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 491bd06bf430a9b0d9117a7b7c2c2b02a46ef84b Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pg-change-password" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_change_password</refname>
<refpurpose>Ändert das Passwort eines PostgreSQL-Benutzers</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_change_password</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>pg_change_password</function> ändert das Passwort eines
PostgreSQL-Benutzers. Diese Funktion verwendet die libpq-Funktion
<literal>PQchangePassword</literal>, die die Verschlüsselung des
Passworts anhand der Servereinstellungen automatisch übernimmt.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&pgsql.parameter.connection;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<simpara>
Der Name des PostgreSQL-Benutzers, dessen Passwort geändert werden soll.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<simpara>
Das neue Passwort.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pg_connect</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
67 changes: 67 additions & 0 deletions reference/pgsql/functions/pg-jit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 491bd06bf430a9b0d9117a7b7c2c2b02a46ef84b Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pg-jit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_jit</refname>
<refpurpose>Gibt die JIT-Informationen des Servers zurück</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_jit</methodname>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
<function>pg_jit</function> gibt ein Array mit den JIT-Informationen
(Just-In-Time-Kompilierung) des PostgreSQL-Servers zurück.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&pgsql.parameter.connection-with-nullable-default;
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt ein &array; mit den JIT-Informationen des Servers zurück.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pg_version</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
84 changes: 84 additions & 0 deletions reference/pgsql/functions/pg-put-copy-data.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 491bd06bf430a9b0d9117a7b7c2c2b02a46ef84b Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pg-put-copy-data" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_put_copy_data</refname>
<refpurpose>Sendet während einer COPY-Operation Daten an den Server</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_put_copy_data</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>cmd</parameter></methodparam>
</methodsynopsis>
<simpara>
Sendet während einer <literal>COPY FROM STDIN</literal>-Operation Daten
an den Server. Vor dem Aufruf dieser Funktion muss über
<function>pg_query</function> ein <literal>COPY</literal>-Befehl
abgesetzt worden sein.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&pgsql.parameter.connection;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cmd</parameter></term>
<listitem>
<simpara>
Die an den Server zu sendenden Daten. Ein abschließender
Zeilenumbruch wird automatisch hinzugefügt, falls er nicht
vorhanden ist. Die Daten müssen gemäß dem Format des
<literal>COPY</literal>-Befehls formatiert sein.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt bei Erfolg <literal>1</literal> zurück, <literal>0</literal>, wenn
die Daten nicht in die Warteschlange aufgenommen werden konnten (nur im
nicht-blockierenden Modus), oder <literal>-1</literal> bei einem Fehler.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pg_put_copy_end</function></member>
<member><function>pg_query</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
81 changes: 81 additions & 0 deletions reference/pgsql/functions/pg-put-copy-end.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 491bd06bf430a9b0d9117a7b7c2c2b02a46ef84b Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pg-put-copy-end" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_put_copy_end</refname>
<refpurpose>Signalisiert dem Server den Abschluss einer COPY-Operation</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_put_copy_end</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>error</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Sendet während einer <literal>COPY FROM STDIN</literal>-Operation eine
Anzeige über das Ende der Daten an den Server.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&pgsql.parameter.connection;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error</parameter></term>
<listitem>
<simpara>
Ist dieser Parameter nicht &null;, so wird die
<literal>COPY</literal>-Operation mit der angegebenen
Fehlermeldung zum Scheitern gezwungen.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt bei Erfolg <literal>1</literal> zurück, <literal>0</literal>, wenn
die Daten nicht in die Warteschlange aufgenommen werden konnten (nur im
nicht-blockierenden Modus), oder <literal>-1</literal> bei einem Fehler.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pg_put_copy_data</function></member>
<member><function>pg_query</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading
Loading