sharpetronics/PostgreSQL
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-21 00:02:53 -04:00
Code Issues Projects Releases Wiki Activity

Add reference pages on user interface applications.

Browse Source
This commit is contained in:
Thomas G. Lockhart 1999-05-20 05:40:27 +00:00
parent 32cfa65e49
commit 165b830ea5
7 changed files with 2185 additions and 1949 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/ref/allfiles.sgml
View File

@ -62,7 +62,7 @@
<!entity close system "close.sgml"> <!entity close system "close.sgml">
<!entity cluster system "cluster.sgml"> <!entity cluster system "cluster.sgml">
<!entity commit system "commit.sgml"> <!entity commit system "commit.sgml">
<!entity copy system "copy.sgml"> <!entity copyTable system "copy.sgml">
<!entity createAggregate system "create_aggregate.sgml"> <!entity createAggregate system "create_aggregate.sgml">
<!entity createDatabase system "create_database.sgml"> <!entity createDatabase system "create_database.sgml">
<!entity createFunction system "create_function.sgml"> <!entity createFunction system "create_function.sgml">
@ -117,6 +117,8 @@
<!entity destroyuser system "destroyuser.sgml"> <!entity destroyuser system "destroyuser.sgml">
<!entity initdb system "initdb.sgml"> <!entity initdb system "initdb.sgml">
<!entity initlocation system "initlocation.sgml"> <!entity initlocation system "initlocation.sgml">
<!entity pgAccess system "pgaccess-ref.sgml">
<!entity pgAdmin system "pgadmin-ref.sgml">
<!entity pgDump system "pg_dump.sgml"> <!entity pgDump system "pg_dump.sgml">
<!entity pgDumpall system "pg_dumpall.sgml"> <!entity pgDumpall system "pg_dumpall.sgml">
<!entity pgUpgrade system "pg_upgrade.sgml"> <!entity pgUpgrade system "pg_upgrade.sgml">

164
doc/src/sgml/ref/commands.sgml
View File

@ -1,67 +1,69 @@
<chapter id="sql-commands"> <chapter id="sql-commands">
<Title>SQL Commands</Title> <Title>SQL Commands</Title>
<Para> <abstract>
This is reference information for the <acronym>SQL</acronym> <Para>
commands supported by <productname>Postgres</productname>. This is reference information for the <acronym>SQL</acronym>
</Para> commands supported by <productname>Postgres</productname>.
</Para>
</abstract>
&abort; &abort;
&alterTable; &alterTable;
&alterUser; &alterUser;
&begin; &begin;
&close; &close;
&cluster; &cluster;
&commit; &commit;
&copy; &copyTable;
&createAggregate; &createAggregate;
&createDatabase; &createDatabase;
&createFunction; &createFunction;
&createIndex; &createIndex;
&createLanguage; &createLanguage;
&createOperator; &createOperator;
&createRule; &createRule;
&createSequence; &createSequence;
&createTable; &createTable;
&createTrigger; &createTrigger;
&createType; &createType;
&createUser; &createUser;
&createView; &createView;
&declare; &declare;
&delete; &delete;
&dropAggregate; &dropAggregate;
&dropDatabase; &dropDatabase;
&dropFunction; &dropFunction;
&dropIndex; &dropIndex;
&dropLanguage; &dropLanguage;
&dropOperator; &dropOperator;
&dropRule; &dropRule;
&dropSequence; &dropSequence;
&dropTable; &dropTable;
&dropTrigger; &dropTrigger;
&dropType &dropType
&dropUser; &dropUser;
&dropView; &dropView;
&explain; &explain;
&fetch; &fetch;
&grant; &grant;
&insert; &insert;
&listen; &listen;
&load; &load;
&lock; &lock;
&move; &move;
&notify; &notify;
&reset; &reset;
&revoke; &revoke;
&rollback; &rollback;
&select; &select;
&set; &set;
&show; &show;
&unlisten; &unlisten;
&update; &update;
&vacuum; &vacuum;
</Chapter> </Chapter>
<!-- <!--
Disable this chapter until we have more functions documented. Disable this chapter until we have more functions documented.
@ -84,31 +86,35 @@ functions supported by <productname>Postgres</productname>.
--> -->
<chapter Id="utilities"> <chapter Id="utilities">
<title>Utility Applications</title> <title>Utility Applications</title>
<para> <abstract>
This is reference information for the <para>
<productname>Postgres</productname> support utilities. This is reference information for the
</para> <productname>Postgres</productname> support utilities.
</para>
</abstract>
&createdb; &createdb;
&createuser; &createuser;
&destroydb; &destroydb;
&destroyuser; &destroyuser;
&initdb; &initdb;
&initlocation; &initlocation;
&pgDump; &pgAccess;
&pgDumpall; &pgAdmin;
&psqlRef; &pgDump;
&vacuumdb; &pgDumpall;
&psqlRef;
&vacuumdb;
</chapter> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
sgml-omittag:t sgml-omittag:nil
sgml-shorttag:t sgml-shorttag:t
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-always-quote-attributes:t sgml-always-quote-attributes:t

57
doc/src/sgml/ref/lock.sgml
View File

@ -1,25 +1,25 @@
<REFENTRY ID="SQL-LOCK"> <REFENTRY ID="SQL-LOCK">
<REFMETA> <REFMETA>
<REFENTRYTITLE> <REFENTRYTITLE>
LOCK LOCK
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO> <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
LOCK LOCK
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Explicit lock of a table inside a transaction Explicit lock of a table inside a transaction
</REFPURPOSE> </REFPURPOSE>
</refnamediv> </refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-LOCK-1"> <REFSECT2 ID="R2-SQL-LOCK-1">
<REFSECT2INFO> <REFSECT2INFO>
@ -188,3 +188,20 @@ LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</refsect2> </refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->

74
doc/src/sgml/ref/pgaccess-ref.sgml Normal file
View File

@ -0,0 +1,74 @@
<REFENTRY ID="APP-PGACCESS">
<REFMETA>
<REFENTRYTITLE id="pgaccess-ref">
<application>pgaccess</application>
</REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
<application>pgaccess</application>
</REFNAME>
<REFPURPOSE>
<productname>Postgres</productname> graphical interactive client
</REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1999-05-19</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
pgaccess [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS>
<REFSECT2 ID="R2-APP-PGACCESS-1">
<REFSECT2INFO>
<DATE>1999-05-19</DATE>
</REFSECT2INFO>
<TITLE>
Inputs
</TITLE>
<PARA>
</para>
</refsect2>
<REFSECT2 ID="R2-APP-PGACCESS-2">
<REFSECT2INFO>
<DATE>1999-05-19</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
</para>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-PGACCESS-1">
<REFSECT1INFO>
<DATE>1999-05-19</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->

74
doc/src/sgml/ref/pgadmin-ref.sgml Normal file
View File

@ -0,0 +1,74 @@
<REFENTRY ID="APP-PGADMIN">
<REFMETA>
<REFENTRYTITLE id="pgadmin-ref">
<application>pgadmin</application>
</REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
<application>pgadmin</application>
</REFNAME>
<REFPURPOSE>
<productname>Postgres</productname> graphical interactive client
</REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1999-05-19</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
pgadmin [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS>
<REFSECT2 ID="R2-APP-PGADMIN-1">
<REFSECT2INFO>
<DATE>1999-05-19</DATE>
</REFSECT2INFO>
<TITLE>
Inputs
</TITLE>
<PARA>
</para>
</refsect2>
<REFSECT2 ID="R2-APP-PGADMIN-2">
<REFSECT2INFO>
<DATE>1999-05-19</DATE>
</REFSECT2INFO>
<TITLE>
Outputs
</TITLE>
<PARA>
</para>
</refsect2>
</refsynopsisdiv>
<REFSECT1 ID="R1-APP-PGADMIN-1">
<REFSECT1INFO>
<DATE>1999-05-19</DATE>
</REFSECT1INFO>
<TITLE>
Description
</TITLE>
<PARA>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->

102
doc/src/sgml/ref/psql-ref.sgml
View File

@ -1,28 +1,28 @@
<REFENTRY ID="APP-PSQL"> <REFENTRY ID="APP-PSQL">
<REFMETA> <REFMETA>
<REFENTRYTITLE id="psql-ref"> <REFENTRYTITLE id="psql-ref">
<application>psql</application> <application>psql</application>
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO> <REFMISCINFO>Application</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
<application>psql</application> <application>psql</application>
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
<productname>Postgres</productname> interactive client <productname>Postgres</productname> interactive client
</REFPURPOSE> </REFPURPOSE>
</refnamediv> </refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-26</DATE> <DATE>1998-09-26</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
psql [ <replaceable class="parameter">dbname</replaceable> ] psql [ <replaceable class="parameter">dbname</replaceable> ]
psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replaceable class="parameter">dbname</replaceable> ] psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replaceable class="parameter">dbname</replaceable> ]
-e -E [ -f <replaceable class="parameter">filename</replaceable> ] [ -F <replaceable class="parameter">separator</replaceable> ] [ -h <replaceable class="parameter">hostname</replaceable> ] -Hln -e -E [ -f <replaceable class="parameter">filename</replaceable> ] [ -F <replaceable class="parameter">separator</replaceable> ] [ -h <replaceable class="parameter">hostname</replaceable> ] -Hln
[ -o <replaceable class="parameter">filename</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] -qsSt ] [ -T <replaceable class="parameter">table_options</replaceable> ] -ux [ <replaceable class="parameter">dbname</replaceable> ] [ -o <replaceable class="parameter">filename</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] -qsSt ] [ -T <replaceable class="parameter">table_options</replaceable> ] -ux [ <replaceable class="parameter">dbname</replaceable> ]
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-APP-PSQL-1"> <REFSECT2 ID="R2-APP-PSQL-1">
<REFSECT2INFO> <REFSECT2INFO>
@ -50,7 +50,6 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
<envar>USER</envar> <envar>USER</envar>
environment variable or, if that's not set, to the Unix account name of the environment variable or, if that's not set, to the Unix account name of the
current user. current user.
</PARA> </PARA>
</LISTITEM> </LISTITEM>
</VARLISTENTRY> </VARLISTENTRY>
@ -170,7 +169,6 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
Outputs Outputs
</TITLE> </TITLE>
<PARA> <PARA>
<application>psql</application> <application>psql</application>
returns 0 to the shell on successful completion of all queries, returns 0 to the shell on successful completion of all queries,
1 for errors, 2 for abrupt disconnection from the backend. 1 for errors, 2 for abrupt disconnection from the backend.
@ -258,16 +256,17 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
followed by the string "=>". followed by the string "=>".
For example, For example,
<programlisting> <programlisting>
$ <userinput>psql testdb</userinput> $ <userinput>psql testdb</userinput>
Welcome to the POSTGRESQL interactive sql monitor: Welcome to the POSTGRESQL interactive sql monitor:
Please read the file COPYRIGHT for copyright terms of POSTGRESQL Please read the file COPYRIGHT for copyright terms of POSTGRESQL
[PostgreSQL 6.5.0 on i686-pc-linux-gnu, compiled by gcc 2.7.2.3]
type \e? for help on slash commands type \? for help on slash commands
type \eq to quit type \q to quit
type \eg or terminate with semicolon to execute query type \g or terminate with semicolon to execute query
You are currently connected to the database: testdb You are currently connected to the database: testdb
testdb=> testdb=>
</programlisting> </programlisting>
</para> </para>
<para> <para>
@ -287,6 +286,38 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
is not listening or talking to a real tty. is not listening or talking to a real tty.
</para> </para>
</refsect2> </refsect2>
<refsect2 id="R2-APP-PSQL-5">
<Title>Paging To Screen</Title>
<Note>
<Title>Author</Title>
<Para>
From Brett McCormick on the mailing list 1998-04-04.
</Para>
</Note>
<Para>
To affect the paging behavior of your <Command>psql</Command> output,
set or unset your PAGER environment variable. I always have to set mine
before it will pause. And of course you have to do this before
starting the program.
</para>
<Para>
In csh/tcsh or other C shells:
<ProgramListing>
% unsetenv PAGER
</ProgramListing>
while in sh/bash or other Bourne shells:
<ProgramListing>
% unset PAGER
</ProgramListing>
</para>
</refsect2>
</refsect1> </refsect1>
<REFSECT1 ID="R1-APP-PSQL-2"> <REFSECT1 ID="R1-APP-PSQL-2">
@ -1061,3 +1092,20 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
</para> </para>
</refsect1> </refsect1>
</refentry> </refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->

73
doc/src/sgml/ref/set.sgml
View File

@ -1,28 +1,26 @@
<REFENTRY ID="SQL-SET"> <REFENTRY ID="SQL-SET">
<REFMETA> <REFMETA>
<REFENTRYTITLE> <REFENTRYTITLE>
SET SET
</REFENTRYTITLE> </REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO> <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA> </REFMETA>
<REFNAMEDIV> <REFNAMEDIV>
<REFNAME> <REFNAME>
SET SET
</REFNAME> </REFNAME>
<REFPURPOSE> <REFPURPOSE>
Set run-time parameters for session Set run-time parameters for session
</REFPURPOSE> </REFPURPOSE>
</refnamediv> </refnamediv>
<REFSYNOPSISDIV> <REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO> <REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE> <DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO> </REFSYNOPSISDIVINFO>
<SYNOPSIS> <SYNOPSIS>
<REPLACEABLE CLASS="PARAMETER">
</REPLACEABLE>
SET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> { TO | = } { '<REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>' | DEFAULT } SET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> { TO | = } { '<REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>' | DEFAULT }
SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL }; SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL };
</SYNOPSIS> </SYNOPSIS>
<REFSECT2 ID="R2-SQL-SET-1"> <REFSECT2 ID="R2-SQL-SET-1">
<REFSECT2INFO> <REFSECT2INFO>
@ -174,15 +172,15 @@ SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL
</para> </para>
<para> <para>
The variables in <filename>globals.c</filename> which can be changed are: The variables in <filename>globals.c</filename> which can be changed are:
<programlisting> <simplelist>
bool EuroDates = false <member>
true bool EuroDates = false | true
int DateStyle = USE_ISO_DATES </member>
USE_POSTGRES_DATES <member>
USE_ISO_DATES int DateStyle = USE_ISO_DATES | USE_POSTGRES_DATES | USE_SQL_DATES | USE_GERMAN_DATES
USE_SQL_DATES </member>
USE_GERMAN_DATES </simplelist>
</programlisting>
</para> </para>
<para> <para>
<variablelist> <variablelist>
@ -687,3 +685,20 @@ SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL
</refsect2> </refsect2>
</refsect1> </refsect1>
</REFENTRY> </REFENTRY>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG"
sgml-local-ecat-files:nil
End:
-->