<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgaccess-ref.sgml,v 1.11 2001/09/03 12:57:50 petere Exp $
Postgres documentation
-->

<refentry id="APP-PGACCESS">
 <docinfo>
  <date>2000-12-30</date>
 </docinfo>

 <refmeta>
  <refentrytitle id="app-pgaccess-title"><application>pgaccess</application></refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>pgaccess</refname>
  <refpurpose>a graphical <productname>PostgreSQL</productname> client application</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>pgaccess</command>
   <arg><replaceable>dbname</replaceable></arg>
  </cmdsynopsis>

  <refsect2 id="app-pgaccess-options">
   <title>Options</title>

   <variablelist>
    <varlistentry>
     <term><replaceable>dbname</replaceable></term>
     <listitem>
      <para>
	The name of an existing database to access.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>

 </refsynopsisdiv>

 <refsect1 id="R1-APP-PGACCESS-1">
  <title>
   Description
  </title>
  <para>
   <application>pgaccess</application> provides a graphical interface
   for <productname>Postgres</productname>
   wherein you
   can manage your tables, edit them, define queries, sequences and
   functions.
  </para>

  <para>
   <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Open any database on a specified host at the specified port,
      username, and password.
     </para>
    </listitem>

    <listitem>
     <para>
      Execute <xref linkend="sql-vacuum" endterm="sql-vacuum-title">.
     </para>
    </listitem>

    <listitem>
     <para>
      Save preferences in the <filename>~/.pgaccessrc</filename> file.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For tables, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Open multiple tables for viewing, with a configurable number of rows shown.
     </para>
    </listitem>

    <listitem>
     <para>
      Resize columns by dragging the vertical grid lines.
     </para>
    </listitem>

    <listitem>
     <para>
      Wrap text in cells.
     </para>
    </listitem>

    <listitem>
     <para>
      Dynamically adjust row height when editing.
     </para>
    </listitem>

    <listitem>
     <para>
      Save table layout for every table.
     </para>
    </listitem>

    <listitem>
     <para>
      Import/export to external files (<acronym>SDF</acronym>, <acronym>CSV</acronym>).
     </para>
    </listitem>

    <listitem>
     <para>
      Use filter capabilities; enter filters like <literal>price &gt; 3.14</literal>.
     </para>
    </listitem>

    <listitem>
     <para>
      Specify sort order; enter manually the sort field(s).
     </para>
    </listitem>

    <listitem>
     <para>
      Edit in place; double click the text you want to change.
     </para>
    </listitem>

    <listitem>
     <para>
      Delete records; point to the record, press <keycap>Delete</keycap> key.
     </para>
    </listitem>

    <listitem>
     <para>
      Add new records; save new row with right-button click.
     </para>
    </listitem>

    <listitem>
     <para>
      Create tables with an assistant.
     </para>
    </listitem>

    <listitem>
     <para>
      Rename and delete (drop) tables.
     </para>
    </listitem>

    <listitem>
     <para>
      Retrieve information on tables, including owner, field information, indexes.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For queries, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Define, edit and store user-defined queries.
     </para>
    </listitem>

    <listitem>
     <para>
      Save view layouts.
     </para>
    </listitem>

    <listitem>
     <para>
      Store queries as views.
     </para>
    </listitem>

    <listitem>
     <para>
      Execute with optional user input parameters, e.g.,
<programlisting>
select * from invoices where year=[parameter "Year of selection"]
</programlisting>
     </para>
    </listitem>

    <listitem>
     <para>
      View any select query result.
     </para>
    </listitem>

    <listitem>
     <para>
      Run action queries (insert, update, delete).
     </para>
    </listitem>

    <listitem>
     <para>
      Construct queries using a visual query builder
      with drag &amp; drop support, table aliasing.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For sequences, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Define new instances.
     </para>
    </listitem>

    <listitem>
     <para>
      Inspect existing instances.
     </para>
    </listitem>

    <listitem>
     <para>
      Delete.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For views, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Define them by saving queries as views.
     </para>
    </listitem>

    <listitem>
     <para>
      View them, with filtering and sorting capabilities.
     </para>
    </listitem>

    <listitem>
     <para>
      Design new views.
     </para>
    </listitem>

    <listitem>
     <para>
      Delete (drop) existing views.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For functions, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Define.
     </para>
    </listitem>

    <listitem>
     <para>
      Inspect.
     </para>
    </listitem>

    <listitem>
     <para>
      Delete.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For reports, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Generate simple reports from a table (beta stage).
     </para>
    </listitem>

    <listitem>
     <para>
      Change font, size, and style of fields and labels.
     </para>
    </listitem>

    <listitem>
     <para>
      Load and save reports from the database.
     </para>
    </listitem>

    <listitem>
     <para>
      Preview tables, sample <productname>Postscript</productname> print.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For forms, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Open user-defined forms.
     </para>
    </listitem>

    <listitem>
     <para>
      Use a form design module.
     </para>
    </listitem>

    <listitem>
     <para>
      Access record sets using a query widget.
     </para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
   For scripts, <application>pgaccess</application> can:

   <itemizedlist mark="bullet" spacing="compact">
    <listitem>
     <para>
      Define.
     </para>
    </listitem>

    <listitem>
     <para>
      Modify.
     </para>
    </listitem>

    <listitem>
     <para>
      Call user defined scripts.
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1>
  <title>Notes</title>

  <para>
   <application>pgaccess</application> is written in Tcl/Tk.  Your
   <productname>PostgreSQL</productname> installation needs to be
   built with Tcl support for <application>pgaccess</application> to
   be available.
  </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:
-->
