array_sample() — PostgreSQL array function

array_sample(): take samples from array. PostgreSQL array functions — signature, volatility, version applicability and an illustrative example.

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

Summary

array_sample is a PostgreSQL built-in function in the Array Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “take samples from array”.

Signature

array_sample(anyarray, integer) → anyarray

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: Array 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: anyarray

Example

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

SELECT array_sample(ARRAY[1,2,3], 42);

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

Based on the catalog across releases, array_sample first appears in PostgreSQL 16. It is present in: 16, 17, 18, 19.

Related & references

Reference: PostgreSQL documentation — Array Functions.