Commit Graph

174 Commits

Author SHA1 Message Date
Robert Haas 45768d10e3 Document the dummy_seclabel contrib module.
KaiGai Kohei, with editing and markup fixes by me.
2010-11-17 20:50:51 -05:00
Robert Haas 3186560f46 Replace doc references to install-win32 with install-windows.
Windows is not necessarily 32-bit, any more.

As suggested by Mike Toews.
2010-09-23 17:45:39 -04:00
Magnus Hagander 726f9ddcd1 Remove anonymous cvs instructions, and replace them with instructions
for git. Change other references from cvs to git as well.
2010-09-22 20:10:28 +02:00
Magnus Hagander 9f2e211386 Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
Tom Lane c89a1198f9 9.1alpha1 release notes. 2010-09-02 17:30:06 +00:00
Simon Riggs 24bfbb5857 Docs for pg_archivecleanup 2010-06-14 17:25:24 +00:00
Bruce Momjian c2e9b2f288 Add pg_upgrade to /contrib; will be in 9.0 beta2.
Add documentation.

Supports migration from PG 8.3 and 8.4.
2010-05-12 02:19:11 +00:00
Heikki Linnakangas 3229db2d42 Move documentation of all recovery.conf option to a new chapter.
They used to be scattered between the "backup and restore" and "streaming
replication" chapters.
2010-02-22 11:47:30 +00:00
Tom Lane 50a90fac40 Stamp HEAD as 9.0devel, and update various places that were referring to 8.5
(hope I got 'em all).  Per discussion, this release will be 9.0 not 8.5.
2010-02-17 04:19:41 +00:00
Tom Lane c742b795dd Add a hook to CREATE/ALTER ROLE to allow an external module to check the
strength of database passwords, and create a sample implementation of
such a hook as a new contrib module "passwordcheck".

Laurenz Albe, reviewed by Takahiro Itagaki
2009-11-18 21:57:56 +00:00
Teodor Sigaev 92e05bc6a5 Unaccent dictionary. 2009-08-18 10:34:39 +00:00
Peter Eisentraut 77dfb64df4 Add release notes for 8.5alpha1 2009-08-17 22:14:44 +00:00
Peter Eisentraut 4ef8dc7a75 Rearrangement of the HTML docs build rules
Set up proper makefile dependencies in the documentation build rules,
especially around the HTML/index build.  The problem we've had with all
previous solutions is that we have used the same file name, such as HTML.index
or bookindex.sgml, to mean different things at different stages of the build,
and make can't distinguish that.  The solution here is that the first jade run
produces HTML.index, but does not require bookindex.sgml at all, and produces
no other html output (the latter an idea from Alvaro).  The second jade run
includes bookindex.sgml, but does not recreate HTML.index.  That way, when you
change an sgml file, jade is run twice and at the end all dependencies are
satisfied.  Omitting the html output in the first stage also makes the full
build a lot faster.

When you run one of the print format targets, only the first jade run is run,
then the print target-specific commands.  If an HTML build has completed
previously, the first jade run is skipped because the dependencies have
already been satisfied.

The draft and check targets for quick builds and syntax verification are still
there.
2009-07-14 22:16:38 +00:00
Tom Lane 008fad58fe Split the release notes into a separate file for each (active) major branch,
as per my recent proposal.  release.sgml itself is now just a stub that should
change rarely; ideally, only once per major release to add a new include line.
Most editing work will occur in the release-N.N.sgml files.  To update a back
branch for a minor release, just copy the appropriate release-N.N.sgml
file(s) into the back branch.

This commit doesn't change the end-product documentation at all, only the
source layout.  However, it makes it easy to start omitting ancient information
from newer branches' documentation, should we ever decide to do that.
2009-05-02 20:17:19 +00:00
Tom Lane 9151e1bb06 Add btree_gin contrib module.
Teodor Sigaev and Oleg Bartunov
2009-03-25 23:20:01 +00:00
Tom Lane 7466eeac61 Add contrib/pg_stat_statements for server-wide tracking of statement execution
statistics.

Takahiro Itagaki
2009-01-04 22:19:59 +00:00
Tom Lane e125e28e78 Add auto-explain contrib module for automatic logging of the plans of
slow-running queries.

Takahiro Itagaki
2008-11-19 02:59:28 +00:00
Tom Lane ab9907f5e5 Add a new, improved version of citext as a contrib module.
David E. Wheeler
2008-07-29 18:31:20 +00:00
Tom Lane 53ae7acbba Add SGML documentation for contrib/spi and contrib/test_parser.
The spi documentation is pretty rudimentary, but it's a start.
2007-12-03 04:18:47 +00:00
Tom Lane 3b3251cb95 Ensure that all <sect1> and <refentry> tags have IDs. This is needed
to ensure that the resulting webpages have predictable URLs, instead of
ever-changing numeric IDs.  The new contrib docs were the biggest
offender, but some old stuff had the problem too.  Also, rename a couple
of new contrib sgml files for consistency's sake.
2007-12-02 22:33:20 +00:00
Tom Lane ec2ff52045 Add SGML docs for contrib/dict_int and contrib/dict_xsyn.
Albert Cervera i Areny
2007-12-02 21:13:34 +00:00
Tom Lane 4c2d0cd5e4 Add some quick documentation for tsearch2 compatibility module. 2007-11-14 01:09:50 +00:00
Bruce Momjian c3c69ab4fd Move most /contrib README files into SGML. Some still need conversion
or will never be converted.
2007-11-10 23:30:46 +00:00
Bruce Momjian 61c8163957 Add acronym section to our documentation. 2007-11-01 17:00:46 +00:00
Tom Lane 3e3bb36ee9 First rough cut at text search documentation: bare bones reference
pages for the new SQL commands.  I also committed Bruce's text search
introductory chapter, as-is except for fixing some markup errors,
so that there would be a place for the reference pages to link to.
2007-08-21 21:08:47 +00:00
Bruce Momjian e1693e514c Rename replication section "High Availability and Load Balancing". 2006-11-17 16:38:44 +00:00
Bruce Momjian 2cbdb5522b Add documentation section on failover, replication, load balancing, and
clustering options.
2006-10-26 15:26:54 +00:00
Teodor Sigaev 0ca9907ce4 GIN documentation and slightly improving GiST docs.
Thanks to  Christopher Kings-Lynne <chris.kingslynne@gmail.com> for
initial version and Jeff Davis <pgsql@j-davis.com> for inspection
2006-09-14 11:16:27 +00:00
Bruce Momjian 10964008c9 Remove GIN documentation
Christopher Kings-Lynne
2006-09-05 03:09:56 +00:00
Bruce Momjian 19dd2fbf7e Add GIN documentation.
Christopher Kings-Lynne
2006-09-04 20:10:53 +00:00
Neil Conway 9813fc1bae Make the documentation of GUC variables a separate chapter, rather than
a section of the "Server Run-time Environment" chapter. Also, move the
SGML for the new chapter to a separate file and fix the resulting
fallout.
2005-09-12 22:11:38 +00:00
Bruce Momjian 234d50812c Add documentation on how statistics are used by the planner.
Mark Kirkwood
2005-02-27 00:49:28 +00:00
Tom Lane c6521b1b93 Write some real documentation about the index access method API. 2005-02-13 03:04:15 +00:00
Tom Lane ab3bb9cf78 Add some real documentation about TOAST (finally). Combine this with
the old 'page' chapter and the recently added 'filelayout' chapter to
make a coherent chapter about PostgreSQL's physical storage layout.
2005-01-10 00:04:43 +00:00
Bruce Momjian 6b16aaa065 First version of external projects manual section. 2004-12-03 05:50:18 +00:00
Tom Lane 7f4b5a003b Add some real documentation about the overall filesystem layout used by
a Postgres database.  Update page.sgml to match 8.0 tuple header layout.
2004-11-12 21:50:53 +00:00
Tom Lane 982d005d62 Some preliminary documentation for composite-type stuff. 2004-06-07 04:04:47 +00:00
Bruce Momjian c310d28766 Remove TCL docs. 2004-04-20 01:11:49 +00:00
Bruce Momjian 296f485492 Remove libpgeasy and odbc doc reference in filelist.sgml --- removed to
gborg.
2004-04-09 18:03:13 +00:00
Tom Lane bd046b99f0 Remove JDBC from the build system and documentation, too. 2004-01-19 21:20:06 +00:00
PostgreSQL Daemon 969685ad44 $Header: -> $PostgreSQL Changes ... 2003-11-29 19:52:15 +00:00
Tom Lane 747df1a35e Remove obsolete information about altering default optimization flags for
gcc.  Per comment from original author, Brian Gallew:
"Ancient history.  Kill it fast."
2003-10-23 13:58:43 +00:00
Tom Lane cdbf9b328e Move docs about index cost estimation functions and writing a procedural
language handler to the 'Internals' area, per my proposal of yesterday.
Clean up the trigger documentation a bit.  Push SPI chapter to the end
of its part, and reorder the Internals chapters into what seems a more
sensible order (at the moment anyway).
2003-10-22 22:28:10 +00:00
Tom Lane e5c2c97892 Add a listing of our SQLSTATE error codes to the documentation.
Link to it from some appropriate places.
2003-10-17 18:57:01 +00:00
Peter Eisentraut f10a9033bf Clean up after pygresql removal: adjust/remove documentation and remove
unneeded configure work.
2003-09-01 23:01:49 +00:00
Peter Eisentraut f89c972ac8 Add documentation for information schema, and some corrections on some
views.
2003-05-18 20:55:57 +00:00
Peter Eisentraut a6554df4f7 In an effort to reduce the total number of chapters, combine the small
chapters on extending types, operators, and aggregates into the extending
functions chapter.  Move the information on how to call table functions
into the queries chapter.  Remove some outdated information that is
already present in a better form in other parts of the documentation.
2003-04-10 01:22:45 +00:00
Peter Eisentraut 5e5c5cd31a Merge documentation into one book. (Build with "make html".) Replace
vague cross-references with real links.
2003-03-25 16:15:44 +00:00
Peter Eisentraut 2160c9177d Add sql_features table to information schema. Generate the features list
in the documentation from that same data.
2003-01-14 23:19:34 +00:00
Peter Eisentraut 266a280584 Add introductory sections explaining what each book is about. Remove Y2K
statement.
2002-10-24 17:48:54 +00:00
Peter Eisentraut 841e4b2089 Put the disk information all in one chapter. 2002-10-16 22:06:33 +00:00
Peter Eisentraut c889c9c901 Enhance the description of user and database management. Reduce the
number of forward references in the admin guide.
2002-09-25 21:16:10 +00:00
Bruce Momjian f6353c6ee4 Remove libpq++ SGML documentation. 2002-08-22 03:17:38 +00:00
Peter Eisentraut 6f4a9fb119 Add User's Guide chapters on Data Definition and Data Manipulation.
Still needs to be filled with more information, but it gives us a
framework to have a User's Guide with complete coverage of the basic
SQL operations.  Move arrays into data type chapter, inheritance into
DDL chapter (for now).

Make <comment>s show up in the output while the version number ends in
"devel".

Allow cross-book references with entities &cite-user; etc.
2002-08-05 19:43:31 +00:00
Bruce Momjian f514bb3e25 Would it be wise to have the plsql.sgml file renamed to plpgsql.sgml?
All of the internal tags are of the latter.

The other thing I noticed is that most of the quick examples in the file
use a para and synopsis.  Is there a reason we're not using <example/> ?

Rod Taylor
2002-07-30 19:36:13 +00:00
Thomas G. Lockhart 133df7ce70 Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard.
Remove ODBC-compatible empty parentheses from calls to SQL99 functions
 for which these parentheses do not match the standard.
Update the ODBC driver to ensure compatibility with the ODBC standard
 for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc).
Include a new appendix in the User's Guide which lists the labeled features
 for SQL99 (the labeled features replaced the "basic", "intermediate",
 and "advanced" categories from SQL92). features.sgml does not yet split
 this list into "supported" and "unsupported" lists.
2002-06-15 03:00:09 +00:00
Bruce Momjian 9310caf589 Update for new SGML file. 2002-06-13 05:54:00 +00:00
Tom Lane 8be02853b8 Add documentation about statistics collector and stats views & functions. 2001-10-16 23:57:06 +00:00
Peter Eisentraut 4e77b4a548 Readd test/regress/README file, this time with a well-defined and simple
rule to remake it when necessary.
2001-09-21 18:37:05 +00:00
Peter Eisentraut 60ce9e9279 New blood and fresh air for tutorial 2001-09-02 23:27:50 +00:00
Tom Lane 8e0d642c9b Documentation for transaction-ID-wraparound changes. Add a chapter to
the Admin Guide about routine maintenance tasks.  Currently this only
discusses the various reasons for doing VACUUM, but perhaps it could be
fleshed out with topics like log rotation.
2001-08-26 21:17:12 +00:00
Peter Eisentraut e542036461 Native Language Support (NLS)
Use --enable-nls to turn it on; see installation instructions for details.
See developer's guide how to make use of it in programs and how to add
translations.

psql sources have been almost fully prepared and an incomplete German
translation has been provided.  In the backend, only elog() calls are
currently translatable, and the provided German translation file is more
of a placeholder.
2001-06-02 18:25:18 +00:00
Peter Eisentraut 01839df6dd Add index. Only some parts of the manual set have index entries so far... 2001-05-12 22:51:36 +00:00
Peter Eisentraut bbc3920fe9 PL/Python should build portably now, if you can get over the fact that
there's no shared libpython.  Test suite works as well. Also, add some
documentation.
2001-05-12 17:49:32 +00:00
Bruce Momjian a5b17eb280 Remove LISP manual reference. Added to web "interfaces" page. 2001-05-08 19:14:52 +00:00
Peter Eisentraut 5bbad66e0e PyGreSQL documentation. Based on the README, converted to DocBook by
Mikhail Terekhov <terekhov@emc.com>.
2001-03-04 18:54:07 +00:00
Peter Eisentraut ab29852224 Move PL docs to programmer's guide, "storage" chapter to admin guide,
clean up some things in the affected areas.
2001-02-04 15:28:18 +00:00
Peter Eisentraut 7c164dca0b Update, polish, consistencify preface/intro sections. 2001-02-03 19:03:27 +00:00
Peter Eisentraut 7b9dc71405 WAL documentation, from Oliver Elphick and Vadim Mikheev. 2001-01-24 23:15:19 +00:00
Peter Eisentraut 21a3857f1f Rip out table expression section from SQL syntax chapter and develop it
into new chapter on query (SELECT) syntax.  In the end this should become
a narrative and example-filled counterpart to the SELECT reference page.
2001-01-22 23:34:33 +00:00
Peter Eisentraut 3942ee389c Update section on SQL syntax. (Still a lot to be done though.) Add
appendix with comprehensive list of key words.
2001-01-06 11:58:56 +00:00
Tom Lane ad4fd77a5f Restructure performance tips into a single chapter ('populating a
database' was way too small to make a chapter).  Add a section about
using JOIN syntax to direct the planner.
2000-12-16 02:29:36 +00:00
Peter Eisentraut c3641483c3 Merge functions and operators chapters. Lots of updates. 2000-12-14 22:30:56 +00:00
Peter Eisentraut b2e76d570b Revive Reference Manual, remove reference pages from User's Guide.
Make version.sgml the central place for updating version numbers in the
documentation.  Document titles now contain the version number of the
release they belong to.

filelist.sgml is the central (and only) place to declare system entities
(i.e., sgml files).  No longer a need to declare them in each document
header.

There is no longer any need to maintain duplicate chapter lists in
postgres.sgml and user/admin/etc.sgml, everything is build from the same
sources.  Some parameter entities allow for different text to be included
when the integrated or a single doc set is generated, which eliminates the
problems that had caused this to fail in the past.
2000-11-24 17:44:22 +00:00