Skip to content

P
Postgres FD Implementation
Commit 165b830e authored by Thomas G. Lockhart's avatar Thomas G. Lockhart
Browse files
Options

Add reference pages on user interface applications.

parent 32cfa65e
Show whitespace changes
Inline Side-by-side
Showing with 2197 additions and 1961 deletions
doc/src/sgml/ref/allfiles.sgml
View file @ 165b830e
......@@ -62,7 +62,7 @@
<!entity close system "close.sgml">
<!entity cluster system "cluster.sgml">
<!entity commit system "commit.sgml">
<!entity copy system "copy.sgml">
<!entity copyTable system "copy.sgml">
<!entity createAggregate system "create_aggregate.sgml">
<!entity createDatabase system "create_database.sgml">
<!entity createFunction system "create_function.sgml">
......@@ -117,6 +117,8 @@
<!entity destroyuser system "destroyuser.sgml">
<!entity initdb system "initdb.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 pgDumpall system "pg_dumpall.sgml">
<!entity pgUpgrade system "pg_upgrade.sgml">
......
doc/src/sgml/ref/commands.sgml
View file @ 165b830e
<chapter id="sql-commands">
<Title>SQL Commands</Title>
<chapter id="sql-commands">
<Title>SQL Commands</Title>
<Para>
This is reference information for the <acronym>SQL</acronym>
commands supported by <productname>Postgres</productname>.
</Para>
<abstract>
<Para>
This is reference information for the <acronym>SQL</acronym>
commands supported by <productname>Postgres</productname>.
</Para>
</abstract>
&abort;
&alterTable;
&alterUser;
&begin;
&close;
&cluster;
&commit;
&copy;
&createAggregate;
&createDatabase;
&createFunction;
&createIndex;
&createLanguage;
&createOperator;
&createRule;
&createSequence;
&createTable;
&createTrigger;
&createType;
&createUser;
&createView;
&declare;
&delete;
&dropAggregate;
&dropDatabase;
&dropFunction;
&dropIndex;
&dropLanguage;
&dropOperator;
&dropRule;
&dropSequence;
&dropTable;
&dropTrigger;
&dropType
&dropUser;
&dropView;
&explain;
&fetch;
&grant;
&insert;
&listen;
&load;
&lock;
&move;
&notify;
&reset;
&revoke;
&rollback;
&select;
&set;
&show;
&unlisten;
&update;
&vacuum;
&abort;
&alterTable;
&alterUser;
&begin;
&close;
&cluster;
&commit;
&copyTable;
&createAggregate;
&createDatabase;
&createFunction;
&createIndex;
&createLanguage;
&createOperator;
&createRule;
&createSequence;
&createTable;
&createTrigger;
&createType;
&createUser;
&createView;
&declare;
&delete;
&dropAggregate;
&dropDatabase;
&dropFunction;
&dropIndex;
&dropLanguage;
&dropOperator;
&dropRule;
&dropSequence;
&dropTable;
&dropTrigger;
&dropType
&dropUser;
&dropView;
&explain;
&fetch;
&grant;
&insert;
&listen;
&load;
&lock;
&move;
&notify;
&reset;
&revoke;
&rollback;
&select;
&set;
&show;
&unlisten;
&update;
&vacuum;
</Chapter>
</Chapter>
<!--
Disable this chapter until we have more functions documented.
......@@ -84,31 +86,35 @@ functions supported by <productname>Postgres</productname>.
-->
<chapter Id="utilities">
<title>Utility Applications</title>
<chapter Id="utilities">
<title>Utility Applications</title>
<para>
This is reference information for the
<productname>Postgres</productname> support utilities.
</para>
<abstract>
<para>
This is reference information for the
<productname>Postgres</productname> support utilities.
</para>
</abstract>
&createdb;
&createuser;
&destroydb;
&destroyuser;
&initdb;
&initlocation;
&pgDump;
&pgDumpall;
&psqlRef;
&vacuumdb;
&createdb;
&createuser;
&destroydb;
&destroyuser;
&initdb;
&initlocation;
&pgAccess;
&pgAdmin;
&pgDump;
&pgDumpall;
&psqlRef;
&vacuumdb;
</chapter>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
......
doc/src/sgml/ref/lock.sgml
View file @ 165b830e
<REFENTRY ID="SQL-LOCK">
<REFMETA>
<REFENTRYTITLE>
LOCK
</REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
LOCK
</REFNAME>
<REFPURPOSE>
Explicit lock of a table inside a transaction
</REFPURPOSE>
<REFMETA>
<REFENTRYTITLE>
LOCK
</REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
LOCK
</REFNAME>
<REFPURPOSE>
Explicit lock of a table inside a transaction
</REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</SYNOPSIS>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</SYNOPSIS>
<REFSECT2 ID="R2-SQL-LOCK-1">
<REFSECT2INFO>
......@@ -188,3 +188,20 @@ LOCK [ TABLE ] <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
</refsect2>
</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:
-->
doc/src/sgml/ref/pgaccess-ref.sgml 0 → 100644
View file @ 165b830e
<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:
-->
doc/src/sgml/ref/pgadmin-ref.sgml 0 → 100644
View file @ 165b830e
<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:
-->
doc/src/sgml/ref/psql-ref.sgml
View file @ 165b830e
<REFENTRY ID="APP-PSQL">
<REFMETA>
<REFENTRYTITLE id="psql-ref">
<application>psql</application>
</REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
<application>psql</application>
</REFNAME>
<REFPURPOSE>
<productname>Postgres</productname> interactive client
</REFPURPOSE>
<REFMETA>
<REFENTRYTITLE id="psql-ref">
<application>psql</application>
</REFENTRYTITLE>
<REFMISCINFO>Application</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
<application>psql</application>
</REFNAME>
<REFPURPOSE>
<productname>Postgres</productname> interactive client
</REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-26</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-26</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
psql [ <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
[ -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">
<REFSECT2INFO>
......@@ -50,7 +50,6 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
<envar>USER</envar>
environment variable or, if that's not set, to the Unix account name of the
current user.
</PARA>
</LISTITEM>
</VARLISTENTRY>
......@@ -170,7 +169,6 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
Outputs
</TITLE>
<PARA>
<application>psql</application>
returns 0 to the shell on successful completion of all queries,
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 "=>".
For example,
<programlisting>
$ <userinput>psql testdb</userinput>
Welcome to the POSTGRESQL interactive sql monitor:
$ <userinput>psql testdb</userinput>
Welcome to the POSTGRESQL interactive sql monitor:
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 \eq to quit
type \eg or terminate with semicolon to execute query
type \? for help on slash commands
type \q to quit
type \g or terminate with semicolon to execute query
You are currently connected to the database: testdb
testdb=>
testdb=>
</programlisting>
</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.
</para>
</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 ID="R1-APP-PSQL-2">
......@@ -1061,3 +1092,20 @@ psql -A [ -c <replaceable class="parameter">query</replaceable> ] [ -d <replacea
</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:
-->
doc/src/sgml/ref/set.sgml
View file @ 165b830e
<REFENTRY ID="SQL-SET">
<REFMETA>
<REFENTRYTITLE>
SET
</REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
SET
</REFNAME>
<REFPURPOSE>
<REFMETA>
<REFENTRYTITLE>
SET
</REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
SET
</REFNAME>
<REFPURPOSE>
Set run-time parameters for session
</REFPURPOSE>
</REFPURPOSE>
</refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
<REPLACEABLE CLASS="PARAMETER">
</REPLACEABLE>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
SET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> { TO | = } { '<REPLACEABLE CLASS="PARAMETER">value</REPLACEABLE>' | DEFAULT }
SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL };
</SYNOPSIS>
</SYNOPSIS>
<REFSECT2 ID="R2-SQL-SET-1">
<REFSECT2INFO>
......@@ -174,15 +172,15 @@ SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL
</para>
<para>
The variables in <filename>globals.c</filename> which can be changed are:
<programlisting>
bool EuroDates = false
true
int DateStyle = USE_ISO_DATES
USE_POSTGRES_DATES
USE_ISO_DATES
USE_SQL_DATES
USE_GERMAN_DATES
</programlisting>
<simplelist>
<member>
bool EuroDates = false | true
</member>
<member>
int DateStyle = USE_ISO_DATES | USE_POSTGRES_DATES | USE_SQL_DATES | USE_GERMAN_DATES
</member>
</simplelist>
</para>
<para>
<variablelist>
......@@ -687,3 +685,20 @@ SET TIME ZONE { '<REPLACEABLE CLASS="PARAMETER">timezone</REPLACEABLE>' | LOCAL
</refsect2>
</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:
-->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment