varbit() — PostgreSQL bit-string function

varbit(): adjust varbit() to typmod length. PostgreSQL bit string functions — signature, volatility, version applicability and an illustrative example.

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

Summary

varbit is a PostgreSQL built-in function in the Bit String Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “adjust varbit() to typmod length”.

Signature

varbit(varbit, integer, boolean) → varbit

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: Bit String 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: varbit

Example

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

SELECT varbit(B'101', 42, true);

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

varbit 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 — Bit String Functions.