How to Read Postgres Docs

- 4 minutes read - 843 words

Have you ever tried to read the documentation for a Postgres command? Although many consider Postgres’ docs best-in-class, they include conventions that might challenge newbies. In this post, I’ll paraphrase Postgres’ conventions page to help us understand what the documentation for a command is saying.

To check the syntax of a command, I start with psql, the REPL, or ‘Read-Evaluate-Print-Loop’, of Postgres. I query using \help , and get output like this for update:

j C D S [ U U a o e y P R k m s n W D L e m c t I A : s a r a T T S [ [ [ _ n i x H E E h d d p : T F W R t b : t [ [ R H E t = i { } O E T p # o R O M R U s n E N c ( ( [ E R : \ : C L o , f N / h U Y l c c r c I / e U u R u o o o o N w l P p S ] m l l m n G w p D d I n u u . _ d w A a V t _ m m ] i i . u T t E a n n n t t p p E e b a _ _ e i o d ] l m n n m o s a r e e a a n o t t o w _ m m [ u g e w i n = e e , | t r s t a p e h m { [ [ W u s o _ e , , H t q f q e . E _ l u [ x ] R e . a e p E x o r r . . ] p r t y e ] ] C r g a ] s U e / b [ s ) ) R s d l , [ i R s o e o = = E i c [ n N o s [ ( T n / . A | 1 ] S R s O [ 4 D O u F / ] ] E W b [ s F - c q a A ] S u A l l U E r S - i L ( L s u a T E o ] p s { C r d } T _ o a ] e n u t | x ) a t e p m p . r e u h e t t s ] _ m s n l i a o m n e | ] D [ E , F A U L . T ] } ] [ , . ] )

I recommend reading docs in the REPL when you can. irb for Ruby, node or the DevTools console for JavaScript, etc. With history enabled, you’ll get a searchable record of the pages you’ve read, and you can guarantee you’re reading the docs for your version of the software.

Let’s read through this REPL output. We receive the following pieces of information:

  • Command
  • Description
  • Syntax
  • URL

Command is the thing I searched for. SQL convention presents tokens in capitalized format, so that’s why I asked for help about update and Postgres gave me help about UPDATE. That format is optional.

Next we have our description: “update rows of a table”.

Into the heart of the page, the syntax. For this, we’ll need to familiarize ourselves with Postgres’ conventions. These include:

  • Brackets ([ and ]): optional parts.
  • Braces ({ and }) and vertical lines (|): choose one.
  • Dots (...): the preceding element can be repeated.
  • All other symbols, including parentheses: taken literally.

I’ve found that these syntax guides are helpful if you read through them slowly aloud. Here’s how I’d do that for the UPDATE page:

“With UPDATE, I can optionally start with a recursive WITH statement. Then I’m into my statement, which I apply to a table using table_name. Next, I can SET my new value in several ways. I can use FROM to include columns from other tables. Then, I can limit what I update using WHERE. Finally, I can use RETURNING to select from what I return.”

With this knowledge, I can build my query:

=> update films set kind = 'dramatic' where kind = 'drama';

Most of the time, you’ll be using just a few of these tokens.

You can click on the included URL to visit the online docs page, where each token is described in detail. I think Postgres’ docs are some of the best around, so the answers are there if you keep looking.

These pages are approachable with patience and curiosity. SQL is a quirky language and competence takes time. Learning to read these docs is a great first step.