Skip to content

Commit

Permalink
Update documentation with copy_complete
Browse files Browse the repository at this point in the history
  • Loading branch information
resuna committed Mar 11, 2020
1 parent 19adde4 commit f082da9
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
2 changes: 1 addition & 1 deletion configure.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ dnl to configure the system for the local environment.
# so you can encode the package version directly into the source files.
#-----------------------------------------------------------------------

AC_INIT([pgtcl], [2.6.4])
AC_INIT([pgtcl], [2.7.1])

#-----
# Version with patch stripped
Expand Down
50 changes: 50 additions & 0 deletions doc/libpgtcl.sgml
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,11 @@ $Header$
<entry><function>pg::sqlite</function></entry>
<entry>bridge between pgtcl and the Tcl sqlite package (when compiled with sqlite bridge)</entry>
</row>
<row>
<entry><function>pg_copy_complete</function></entry>
<entry><function>pg::copy_complete</function></entry>
<entry>Complete <command>COPY FROM stdin</command> operation after finished writing</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down Expand Up @@ -4462,6 +4467,51 @@ pg_sqlite <parameter>sqlite_db</parameter> <parameter>command</parameter> <optio
</refsect1>
</refentry>

<refentry ID="PGTCL-PGCOPYCOMPLETE">
<refmeta>
<refentrytitle>pg_compy_complete</refentrytitle>
</refmeta>

<refnamediv>
<refname>pg_compy_complete</refname>
<refpurpose>Completes a <command>COPY FROM stdin</command> operation
</refpurpose>
<indexterm ID="IX-PGTCL-COPY_COMPLETE"><primary>pg_copy_complete</primary></indexterm>
</refnamediv>

<refsynopsisdiv>
<synopsis>
pg_copy_complete conn
</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>

<para>
<function>pg_copy_complete</function> completes a <command>COPY FROM stdin</command> operation. After writing the rows to the postgres connection handle, this tells postgres that the copy is completed and it can return to normal operation.
</para>
</refsect1>

<refsect1>
<title>Arguments</title>

<variablelist>

<varlistentry>
<term><parameter>conn</parameter></term>
<listitem>
<para>
An postgresql connection handle.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

</refentry>

<refentry ID="PGTCL-PGGETCONNECTIONID">
<refmeta>
<refentrytitle>PgGetConnectionId</refentrytitle>
Expand Down

0 comments on commit f082da9

Please sign in to comment.