summaryrefslogtreecommitdiff
path: root/doc/src
AgeCommit message (Collapse)Author
2014-09-10doc: improve configuration management sectionBruce Momjian
Patch by David Johnston Backpatch through 9.4
2014-09-09doc: Reflect renaming of Mac OS X to OS XPeter Eisentraut
bug #10528
2014-09-08Fix psql \s to work with recent libedit, and add pager support.Tom Lane
psql's \s (print command history) doesn't work at all with recent libedit versions when printing to the terminal, because libedit tries to do an fchmod() on the target file which will fail if the target is /dev/tty. (We'd already noted this in the context of the target being /dev/null.) Even before that, it didn't work pleasantly, because libedit likes to encode the command history file (to ensure successful reloading), which renders it nigh unreadable, not to mention significantly different-looking depending on exactly which libedit version you have. So let's forget using write_history() for this purpose, and instead print the data ourselves, using logic similar to that used to iterate over the history for newline encoding/decoding purposes. While we're at it, insert the ability to use the pager when \s is printing to the terminal. This has been an acknowledged shortcoming of \s for many years, so while you could argue it's not exactly a back-patchable bug fix it still seems like a good improvement. Anyone who's seriously annoyed at this can use "\s /dev/tty" or local equivalent to get the old behavior. Experimentation with this showed that the history iteration logic was actually rather broken when used with libedit. It turns out that with libedit you have to use previous_history() not next_history() to advance to more recent history entries. The easiest and most robust fix for this seems to be to make a run-time test to verify which function to call. We had not noticed this because libedit doesn't really need the newline encoding logic: its own encoding ensures that command entries containing newlines are reloaded correctly (unlike libreadline). So the effective behavior with recent libedits was that only the oldest history entry got newline-encoded or newline-decoded. However, because of yet other bugs in history_set_pos(), some old versions of libedit allowed the existing loop logic to reach entries besides the oldest, which means there may be libedit ~/.psql_history files out there containing encoded newlines in more than just the oldest entry. To ensure we can reload such files, it seems appropriate to back-patch this fix, even though that will result in some incompatibility with older psql versions (ie, multiline history entries written by a psql with this fix will look corrupted to a psql without it, if its libedit is reasonably up to date). Stepan Rutz and Tom Lane
2014-09-07Documentation fix: sum(float4) returns float4, not float8.Tom Lane
The old claim is from my commit d06ebdb8d3425185d7e641d15e45908658a0177d of 2000-07-17, but it seems to have been a plain old thinko; sum(float4) has been distinct from sum(float8) since Berkeley days. Noted by KaiGai Kohei. While at it, mention the existence of sum(money), which is also of embarrassingly ancient vintage.
2014-09-06docs: Improve pg_isready details about username/dbnameBruce Momjian
Report by Erik Rijkers Backpatch through 9.4
2014-09-06Properly document that -r is only honored from the command-line.Bruce Momjian
This is for postgres/postmaster options. Report by Tom Lane Backpatch through 9.4
2014-09-05Clarify documentation about "peer" rows in window functionsBruce Momjian
Peer rows are matching rows when ORDER BY is specified. Report by arnaud.mouronval@gmail.com, David G Johnston Backpatch through 9.4
2014-09-04doc: Remove dead linkPeter Eisentraut
The link to the NIST web page about DES standards leads to nowhere, and according to archive.org has been forwarded to an unrelated page for many years. Therefore, just remove that link. More up to date information can be found via Wikipedia, for example.
2014-09-04docs: Improve documentation of \pset without arguments.Fujii Masao
The syntax summary previously failed to clarify that the first argument is also optional. The textual description did mention it, but all the way at the bottom. It fits better with the command overview, so move it there, and fix the summary also. Back-patch to 9.4 where \pset without arguments was supported. Dilip Kumar, reviewed by Fabien Coelho
2014-09-03Update URL reference material in /contrib/isn docsBruce Momjian
Report by Peter Eisentraut
2014-09-03Document use of partial indexes for partial unique constraintsBruce Momjian
Report by Tomáš Greif Backpatch through 9.4
2014-08-30doc: Various typo/grammar fixesKevin Grittner
Errors detected using Topy (https://github.com/intgr/topy), all changes verified by hand and some manual tweaks added. Marti Raudsepp Individual changes backpatched, where applicable, as far as 9.0.
2014-08-29pg_is_xlog_replay_paused(): remove super-user-only restrictionBruce Momjian
Also update docs to mention which function are super-user-only. Report by sys-milan@statpro.com Backpatch through 9.4
2014-08-28doc: Revert ALTER TABLESPACE summary linePeter Eisentraut
It was changed when ALTER TABLESPACE / MOVE was added but then not updated when that was moved back out.
2014-08-25upgrade docs: highlight pg_upgrade, warn about globals preservationBruce Momjian
Also, remove OID preservation mention, mention non-text dump formats Backpatch through 9.4
2014-08-22Fix corner-case behaviors in JSON/JSONB field extraction operators.Tom Lane
Cause the path extraction operators to return their lefthand input, not NULL, if the path array has no elements. This seems more consistent since the case ought to correspond to applying the simple extraction operator (->) zero times. Cause other corner cases in field/element/path extraction to return NULL rather than failing. This behavior is arguably more useful than throwing an error, since it allows an expression index using these operators to be built even when not all values in the column are suitable for the extraction being indexed. Moreover, we already had multiple inconsistencies between the path extraction operators and the simple extraction operators, as well as inconsistencies between the JSON and JSONB code paths. Adopt a uniform rule of returning NULL rather than throwing an error when the JSON input does not have a structure that permits the request to be satisfied. Back-patch to 9.4. Update the release notes to list this as a behavior change since 9.3.
2014-08-21Rework 'MOVE ALL' to 'ALTER .. ALL IN TABLESPACE'Stephen Frost
As 'ALTER TABLESPACE .. MOVE ALL' really didn't change the tablespace but instead changed objects inside tablespaces, it made sense to rework the syntax and supporting functions to operate under the 'ALTER (TABLE|INDEX|MATERIALIZED VIEW)' syntax and to be in tablecmds.c. Pointed out by Alvaro, who also suggested the new syntax. Back-patch to 9.4.
2014-08-18Make pg_service.conf sample LDIF more portable.Noah Misch
The aboriginal sample placed connection parameters in groupOfUniqueNames/uniqueMember. OpenLDAP, at least as early as version 2.4.23, rejects uniqueMember entries that do not conform to the syntax for a distinguished name. Use device/description, which is free-form. Back-patch to 9.4 for web site visibility.
2014-08-18Document new trigger-related forms of ALTER FOREIGN TABLE.Noah Misch
Oversight in commit 7cbe57c34dec4860243e6d0f81738cfbb6e5d069. Back-patch to 9.4, where that commit first appeared. In passing, release-note the FDW API postcondition change from the same commit.
2014-08-18Adjust Release Notes to reflect holding off wrapped expanded mode until 9.5 ↵Greg Stark
(thanks Michael Paquier)
2014-08-18Fix obsolete mention of non-int64 support in CREATE SEQUENCE documentation.Tom Lane
The old text explained what happened if we didn't have working int64 arithmetic. Since that case has been explicitly rejected by configure since 8.4.3, documenting it in the 9.x branches can only produce confusion.
2014-08-17Use ISO 8601 format for dates converted to JSON, too.Tom Lane
Commit f30015b6d794c15d52abbb3df3a65081fbefb1ed made this happen for timestamp and timestamptz, but it seems pretty inconsistent to not do it for simple dates as well. (In passing, I re-pgindent'd json.c.)
2014-08-18Add missing index terms for replication commands in the document.Fujii Masao
Previously only CREATE_REPLICATION_SLOT was exposed as an index term. That's odd and there is no reason not to add index terms for other replication commands. Back-patch to 9.4.
2014-08-17Make an editorial pass over the 9.4 release notes.Tom Lane
Update the notes to include commits through today, and do a lot of wordsmithing and markup adjustment. Notably, don't use <link> where <xref> will do; since we got rid of the text-format HISTORY file, there is no longer a reason to avoid <xref>.
2014-08-17Improve DISCARD documentation.Tom Lane
The new DISCARD SEQUENCES option was inadequately described, and hadn't been mentioned at all in the initial Description paragraph. Rather than rectifying the latter the hard way, it seemed better to rewrite the description as a summary, instead of having it basically duplicate statements made under Parameters. Be more consistent about the ordering of the options, too.
2014-08-17doc: Work around stylesheet bug for man buildPeter Eisentraut
The upstream stylesheets for man output insert a *roff comment for an occurrence of an indexterm, for reasons that have apparently been lost in history. This, however, is done incorrectly and causes some formatting problems. This hasn't been an issue until now, but the reorganization of indexterm elements inside variablelists has triggered this issue. The upstream fix (http://sourceforge.net/p/docbook/bugs/1340/) is to drop indexterms altogether in man output, and so we'll do the same here.
2014-08-14Update SysV parameter configuration documentation for FreeBSD.Tom Lane
FreeBSD hasn't made any use of kern.ipc.semmap since 1.1, and newer releases reject attempts to set it altogether; so stop recommending that it be adjusted. Per bug #11161. Back-patch to all supported branches. Before 9.3, also incorporate commit 7a42dff47, which touches the same text and for some reason was not back-patched at the time.
2014-08-13Expose -S option in pg_receivexlog.Fujii Masao
This option is equivalent to --slot option which pg_receivexlog has already supported, which specifies the replication slot to use for WAL streaming. pg_recvlogical has already supported both options, and this commit makes pg_receivexlog consistent with pg_recvlogical regarding the slot option. Back-patch to 9.4 where the slot option was added. Michael Paquier
2014-08-11Fix documentation oversights about pageinspect and initialization fork.Fujii Masao
The initialization fork was added in 9.1, but has not been taken into consideration in documents of get_raw_page function in pageinspect and storage layout. This commit fixes those oversights. get_raw_page can read not only a table but also an index, etc. So it should be documented that the function can read any relation. This commit also fixes the document of pageinspect that way. Back-patch to 9.1 where those oversights existed. Vik Fearing, review by MauMau
2014-08-10Clarify type resolution behavior for domain types.Tom Lane
The user documentation was vague and not entirely accurate about how we treat domain inputs for ambiguous operators/functions. Clarify that, and add an example and some commentary. Per a recent question from Adam Mackler. It's acted like this ever since we added domains, so back-patch to all supported branches.
2014-08-09Further cleanup of JSON-specific error messages.Tom Lane
Fix an obvious typo in json_build_object()'s complaint about invalid number of arguments, and make the errhint a bit more sensible too. Per discussion about how to word the improved hint, change the few places in the documentation that refer to JSON object field names as "names" to say "keys" instead, since that's what we've said in the vast majority of places in the docs. Arguably "name" is more correct, since that's the terminology used in RFC 7159; but we're stuck with "key" in view of the naming of json_object_keys() so let's at least be self-consistent. I adjusted a few code comments to match this as well, and failed to resist the temptation to clean up some odd whitespace choices in the same area, as well as a useless duplicate PG_ARGISNULL() check. There's still quite a bit of code that uses the phrase "field name" in non-user- visible ways, so I left those usages alone.
2014-08-07Fix typo in docs.Tom Lane
s/XIDs XIDs/XIDs/ in one place in maintenance.sgml. Guillaume Lelarge
2014-08-01Fix typo in user manualHeikki Linnakangas
2014-07-29doc: Clean up some recently added PL/pgSQL documentationPeter Eisentraut
- Capitalize titles consistently. - Fix some grammar. - Group "Obtaining Information About an Error" under "Trapping Errors", but make "Obtaining the Call Stack Context Information" its own section, since it's not about errors.
2014-07-29Reword the sentence for pg_logical_slot_peek_changes function.Fujii Masao
Previously the duplicated paragraphs were used next to each other in the document to demonstrate that the changes in the stream were not consumed by pg_logical_slot_peek_changes function. But some users misunderstood that the duplication of the same paragraph was just typo. So this commit rewords the sentence in the latter paragraph for less confusing. Christoph Moench-Tegeder
2014-07-26doc: Fix up ALTER TABLESPACE reference pagePeter Eisentraut
The documentation of ALTER TABLESPACE ... MOVE was added without any markup, not even paragraph breaks. Fix that, and clarify the text in a few places.
2014-07-23Rearrange documentation paragraph describing pg_relation_size().Tom Lane
Break the list of available options into an <itemizedlist> instead of inline sentences. This is mostly motivated by wanting to ensure that the cross-references to the FSM and VM docs don't cross page boundaries in PDF format; but it seems to me to read more easily this way anyway. I took the liberty of editorializing a bit further while at it. Per complaint from Magnus about 9.0.18 docs not building in A4 format. Patch all active branches so we don't get blind-sided by this particular issue again in future.
2014-07-21Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22.Tom Lane
2014-07-19Fix xreflabel for hot_standby_feedback.Tom Lane
Rather remarkable that this has been wrong since 9.1 and nobody noticed.
2014-07-18Limit pg_upgrade authentication advice to always-secure techniques.Noah Misch
~/.pgpass is a sound choice everywhere, and "peer" authentication is safe on every platform it supports. Cease to recommend "trust" authentication, the safety of which is deeply configuration-specific. Back-patch to 9.0, where pg_upgrade was introduced.
2014-07-16doc: Spell checkingPeter Eisentraut
2014-07-15doc: Put new options in right order on reference pagesPeter Eisentraut
2014-07-14doc: small fixes for REINDEX reference pagePeter Eisentraut
From: Josh Kupershmidt <schmiddy@gmail.com>
2014-07-09Rename logical decoding's pg_llog directory to pg_logical.Andres Freund
The old name wasn't very descriptive as of actual contents of the directory, which are historical snapshots in the snapshots/ subdirectory and mappingdata for rewritten tuples in mappings/. There's been a fair amount of discussion what would be a good name. I'm settling for pg_logical because it's likely that further data around logical decoding and replication will need saving in the future. Also add the missing entry for the directory into storage.sgml's list of PGDATA contents. Bumps catversion as the data directories won't be compatible. Backpatch to 9.4, which I missed to do as Michael Paquier luckily noticed. As there already has been a catversion bump after 9.4beta1, there's no reasons for having 9.4 diverge from master.
2014-07-08Fix whitespacePeter Eisentraut
2014-07-08Update key words table for 9.4Peter Eisentraut
2014-07-08doc: Link text to table by idPeter Eisentraut
2014-07-08doc: Fix spacing in verbatim environmentsPeter Eisentraut
2014-06-29Remove use_json_as_text options from json_to_record/json_populate_record.Tom Lane
The "false" case was really quite useless since all it did was to throw an error; a definition not helped in the least by making it the default. Instead let's just have the "true" case, which emits nested objects and arrays in JSON syntax. We might later want to provide the ability to emit sub-objects in Postgres record or array syntax, but we'd be best off to drive that off a check of the target field datatype, not a separate argument. For the functions newly added in 9.4, we can just remove the flag arguments outright. We can't do that for json_populate_record[set], which already existed in 9.3, but we can ignore the argument and always behave as if it were "true". It helps that the flag arguments were optional and not documented in any useful fashion anyway.
2014-06-26Get rid of bogus separate pg_proc entries for json_extract_path operators.Tom Lane
These should not have existed to begin with, but there was apparently some misunderstanding of the purpose of the opr_sanity regression test item that checks for operator implementation functions with their own comments. The idea there is to check for unintentional violations of the rule that operator implementation functions shouldn't be documented separately .... but for these functions, that is in fact what we want, since the variadic option is useful and not accessible via the operator syntax. Get rid of the extra pg_proc entries and fix the regression test and documentation to be explicit about what we're doing here.