summaryrefslogtreecommitdiff
path: root/doc/src/sgml/pgbuffercache.sgml
Commit message (Collapse)AuthorAgeFilesLines
* Add missing XML ID attributePeter Eisentraut2023-04-131-1/+1
| | | | Discussion: https://www.postgresql.org/message-id/dc813a6f-60d9-991f-eecd-675a0921de11@gmx.de
* doc: Fix some typos and grammarMichael Paquier2023-04-121-1/+1
| | | | | | | | This is a first batch of the fixes, for the most obvious fixes. A little bit more is under discussion. Author: Thom Brown, Justin Pryzby Discussion: https://postgr.es/m/CAA-aLv7xCZ0nBJa-NWe0rxBB28TjFjS2JtjiZMoQ+0wsugG+hQ@mail.gmail.com
* Add pg_buffercache_usage_counts() to contrib/pg_buffercache.Tom Lane2023-04-071-4/+101
| | | | | | | | | | | | | | It was pointed out that pg_buffercache_summary()'s report of the overall average usage count isn't that useful, and what would be more helpful in many cases is to report totals for each possible usage count. Add a new function to do it like that. Since pg_buffercache 1.4 is already new for v16, we don't need to create a new extension version; we'll just define this as part of 1.4. Nathan Bossart Discussion: https://postgr.es/m/20230130233040.GA2800702@nathanxps13
* doc: spell out full productnameDaniel Gustafsson2023-03-141-1/+2
| | | | | | | | | Use PostgreSQL consistently for referring to the productname rather than Postgres. This also adds <productname> markup. Reviewed-by: Alvaro Herrera <alvherre@alvh.no-ip.org> Reviewed-by: "Jonathan S. Katz" <jkatz@postgresql.org> Discussion: https://postgr.es/m/9C019644-9EA4-4B79-A52C-5C47A5B6B2DF@yesql.se
* Describe each contrib module in its SGML section titleAlvaro Herrera2023-01-201-1/+1
| | | | | | | | | | | | | | The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Also amend the introduction in the "additional modules" appendix, using the word "Extension" more extensively. Nowadays, almost all contrib modules are extensions, so this is also helpful. Author: Karl O. Pinc <kop@karlpinc.com> Reviewed-by: Brar Piening <brar@gmx.de> Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com
* Doc: fix a few oddly-spelled SGML ID attributes.Tom Lane2023-01-171-2/+2
| | | | | | | | | | | Avoid use of "_" in SGML IDs. Awhile back that was actually disallowed by the toolchain, as a consequence of which our convention has been to use "-" instead. Fix a couple of stragglers that are particularly inconsistent with that convention and with related IDs. This is just neatnik-ism, so no need for back-patch. Discussion: https://postgr.es/m/769446.1673478332@sss.pgh.pa.us
* Doc: add XML ID attributes to <sectN> and <varlistentry> tags.Tom Lane2023-01-091-4/+4
| | | | | | | | | This doesn't have any external effect at the moment, but it will allow adding useful link-discoverability features later. Brar Piening, reviewed by Karl Pinc. Discussion: https://postgr.es/m/CAB8KJ=jpuQU9QJe4+RgWENrK5g9jhoysMw2nvTN_esoOU0=a_w@mail.gmail.com
* pg_buffercache: Add pg_buffercache_summary()Andres Freund2022-10-131-3/+111
| | | | | | | | | | | Using pg_buffercache_summary() is significantly cheaper than querying pg_buffercache and summarizing in SQL. Author: Melih Mutlu <m.melihmutlu@gmail.com> Reviewed-by: Andres Freund <andres@anarazel.de> Reviewed-by: Aleksander Alekseev <aleksander@timescale.com> Reviewed-by: Zhang Mingli <zmlpostgres@gmail.com> Discussion: https://postgr.es/m/CAGPVpCQAXYo54Q%3D8gqBsS%3Du0uk9qhnnq4%2B710BtUhUisX1XGEg%40mail.gmail.com
* Revert 56-bit relfilenode change and follow-up commits.Robert Haas2022-09-281-1/+1
| | | | | | | | There are still some alignment-related failures in the buildfarm, which might or might not be able to be fixed quickly, but I've also just realized that it increased the size of many WAL records by 4 bytes because a block reference contains a RelFileLocator. The effect of that hasn't been studied or discussed, so revert for now.
* Increase width of RelFileNumbers from 32 bits to 56 bits.Robert Haas2022-09-271-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | RelFileNumbers are now assigned using a separate counter, instead of being assigned from the OID counter. This counter never wraps around: if all 2^56 possible RelFileNumbers are used, an internal error occurs. As the cluster is limited to 2^64 total bytes of WAL, this limitation should not cause a problem in practice. If the counter were 64 bits wide rather than 56 bits wide, we would need to increase the width of the BufferTag, which might adversely impact buffer lookup performance. Also, this lets us use bigint for pg_class.relfilenode and other places where these values are exposed at the SQL level without worrying about overflow. This should remove the need to keep "tombstone" files around until the next checkpoint when relations are removed. We do that to keep RelFileNumbers from being recycled, but now that won't happen anyway. However, this patch doesn't actually change anything in this area; it just makes it possible for a future patch to do so. Dilip Kumar, based on an idea from Andres Freund, who also reviewed some earlier versions of the patch. Further review and some wordsmithing by me. Also reviewed at various points by Ashutosh Sharma, Vignesh C, Amul Sul, Álvaro Herrera, and Tom Lane. Discussion: http://postgr.es/m/CA+Tgmobp7+7kmi4gkq7Y+4AM9fTvL+O1oQ4-5gFTT+6Ng-dQ=g@mail.gmail.com
* Use has_privs_for_roles for predefined role checksJoe Conway2022-03-281-1/+1
| | | | | | | | | | | | | | Generally if a role is granted membership to another role with NOINHERIT they must use SET ROLE to access the privileges of that role, however with predefined roles the membership and privilege is conflated. Fix that by replacing is_member_of_role with has_privs_for_role for predefined roles. Patch does not remove is_member_of_role from acl.h, but it does add a warning not to use that function for privilege checking. Not backpatched based on hackers list discussion. Author: Joshua Brindle Reviewed-by: Stephen Frost, Nathan Bossart, Joe Conway Discussion: https://postgr.es/m/flat/CAGB+Vh4Zv_TvKt2tv3QNS6tUM_F_9icmuj0zjywwcgVi4PAhFA@mail.gmail.com
* Doc: improve libpq service-file docs, avoid overspecifying pathnames.Tom Lane2021-05-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | Clarify libpq.sgml's description of service file locations and semantics. Avoid use of backtick'ed pg_config calls to describe paths; that doesn't work on Windows, and even on Unix it's an idiom that not all readers may be instantly familiar with. Don't overspecify the locations of include files, instead writing only as much as you'd use in #include directives. The previous text in these places was incorrect for some installations, depending on where "postgresql" is in the install path. Our convention for referencing the user's home directory seems to be "~", so change the one place that spelled it "$HOME". install-windows.sgml follows the platform convention of spelling file paths with "\", so change the one place that used "/". Haiying Tang and Tom Lane Discussion: https://postgr.es/m/162149020918.26174.7150424047314144297@wrigleys.postgresql.org
* Doc: reformat catalog/view description tables.Tom Lane2020-05-131-45/+66
| | | | | | | | | | | This changes our catalog and view descriptions to use a style inspired by the new format for function/operator tables: each table entry is formatted roughly like a <varlistentry>, with the column name and type on the first line and then an indented description. This provides much more room for expansive descriptions than we had before, and thereby eliminates a passel of PDF build warnings. Discussion: https://postgr.es/m/12984.1588643549@sss.pgh.pa.us
* Fix inconsistency in pg_buffercache docs.Amit Kapila2020-05-081-6/+5
| | | | | | | | | | | Commit 6e654546fb avoids locking bufmgr partitions to make pg_buffercache less disruptive on production systems but forgot to update the docs. Reported-by: Sawada Masahiko Author: Sawada Masahiko Reviewed-by: Amit Kapila Backpatch-through: 10 Discussion: https://postgr.es/m/CA+fd4k6sD8oeP1qJbFAor=rCpYckU9DsywHiYx3x5Hz5Z8Ua_w@mail.gmail.com
* doc: remove unnecessary INNER keywordBruce Momjian2020-04-021-1/+1
| | | | | | | | | | | | A join that was added in commit 9b2009c4cf that did not use the INNER keyword but the existing query used it. It was cleaner to remove the existing INNER keyword. Reported-by: Peter Eisentraut Discussion: https://postgr.es/m/a1ffbfda-59d2-5732-e5fb-3df8582b6434@2ndquadrant.com Backpatch-through: 9.5
* doc: add namespace column to pg_buffercache example queryBruce Momjian2020-03-311-15/+16
| | | | | | | | | | Without the namespace, the table name could be ambiguous. Reported-by: adunham@arbormetrix.com Discussion: https://postgr.es/m/158155175140.23798.2189464781144503491@wrigleys.postgresql.org Backpatch-through: 9.5
* Doc: correct thinko in pg_buffercache documentation.Tom Lane2020-02-281-2/+2
| | | | | | | | | | | Access to this module is granted to the pg_monitor role, not pg_read_all_stats. (Given the view's performance impact, it seems wise to be restrictive, so I think this was the correct decision --- and anyway it was clearly intentional.) Per bug #16279 from Philip Semanchuk. Discussion: https://postgr.es/m/16279-fcaac33c68aab0ab@postgresql.org
* Convert documentation to DocBook XMLPeter Eisentraut2017-11-231-1/+1
| | | | | | | | | | | | | | | | | | Since some preparation work had already been done, the only source changes left were changing empty-element tags like <xref linkend="foo"> to <xref linkend="foo"/>, and changing the DOCTYPE. The source files are still named *.sgml, but they are actually XML files now. Renaming could be considered later. In the build system, the intermediate step to convert from SGML to XML is removed. Everything is build straight from the source files again. The OpenSP (or the old SP) package is no longer needed. The documentation toolchain instructions are updated and are much simpler now. Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
* Don't use SGML empty tagsPeter Eisentraut2017-10-171-8/+8
| | | | | | | | For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
* Default monitoring rolesSimon Riggs2017-03-301-2/+3
| | | | | | | | | | | | Three nologin roles with non-overlapping privs are created by default * pg_read_all_settings - read all GUCs. * pg_read_all_stats - pg_stat_*, pg_database_size(), pg_tablespace_size() * pg_stat_scan_tables - may lock/scan tables Top level role - pg_monitor includes all of the above by default, plus others Author: Dave Page Reviewed-by: Stephen Frost, Robert Haas, Peter Eisentraut, Simon Riggs
* Fix obsolete header-file reference in pg_buffercache docs.Tom Lane2016-07-131-1/+1
| | | | | | | Commit 2d0019049 moved enum ForkNumber from relfilenode.h into relpath.h, but missed updating this documentation reference. Alexander Law
* Add pinning_backends column to the pg_buffercache extension.Andres Freund2014-08-221-0/+7
| | | | | | | | | | | The new column shows how many backends have a buffer pinned. That can be useful during development or to diagnose production issues e.g. caused by vacuum waiting for cleanup locks. To handle upgrades transparently - the extension might be used in views - deal with callers expecting the old number of columns. Reviewed by Fujii Masao and Rajeev rastogi.
* pg_buffercache docs: adjust order of fieldsBruce Momjian2013-11-271-7/+7
| | | | | | Adjust order of fields to match view order. Jaime Casanova
* Add contrib function references in the doc indexBruce Momjian2013-07-041-0/+4
| | | | | Backpatch to 9.3. Idea from Craig Ringer
* pg_buffercache: document column meaningsBruce Momjian2013-07-031-2/+3
| | | | | | Improve documentation for usagecount and relforknumber. Backpatch to 9.3. Suggestion from Satoshi Nagayasu
* Add xreflabels to /contrib manuals so links appear correct. Also updateBruce Momjian2011-05-071-1/+1
| | | | README.links to explain xref properly.
* Properly capitalize documentation headings; some only had initial-wordBruce Momjian2011-01-291-2/+2
| | | | capitalization.
* Remove cvs keywords from all files.Magnus Hagander2010-09-201-1/+1
|
* Fix indentation of verbatim block elementsPeter Eisentraut2010-07-291-24/+25
| | | | | | | | | | Block elements with verbatim formatting (literallayout, programlisting, screen, synopsis) should be aligned at column 0 independent of the surrounding SGML, because whitespace is significant, and indenting them creates erratic whitespace in the output. The CSS stylesheets already take care of indenting the output. Assorted markup improvements to go along with it.
* Create a "relation mapping" infrastructure to support changing the relfilenodesTom Lane2010-02-071-3/+3
| | | | | | | | | | | | | | | | | | | | | | | of shared or nailed system catalogs. This has two key benefits: * The new CLUSTER-based VACUUM FULL can be applied safely to all catalogs. * We no longer have to use an unsafe reindex-in-place approach for reindexing shared catalogs. CLUSTER on nailed catalogs now works too, although I left it disabled on shared catalogs because the resulting pg_index.indisclustered update would only be visible in one database. Since reindexing shared system catalogs is now fully transactional and crash-safe, the former special cases in REINDEX behavior have been removed; shared catalogs are treated the same as non-shared. This commit does not do anything about the recently-discussed problem of deadlocks between VACUUM FULL/CLUSTER on a system catalog and other concurrent queries; will address that in a separate patch. As a stopgap, parallel_schedule has been tweaked to run vacuum.sql by itself, to avoid such failures during the regression tests.
* Refer to tables by id, not by "the following table", because tables are inPeter Eisentraut2009-05-181-3/+3
| | | | theory floating elements.
* Proofreading adjustments for first two parts of documentation (TutorialBruce Momjian2009-04-271-2/+3
| | | | and SQL).
* pg_buffercache needs to be taught about relation forks, as Greg StarkHeikki Linnakangas2008-08-141-1/+8
| | | | pointed out.
* Make an editorial pass over the newly SGML-ified contrib documentation.Tom Lane2007-12-101-66/+116
| | | | | | Fix lots of bad markup, bad English, bad explanations. Second round of commits. pgcrypto and pgstandby still to go...
* Ensure that all <sect1> and <refentry> tags have IDs. This is neededTom Lane2007-12-021-0/+120
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.