doc: Add example for how to set file_fdw column option

danielgustafsson · pull[bot] · commit 9de4a11a1d68 · 2024-03-08T00:33:49.000Z
The documentation is pretty light on how to set column options on foreign tables, and the file_fdw docs refer to COPY when documenting force_null even though it's not used in the same way. Add a small example to describe how to use it. Reported-by: Boshomi Phenix <boshomi@gmail.com> Discussion: https://postgr.es/m/CAJVkCUparn4_Oarernm=U6LWVsTkecKcALHtwGr5M3qJRj_czw@mail.gmail.com
diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml
@@ -279,4 +279,20 @@ OPTIONS ( filename 'log/pglog.csv', format 'csv' );
   </para>
  </example>
 
+ <example>
+  <title>Create a Foreign Table with an option on a column</title>
+  <para>
+   To set the <literal>force_null</literal> option for a column, use the
+   <literal>OPTIONS</literal> keyword.
+  </para>
+<programlisting>
+CREATE FOREIGN TABLE films (
+ code char(5) NOT NULL,
+ title text NOT NULL,
+ rating text OPTIONS (force_null 'true')
+) SERVER film_server
+OPTIONS ( filename 'films/db.csv', format 'csv' );
+</programlisting>
+ </example>
+
 </sect1>
