pg_ls_dir() — PostgreSQL system administration function

pg_ls_dir(): list all files in a directory. PostgreSQL system administration functions — signature, volatility, version applicability and an illustrative example.

The Sev-1 Admin
The Sev-1 Admin  ·  2 min read

Summary

pg_ls_dir is a PostgreSQL built-in function in the System Administration Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “list all files in a directory”.

Signature

pg_ls_dir has 2 documented overloaded forms:

pg_ls_dir(text) → setof text
pg_ls_dir(text, boolean, boolean) → setof text

Argument and return types are taken from the pg_proc catalog; internal type names are shown using their readable SQL spellings (for example int4 is shown as integer). (Derived from the catalog — see the linked reference for the canonical documentation.)

Classification

  • Category: System Administration Functions
  • Kind: Function
  • Volatility: VOLATILE — Marked VOLATILE — its result can change even within a single statement (for example, it may depend on time, sequences or the current session).
  • Returns: text (set-returning)

Example

Illustrative form (replace placeholder values with your own data):

SELECT * FROM pg_ls_dir('abc');

The example above is illustrative and is meant to show calling syntax only; consult the linked PostgreSQL documentation for exact semantics, edge cases and accepted argument combinations.

Version applicability

pg_ls_dir is present across the surveyed releases (PostgreSQL 15, 16, 17, 18). On older major versions, behaviour may differ in detail — always check the documentation for the version you run.

Related & references

Reference: PostgreSQL documentation — System Administration Functions.