Thread: Returning NULL to a set returning C type function

Returning NULL to a set returning C type function

From
Bborie Park
Date:
I have a C type function that returns a set of a type.  The problem I
have is that the underlying function may return NULL.  When the
underlying function returns NULL, I get the error message:

ERROR:  function returning set of rows cannot return null value

I'm wondering what is the proper way to correct this problem?  Or is
there are correct workaround?

So, for my sample code:

CREATE TYPE histogram AS (
    min double precision,
    max double precision,
    count integer,
    proportion double precision
);

CREATE OR REPLACE FUNCTION _st_histogram(rast raster, nband int,
hasnodata boolean, sample_percent double precision, bins int, width
double precision[], right boolean)
    RETURNS SETOF histogram
    AS '$libdir/rtpostgis-2.0','RASTER_histogram'
    LANGUAGE 'C' IMMUTABLE STRICT;

PG_FUNCTION_INFO_V1(RASTER_histogram);
Datum RASTER_histogram(PG_FUNCTION_ARGS)
{
    -- if any of the args are incorrect, return NULL
    PG_RETURN_NULL();
}

Thanks,
Bborie

--
Bborie Park
Programmer
Center for Vectorborne Diseases
UC Davis
530-752-8380
bkpark@ucdavis.edu

Re: Returning NULL to a set returning C type function

From
Tom Lane
Date:
Bborie Park <bkpark@ucdavis.edu> writes:
> I have a C type function that returns a set of a type.  The problem I
> have is that the underlying function may return NULL.  When the
> underlying function returns NULL, I get the error message:

> ERROR:  function returning set of rows cannot return null value

> I'm wondering what is the proper way to correct this problem?

Don't do that ;-).  You could choose either to not return any row
at all when this happens, or to construct an all-nulls row to return.
ExecMakeTableFunctionResult doesn't want to guess which behavior is
appropriate for your use-case, so it just complains.

            regards, tom lane

Re: Returning NULL to a set returning C type function

From
Bborie Park
Date:
> Don't do that ;-).  You could choose either to not return any row
> at all when this happens, or to construct an all-nulls row to return.
> ExecMakeTableFunctionResult doesn't want to guess which behavior is
> appropriate for your use-case, so it just complains.
>
>             regards, tom lane
>

Thanks Tom.  I'll go the "no return any row" route.

--
Bborie Park
Programmer
Center for Vectorborne Diseases
UC Davis
530-752-8380
bkpark@ucdavis.edu