Thread: Doc updates

Doc updates

From
Bruce Momjian
Date:
OK, can someone confirm which items still need to be done to update the
documentation?

I can't imagine they are all done, and I don't think we can release 7.0
without them all being done.

---------------------------------------------------------------------------


Remove ':' and ';' operators
Add TRUNCATE command to quickly truncate relation (Mike Mascari)
Add SET FSYNC and SHOW PG_OPTIONS commands(Massimo)
Improve CREATE FUNCTION to allow type conversion specification
        (Bernie Frankpitt)
Add CmdTuples() to libpq++(Vince)
New CREATE CONSTRAINT TRIGGER and SET CONSTRAINTS commands(Jan)
Allow CREATE FUNCTION WITH clause to be used for all language types
configure --enable-debug adds -g (Peter E)
configure --disable-debug removes -g (Peter E)
First real FOREIGN KEY constraint trigger functionality (Jan)
Add FOREIGN KEY ... MATCH FULL ... ON DELETE CASCADE (Jan)
Add FOREIGN KEY ... MATCH  referential actions (Don Baccus)
Allow WHERE restriction on ctid (physical heap location) (Hiroshi)
Move pginterface from contrib to interface directory, rename to pgeasy (Bruce)
Add Oracle's COMMENT ON command (Mike Mascari yahoo.
libpq's PQsetNoticeProcessor function now returns previous hook(Peter E)
Prevent PQsetNoticeProcessor from being set to NULL (Peter E)
Added psql LastOid variable to return last inserted oid (Peter E)
New libpq functions to allow asynchronous connections: PQconnectStart(),
   PQconnectPoll(), PQresetStart(), PQresetPoll(), PQsetenvStart(),
   PQsetenvPoll(), PQsetenvAbort (Ewan Mellor)
New libpq PQsetenv() function (Ewan Mellor)
create/alter user extension (Peter E)
New postmaster.pid and postmaster.opts under $PGDATA (Tatsuo)
New scripts for create/drop user/db (Peter E)
Major psql overhaul(Peter E)
Add const to libpq interface(Peter E)
New libpq function PQoidValue (Peter E)
Add aggregate(DISTINCT ...) (Tom)
Allow flag to control COPY input/output of NULLs (Peter E)
Add CREATE/ALTER/DROP GROUP (Peter E)
All administration scripts now support --long options (Peter E, Karel)
Vacuumdb script now supports --alldb option (Peter E)
Add ecpg EXEC SQL IFDEF, EXEC SQL IFNDEF, EXEC SQL ELSE, EXEC SQL ELIF
        and EXEC SQL ENDIF directives
Add pg_ctl script to control backend startup (Tatsuo)
Add postmaster.opts.default file to store startup flags (Tatsuo)
Allow --with-mb=SQL_ASCII
Add initdb --enable-multibyte option (Peter E)
Updated user interfaces on initdb, initlocation, pg_dump, ipcclean
(Peter E)
New plperl internal programming language (Mark Hollomon)
Add Oracle's to_char(), to_date(), to_datetime(), to_timestamp(), to_number()
        conversion functions (Karel Zak zf.jcu.cz>)
Add SELECT DISTINCT ON (expr [, expr ...]) targetlist ... (Tom)
Add ALTER TABLE ... ADD FOREIGN KEY (Stephan Szabo)
Add SESSION_USER as SQL92 keyword, same as CURRENT_USER (Thomas)
Implement column aliases (aka correlation names) and more join syntax
(Thomas)
Allow queries like SELECT a FROM t1 tx (a) (Thomas)
Allow queries like SELECT * FROM t1 NATURAL JOIN t2 (Thomas)
Implement REINDEX command (Hiroshi)
Accept ALL in aggregate function SUM(ALL col) (Tom)
Allow PQrequestCancel() to terminate when in waiting-for-lock state (Hiroshi)
New libpq functions PQsetClientEncoding(), PQclientEncoding() (Tatsuo)
Make libpq's PQconndefaults() thread-safe (Tom)
New lztext data type for compressed text fields
New C-routines to implement a BIT and BIT VARYING type in /contrib
        (Adriaan Joubert)
Make ISO date style (2000-02-16 09:33) the default (Thomas)
Add NATIONAL CHAR [ VARYING ]
New TIME WITH TIME ZONE type (Thomas)
Add round(), sqrt(), cbrt(), pow()
Rename NUMERIC power() to pow()
Improved TRANSLATE() function
Add Linux ARM.
Update for QNX (Kardos, Dr. Andreas)
Internally change datetime and timespan into timestamp and interval (Thomas)
configure --with-mb now deprecated (Tatsuo)
NetBSD fixes Johnny C. Lam stat.cmu.edu>
Fixes for Alpha compiles
New multibyte encodings

--
  Bruce Momjian                        |  http://www.op.net/~candle
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026

Re: Doc updates

From
Bruce Momjian
Date:
> On Wed, Apr 05, 2000 at 01:30:39PM -0400, Bruce Momjian wrote:
> > OK, can someone confirm which items still need to be done to update the
> > documentation?
> > 
> > I can't imagine they are all done, and I don't think we can release 7.0
> > without them all being done.
> 
> Could you use an extra pair of hands on the documentation? I'm not
> hugely familiar with Postgres internals, nor do I have a great deal of
> experience with it, but I can find some spare time and I can write. I
> don't know what the shape of things is around here but if you want to
> point me at some task I'll gladly have a go at it.

Wow, I am not sure how to address this.  Someone?

--  Bruce Momjian                        |  http://www.op.net/~candle pgman@candle.pha.pa.us               |  (610)
853-3000+  If your life is a hard drive,     |  830 Blythe Avenue +  Christ can be your backup.        |  Drexel Hill,
Pennsylvania19026
 


Re: Doc updates

From
Tatsuo Ishii
Date:
> OK, can someone confirm which items still need to be done to update the
> documentation?
>
> I can't imagine they are all done, and I don't think we can release 7.0
> without them all being done.

> Add pg_ctl script to control backend startup (Tatsuo)
> Add postmaster.opts.default file to store startup flags (Tatsuo)

I have written a man page for pg_ctl (see below). However, it's still
in a plain text, not marked up yet. I'm very busy right now, and
probably could start to make it into a SGML after 4/12. Is it too late
for the release schedule of 7.0?
--
Tatsuo Ishii
-------------------------------------------------------------------------
NAME

pg_ctl - starts/stops/restarts postmaster

SYNOPSIS

pg_ctl [-w][-D database_dir][-p path_to_postmaster][-o "postmaster_opts"] start
pg_ctl [-w][-D database_dir][-m [s[mart]|f[ast]|i[mmediate]]] stop
pg_ctl [-w][-D database_dir][-m [s[mart]|f[ast]|i[mmediate]][-o "postmaster_opts"] restart
pg_ctl [-D database_dir] status

DESCRIPTION

pg_ctl is a utility for starting, stopping or restarting postmaster.

Starting postmaster

To start postmaster:

pg_ctl start

If -w is supplied, pg_ctl waits for the database server comes up, by
watching for creation of the pid file (PGDATA/postmaster.pid), for up
to 60 seconds.

Parameters to invoke postmaster are taken from following sources:

Path to postmaster: found in the command search path
Database directory: PGDATA environment variable
Other parameters: PGDATA/postmaster.opts.default

postmaster.opts.default contains parameters for postmaster. With a
default installation, the "-S" option is enabled. So "pg_ctl start"
implies:

postmaster -S

Note that postmaster.opts.default is installed by initdb from
lib/postmaster.opts.default.sample under the PostgreSQL installation
directory (lib/postmaster.opts.default.sample is copied from
src/bin/pg_ctl/postmaster.opts.default.sample while installing
PostgreSQL).

To override default parameters you can use -D, -p and -o options.

-D database_dir
    specifies the database directory

-p path_to_postmaster
    specifies the path to postmaster

-o "postmaster_opts"
    specifies any parameters for postmaster

Examples:

# blocks until postmaster comes up
pg_ctl -w start

# specifies postmaster path
pg_ctl -p /usr/local/pgsq/bin/postmaster start

# uses port 5433 and disables fsync
pg_ctl -o "-o -F -p 5433" start

Stopping postmaster

pg_ctl stop

stops postmaster.

There are several options for the stopping mode.

-w
    waits for postmaster to shut down

-m [s[mart]|f[ast]|i[mmediate]]
       specifies the shutdown mode. smart mode waits for all
       the clients to logout. This is the default.
       fast mode sends SIGTERM to the backends, that means
       active transactions get rolled back. immediate mode sends SIGUSR1
       to the backends and lets them abort. In this case, database recovery
       will be neccessary on the next startup.


Restarting postmaster

This is almost equivalent to stopping postmaster then starting it
again except that the parameters for postmaster used before stopping
it would be used too. This is done by saving them in
PGDATA/postmaster.opts file. -w, -D, -m, -fast, -immediate and -o
can also be used in the restarting mode and they have same meanings as
described above.

Examples:

# restarts postmaster in the simplest form
pg_ctl restart

# restarts postmaster, waiting for it to shut down and to come up
pg_ctl -w restart

# uses port 5433 and disables fsync next time
pg_ctl -o "-o -F -p 5433" restart

Getting status from postmaster

To get status information from postmaster:

pg_ctl status

Following is sample outputs from pg_ctl.

pg_ctl: postmaster is running (pid: 13718)
options are:
/usr/local/src/pgsql/current/bin/postmaster
-p 5433
-D /usr/local/src/pgsql/current/data
-B 64
-b /usr/local/src/pgsql/current/bin/postgres
-N 32
-o '-F'


************

************

************

Re: Doc updates

From
Thomas Lockhart
Date:
> I have written a man page for pg_ctl (see below). However, it's still
> in a plain text, not marked up yet. I'm very busy right now, and
> probably could start to make it into a SGML after 4/12. Is it too late
> for the release schedule of 7.0?

I'll be happy to mark up what is available. Can I use what you
included in the email? If so, I'll go ahead and put it in...

                     - Thomas

--
Thomas Lockhart                lockhart@alumni.caltech.edu
South Pasadena, California

Re: Doc updates

From
Tatsuo Ishii
Date:
> > I have written a man page for pg_ctl (see below). However, it's still
> > in a plain text, not marked up yet. I'm very busy right now, and
> > probably could start to make it into a SGML after 4/12. Is it too late
> > for the release schedule of 7.0?
>
> I'll be happy to mark up what is available. Can I use what you
> included in the email? If so, I'll go ahead and put it in...

Thank you very much. Please do it. Also, please feel free to
modify/change what I wrote to correct grammatical errors..
--
Tatsuo Ishii

RE: Doc updates

From
"Hiroshi Inoue"
Date:
> -----Original Message-----
> From: pgsql-hackers-owner@hub.org [mailto:pgsql-hackers-owner@hub.org]On
> Behalf Of Bruce Momjian
>
> OK, can someone confirm which items still need to be done to update the
> documentation?
>
> Implement REINDEX command (Hiroshi)

I commited doc/src/sgml/ref/reindex.sgml to CVS last weekend.
However I couldn't confirm that it's written in right sgml format.
I'm happy if someone would check it together with grammatical errors.

> Allow WHERE restriction on ctid (physical heap location) (Hiroshi)
> Allow PQrequestCancel() to terminate when in waiting-for-lock
> state (Hiroshi)

What kind of documentation must I write for above 2 items ?

Regards.

Hiroshi Inoue
Inoue@tpf.co.jp