This site is providing helpful shortcuts to PostgreSQL documentation. It has set of keywords that were extracted from documentation, so that when you search for known keyword - you will get redirected directly to appropriate page or even part of page of documentation.
If what you'll provide is not found, then site will look for keyword searching by prefix. If this will also not find anything - you will be redirected to PostgreSQL search.
In case there are multiple found keywords (which can happen, for example, with prefix searching) you will be shown list of keywords that will lead you directly to relevant documentation.
pgdoc.link extracts keywords matching these types:
- app - name of application/program being part of normal pg distribution
- command - sql command
- config - name of configuration parameter
- contrib - name of contrib module
- function - name of function available by default
- system_catalog - name of table/view that contains system information
To handle searches better, if any command or contrib module name that starts with pg is indexed also with pg_ and pg- prefixes, so you can search for pgdump , pg_dump , or pg-dump , and they all will work correctly.
All searches can be provided in url, like:
Usage via examples: what you can search for, using what syntax:
- shared_buffers
- Documentation for shared_buffers config parameter in “current” (17) version
- 13/shared_buffe
- Documentation for shared_buffers (prefix matching) config parameter in version 13
- jit@14
- Documentation for jit config parameter (prefix matching knows more jit* variables, but this one matches perfectly) in version 14
- jit*
- List of all known keywords that start with jit for “current” (17) version
- pg_dump@11
- Manual for pg_dump program in version 11
- 12/pgdump
- Manual for pg_dump program in version 12
- pg-dump
- Manual for pg_dump program in “current” (17) version
- *xact*age*
- Looks for any keywords that contain xact, and (later) age.