[RFC] extended txid docs

From: "Marko Kreen" <markokr(at)gmail(dot)com>
To: "Postgres Hackers" <pgsql-hackers(at)postgresql(dot)org>, "Postgres Patches" <pgsql-patches(at)postgresql(dot)org>
Subject: [RFC] extended txid docs
Date: 2007-10-16 15:29:34
Message-ID: e51f66da0710160829v6a75673ct3d1d743ec08bdd1b@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-patches

Although the new txid functions are very clean 1:1 interface
to the internal MVCC info and they don't need much docs
in that respect, their "killer" usage comes from the
possibility to query txids committed between 2 snapshots.

But how to do that (efficiently) is far from obvious when
just looking at the API.

So with attached docs patch I try to fill the gap. Here I
also show 2 variants for the common query helper function.

But I'm pretty bad at SGML, english and writing docs, so
please review it. In addition to english/typos/sgml
the suspicious aspects are:

- code style
- writing style
- used mostly PgQ terminology (ticks), could there be
something better?
- giving two variants of helper function may be too much

Even the realistic code may be too much for general docs,
but considering this is not a functionality covered
by general SQL textbooks, I think it is worth having.

I also put rendered pages up here:

http://skytools.projects.postgresql.org/txid/datatype-txid-snapshot.html
http://skytools.projects.postgresql.org/txid/functions-txid.html

--
marko

Attachment Content-Type Size
txid-docs.diff.gz application/x-gzip 3.5 KB

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Zdenek Kotala 2007-10-16 15:41:56 Indiana changes DST (4th Nov)
Previous Message Tom Lane 2007-10-16 14:05:27 Re: pgsql: Add sample text search dictionary templates and parsers, to

Browse pgsql-patches by date

  From Date Subject
Next Message Chris Browne 2007-10-16 20:24:30 Re: [RFC] extended txid docs
Previous Message Heikki Linnakangas 2007-10-16 10:51:17 Re: Why copy_relation_data only use wal when WAL archiving is enabled