setweight() — PostgreSQL full-text-search function

setweight(): set given weight for whole tsvector. PostgreSQL full text search functions — signature, volatility, version applicability and an illustrative example.

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

Summary

setweight is a PostgreSQL built-in function in the Full Text Search Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “set given weight for whole tsvector”.

Signature

setweight has 2 documented overloaded forms:

setweight(tsvector, char) → tsvector
setweight(tsvector, char, text[]) → tsvector

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: Full Text Search Functions
  • Kind: Function
  • Volatility: IMMUTABLE — Marked IMMUTABLE — it always returns the same result for the same arguments and can be used in indexes and other contexts that require immutability.
  • Returns: tsvector

Example

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

SELECT setweight(to_tsvector('a fat cat'), 'a');

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

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

Related & references

Reference: PostgreSQL documentation — Full Text Search Functions.