Firefox and PostgreSQL Documentation Search
The Firefox web browser supports several search engines, extensions by means of which you can insert a search string and get it passed to a specific site for search.It is possible to customize Firefox to search for a particular string within the PostgreSQL official documentation: the idea is to instrument the web browser to redirect the searching for thru the PostgreSQL web site via a
GET
URL.
In order to achieve this, you need to install a customizable search engine, and then configure the shortcuts for enabling the web engine access.
Custom Search Engine Setup
The first step consists of installing the Custom Search Engine to your Firefox web browser.Then, clicking on the main Firefox menu (the hamburger icon), select the Add-ons entry and then go to the extensions menu: you should see the new searching engine there. Check the engine is active and then click on the three dots button and select Preferences:
In the opened screen, edit a line to add the following details:
- key, I use
pg
as the default prefix to indicate I’m going to specify a PostgreSQL documentation search; - Search Engine Name, set to
PostgreSQL
or any name it makes sense to you; - URL, you have to set it to
https://www.postgresql.org/search/?q={searchTerms}
, where{searchTerms}
is going to be replaced by firefox with the searching keywords; - Description, whatever it makes sense to you, for example
PostgreSQL Official Documentation
.
As you can imagine, the important parts are the key and the URL. Note that you can also add specific PostgreSQL versions by changing the URL to include a version number, do a few searches on the official web site and inspect the URL for other arguments.
Once you have done, click on the button Save Preferences and then close the tab.
Searching into the documentation
With the engine in place, you can search within the PostgreSQL documentation by means of inserting:ms
to activate the custom search engine;pg
to activate the PostgreSQL documentation search engine (this is the key specified above);- any keyword you need to search into the documentation.
As an example, imagine we want to search for theCREATE INDEX
statement documentation; we need to enter:
ms pg create index
and pressing
enter
the search will go thru the PostgreSQL documentation web site: