zam6ak
zam6ak

Reputation: 7259

PostgreSQL - Function that returns labels of any ENUM

I am trying to write a "generic" function that will return labels of any enum (in any schema)... But I am not having much luck because I am not sure what should argument type be...

The goal would be to be able to call function like this

SELECT common.get_enum_labels('public.rainbow_colors');
SELECT common.get_enum_labels('audit.user_actions');

This is what I have so

CREATE OR REPLACE FUNCTION common.get_enum_labels(enum_name regtype)
RETURNS SETOF text AS
$$
BEGIN
  EXECUTE format('SELECT unnest(enum_range(NULL::%s))::text AS enum_labels ORDER BY 1', enum_name);
END;
$$
LANGUAGE plpgsql
STABLE
PARALLEL SAFE
;

Any tips would be appreciated

Upvotes: 1

Views: 934

Answers (2)

Abelisto
Abelisto

Reputation: 15614

create or replace function get_enum_labels(enum_name regtype)
  returns setof text language sql stable 
as $$
  select enumlabel::text
  from pg_enum
  where enumtypid = enum_name
  order by enumsortorder
$$;

Upvotes: 1

klin
klin

Reputation: 121594

The argument type should be regtype, do not forget to return something from the function

CREATE OR REPLACE FUNCTION get_enum_labels(enum_name regtype)
RETURNS SETOF text AS
$$
BEGIN
    RETURN QUERY
        EXECUTE format('SELECT unnest(enum_range(NULL::%s))::text ORDER BY 1', enum_name);
END;
$$
LANGUAGE plpgsql

Upvotes: 2

Related Questions