database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-21 12:05:57 +03:00
Code

Refactor crosstab() to build and return a tuplestore instead of using

Browse Source 
value-per-call mode.  This should be more efficient in normal usage,
but the real problem with the prior coding was that it returned with
a SPI call still active.  That could cause problems if execution was
interleaved with anything else that might use SPI.
This commit is contained in:
Tom Lane 2008-12-01 01:30:18 +00:00
parent 76cc2fe6a1
commit cf407f164e
1 changed files with 208 additions and 260 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

468
contrib/tablefunc/tablefunc.c
View File

@ -1,5 +1,5 @@
/* /*
* $PostgreSQL: pgsql/contrib/tablefunc/tablefunc.c,v 1.56 2008/11/30 23:23:52 tgl Exp $ * $PostgreSQL: pgsql/contrib/tablefunc/tablefunc.c,v 1.57 2008/12/01 01:30:18 tgl Exp $
* *
* *
* tablefunc * tablefunc
@ -94,12 +94,6 @@ typedef struct
bool use_carry; /* use second generated value */ bool use_carry; /* use second generated value */
} normal_rand_fctx; } normal_rand_fctx;
typedef struct
{
SPITupleTable *spi_tuptable; /* sql results from user query */
char *lastrowid; /* rowid of the last tuple sent */
} crosstab_fctx;
#define xpfree(var_) \ #define xpfree(var_) \
do { \ do { \
if (var_ != NULL) \ if (var_ != NULL) \
@ -356,304 +350,254 @@ PG_FUNCTION_INFO_V1(crosstab);
Datum Datum
crosstab(PG_FUNCTION_ARGS) crosstab(PG_FUNCTION_ARGS)
{ {
FuncCallContext *funcctx; char *sql = text_to_cstring(PG_GETARG_TEXT_PP(0));
TupleDesc ret_tupdesc; ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
Tuplestorestate *tupstore;
TupleDesc tupdesc;
int call_cntr; int call_cntr;
int max_calls; int max_calls;
AttInMetadata *attinmeta; AttInMetadata *attinmeta;
SPITupleTable *spi_tuptable = NULL; SPITupleTable *spi_tuptable;
TupleDesc spi_tupdesc; TupleDesc spi_tupdesc;
char *lastrowid = NULL; bool firstpass;
crosstab_fctx *fctx; char *lastrowid;
int i; int i;
int num_categories; int num_categories;
bool firstpass = false; MemoryContext per_query_ctx;
MemoryContext oldcontext; MemoryContext oldcontext;
int ret;
int proc;
/* stuff done only on the first call of the function */ /* check to see if caller supports us returning a tuplestore */
if (SRF_IS_FIRSTCALL()) if (rsinfo == NULL || !IsA(rsinfo, ReturnSetInfo))
ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("set-valued function called in context that cannot accept a set")));
if (!(rsinfo->allowedModes & SFRM_Materialize))
ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("materialize mode required, but it is not " \
"allowed in this context")));
per_query_ctx = rsinfo->econtext->ecxt_per_query_memory;
/* Connect to SPI manager */
if ((ret = SPI_connect()) < 0)
/* internal error */
elog(ERROR, "crosstab: SPI_connect returned %d", ret);
/* Retrieve the desired rows */
ret = SPI_execute(sql, true, 0);
proc = SPI_processed;
/* If no qualifying tuples, fall out early */
if (ret != SPI_OK_SELECT || proc <= 0)
{ {
char *sql = text_to_cstring(PG_GETARG_TEXT_PP(0)); SPI_finish();
TupleDesc tupdesc; rsinfo->isDone = ExprEndResult;
int ret; PG_RETURN_NULL();
int proc;
/* create a function context for cross-call persistence */
funcctx = SRF_FIRSTCALL_INIT();
/* Connect to SPI manager */
if ((ret = SPI_connect()) < 0)
/* internal error */
elog(ERROR, "crosstab: SPI_connect returned %d", ret);
/* Retrieve the desired rows */
ret = SPI_execute(sql, true, 0);
proc = SPI_processed;
/* Check for qualifying tuples */
if ((ret == SPI_OK_SELECT) && (proc > 0))
{
spi_tuptable = SPI_tuptable;
spi_tupdesc = spi_tuptable->tupdesc;
/*----------
* The provided SQL query must always return three columns.
*
* 1. rowname
* the label or identifier for each row in the final result
* 2. category
* the label or identifier for each column in the final result
* 3. values
* the value for each column in the final result
*----------
*/
if (spi_tupdesc->natts != 3)
ereport(ERROR,
(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("invalid source data SQL statement"),
errdetail("The provided SQL must return 3 "
"columns: rowid, category, and values.")));
}
else
{
/* no qualifying tuples */
SPI_finish();
SRF_RETURN_DONE(funcctx);
}
/* get a tuple descriptor for our result type */
switch (get_call_result_type(fcinfo, NULL, &tupdesc))
{
case TYPEFUNC_COMPOSITE:
/* success */
break;
case TYPEFUNC_RECORD:
/* failed to determine actual type of RECORD */
ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("function returning record called in context "
"that cannot accept type record")));
break;
default:
/* result type isn't composite */
elog(ERROR, "return type must be a row type");
break;
}
/*
* Check that return tupdesc is compatible with the data we got from
* SPI, at least based on number and type of attributes
*/
if (!compatCrosstabTupleDescs(tupdesc, spi_tupdesc))
ereport(ERROR,
(errcode(ERRCODE_SYNTAX_ERROR),
errmsg("return and sql tuple descriptions are " \
"incompatible")));
/*
* switch to memory context appropriate for multiple function calls
*/
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
/* make sure we have a persistent copy of the tupdesc */
tupdesc = CreateTupleDescCopy(tupdesc);
/*
* Generate attribute metadata needed later to produce tuples from raw
* C strings
*/
attinmeta = TupleDescGetAttInMetadata(tupdesc);
funcctx->attinmeta = attinmeta;
/* allocate memory for user context */
fctx = (crosstab_fctx *) palloc(sizeof(crosstab_fctx));
/*
* Save spi data for use across calls
*/
fctx->spi_tuptable = spi_tuptable;
fctx->lastrowid = NULL;
funcctx->user_fctx = fctx;
/* total number of tuples to be returned */
funcctx->max_calls = proc;
MemoryContextSwitchTo(oldcontext);
firstpass = true;
} }
/* stuff done on every call of the function */ spi_tuptable = SPI_tuptable;
funcctx = SRF_PERCALL_SETUP();
/*
* initialize per-call variables
*/
call_cntr = funcctx->call_cntr;
max_calls = funcctx->max_calls;
/* user context info */
fctx = (crosstab_fctx *) funcctx->user_fctx;
lastrowid = fctx->lastrowid;
spi_tuptable = fctx->spi_tuptable;
/* the sql tuple */
spi_tupdesc = spi_tuptable->tupdesc; spi_tupdesc = spi_tuptable->tupdesc;
/* attribute return type and return tuple description */ /*----------
attinmeta = funcctx->attinmeta; * The provided SQL query must always return three columns.
ret_tupdesc = attinmeta->tupdesc; *
* 1. rowname
* the label or identifier for each row in the final result
* 2. category
* the label or identifier for each column in the final result
* 3. values
* the value for each column in the final result
*----------
*/
if (spi_tupdesc->natts != 3)
ereport(ERROR,
(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
errmsg("invalid source data SQL statement"),
errdetail("The provided SQL must return 3 "
"columns: rowid, category, and values.")));
/* get a tuple descriptor for our result type */
switch (get_call_result_type(fcinfo, NULL, &tupdesc))
{
case TYPEFUNC_COMPOSITE:
/* success */
break;
case TYPEFUNC_RECORD:
/* failed to determine actual type of RECORD */
ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("function returning record called in context "
"that cannot accept type record")));
break;
default:
/* result type isn't composite */
elog(ERROR, "return type must be a row type");
break;
}
/*
* Check that return tupdesc is compatible with the data we got from
* SPI, at least based on number and type of attributes
*/
if (!compatCrosstabTupleDescs(tupdesc, spi_tupdesc))
ereport(ERROR,
(errcode(ERRCODE_SYNTAX_ERROR),
errmsg("return and sql tuple descriptions are " \
"incompatible")));
/*
* switch to long-lived memory context
*/
oldcontext = MemoryContextSwitchTo(per_query_ctx);
/* make sure we have a persistent copy of the result tupdesc */
tupdesc = CreateTupleDescCopy(tupdesc);
/* initialize our tuplestore in long-lived context */
tupstore =
tuplestore_begin_heap(rsinfo->allowedModes & SFRM_Materialize_Random,
false, work_mem);
MemoryContextSwitchTo(oldcontext);
/*
* Generate attribute metadata needed later to produce tuples from raw
* C strings
*/
attinmeta = TupleDescGetAttInMetadata(tupdesc);
/* total number of tuples to be examined */
max_calls = proc;
/* the return tuple always must have 1 rowid + num_categories columns */ /* the return tuple always must have 1 rowid + num_categories columns */
num_categories = ret_tupdesc->natts - 1; num_categories = tupdesc->natts - 1;
if (call_cntr < max_calls) /* do when there is more left to send */ firstpass = true;
lastrowid = NULL;
for (call_cntr = 0; call_cntr < max_calls; call_cntr++)
{ {
HeapTuple tuple;
Datum result;
char **values;
bool skip_tuple = false; bool skip_tuple = false;
char **values;
while (true) /* allocate and zero space */
values = (char **) palloc0((1 + num_categories) * sizeof(char *));
/*
* now loop through the sql results and assign each value in
* sequence to the next category
*/
for (i = 0; i < num_categories; i++)
{ {
/* allocate space */ HeapTuple spi_tuple;
values = (char **) palloc((1 + num_categories) * sizeof(char *)); char *rowid;
/* and make sure it's clear */ /* see if we've gone too far already */
memset(values, '\0', (1 + num_categories) * sizeof(char *)); if (call_cntr >= max_calls)
break;
/* get the next sql result tuple */
spi_tuple = spi_tuptable->vals[call_cntr];
/* get the rowid from the current sql result tuple */
rowid = SPI_getvalue(spi_tuple, spi_tupdesc, 1);
/* /*
* now loop through the sql results and assign each value in * If this is the first pass through the values for this
* sequence to the next category * rowid, set the first column to rowid
*/ */
for (i = 0; i < num_categories; i++) if (i == 0)
{ {
HeapTuple spi_tuple; xpstrdup(values[0], rowid);
char *rowid = NULL;
/* see if we've gone too far already */
if (call_cntr >= max_calls)
break;
/* get the next sql result tuple */
spi_tuple = spi_tuptable->vals[call_cntr];
/* get the rowid from the current sql result tuple */
rowid = SPI_getvalue(spi_tuple, spi_tupdesc, 1);
/* /*
* If this is the first pass through the values for this * Check to see if the rowid is the same as that of the
* rowid, set the first column to rowid * last tuple sent -- if so, skip this tuple entirely
*/ */
if (i == 0) if (!firstpass && xstreq(lastrowid, rowid))
{ {
xpstrdup(values[0], rowid); xpfree(rowid);
skip_tuple = true;
/*
* Check to see if the rowid is the same as that of the
* last tuple sent -- if so, skip this tuple entirely
*/
if (!firstpass && xstreq(lastrowid, rowid))
{
skip_tuple = true;
break;
}
}
/*
* If rowid hasn't changed on us, continue building the ouput
* tuple.
*/
if (xstreq(rowid, values[0]))
{
/*
* Get the next category item value, which is always
* attribute number three.
*
* Be careful to assign the value to the array index based
* on which category we are presently processing.
*/
values[1 + i] = SPI_getvalue(spi_tuple, spi_tupdesc, 3);
/*
* increment the counter since we consume a row for each
* category, but not for last pass because the API will do
* that for us
*/
if (i < (num_categories - 1))
call_cntr = ++funcctx->call_cntr;
}
else
{
/*
* We'll fill in NULLs for the missing values, but we need
* to decrement the counter since this sql result row
* doesn't belong to the current output tuple.
*/
call_cntr = --funcctx->call_cntr;
break; break;
} }
xpfree(rowid);
} }
/* /*
* switch to memory context appropriate for multiple function * If rowid hasn't changed on us, continue building the output
* calls * tuple.
*/ */
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); if (xstreq(rowid, values[0]))
xpfree(fctx->lastrowid);
xpstrdup(fctx->lastrowid, values[0]);
lastrowid = fctx->lastrowid;
MemoryContextSwitchTo(oldcontext);
if (!skip_tuple)
{ {
/* build the tuple */ /*
tuple = BuildTupleFromCStrings(attinmeta, values); * Get the next category item value, which is always
* attribute number three.
*
* Be careful to assign the value to the array index based
* on which category we are presently processing.
*/
values[1 + i] = SPI_getvalue(spi_tuple, spi_tupdesc, 3);
/* make the tuple into a datum */ /*
result = HeapTupleGetDatum(tuple); * increment the counter since we consume a row for each
* category, but not for last pass because the outer loop
/* Clean up */ * will do that for us
for (i = 0; i < num_categories + 1; i++) */
if (values[i] != NULL) if (i < (num_categories - 1))
xpfree(values[i]); call_cntr++;
xpfree(values); xpfree(rowid);
SRF_RETURN_NEXT(funcctx, result);
} }
else else
{ {
/* /*
* Skipping this tuple entirely, but we need to advance the * We'll fill in NULLs for the missing values, but we need
* counter like the API would if we had returned one. * to decrement the counter since this sql result row
* doesn't belong to the current output tuple.
*/ */
call_cntr = ++funcctx->call_cntr; call_cntr--;
xpfree(rowid);
/* we'll start over at the top */ break;
xpfree(values);
/* see if we've gone too far already */
if (call_cntr >= max_calls)
{
/* release SPI related resources */
SPI_finish();
SRF_RETURN_DONE(funcctx);
}
/* need to reset this before the next tuple is started */
skip_tuple = false;
} }
} }
if (!skip_tuple)
{
HeapTuple tuple;
/* build the tuple */
tuple = BuildTupleFromCStrings(attinmeta, values);
/* switch to appropriate context while storing the tuple */
oldcontext = MemoryContextSwitchTo(per_query_ctx);
tuplestore_puttuple(tupstore, tuple);
MemoryContextSwitchTo(oldcontext);
heap_freetuple(tuple);
}
/* Remember current rowid */
xpfree(lastrowid);
xpstrdup(lastrowid, values[0]);
firstpass = false;
/* Clean up */
for (i = 0; i < num_categories + 1; i++)
if (values[i] != NULL)
pfree(values[i]);
pfree(values);
} }
else
/* do when there is no more left */ /* let the caller know we're sending back a tuplestore */
{ rsinfo->returnMode = SFRM_Materialize;
/* release SPI related resources */ rsinfo->setResult = tupstore;
SPI_finish(); rsinfo->setDesc = tupdesc;
SRF_RETURN_DONE(funcctx);
} /* release SPI related resources (and return to caller's context) */
SPI_finish();
return (Datum) 0;
} }
/* /*
@ -1613,6 +1557,10 @@ compatCrosstabTupleDescs(TupleDesc ret_tupdesc, TupleDesc sql_tupdesc)
Form_pg_attribute sql_attr; Form_pg_attribute sql_attr;
Oid sql_atttypid; Oid sql_atttypid;
if (ret_tupdesc->natts < 2 ||
sql_tupdesc->natts < 3)
return false;
/* check the rowid types match */ /* check the rowid types match */
ret_atttypid = ret_tupdesc->attrs[0]->atttypid; ret_atttypid = ret_tupdesc->attrs[0]->atttypid;
sql_atttypid = sql_tupdesc->attrs[0]->atttypid; sql_atttypid = sql_tupdesc->attrs[0]->atttypid;