15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 2001 September 15 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The author disclaims copyright to this source code. In place of 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** a legal notice, here is a blessing: 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** May you do good and not evil. 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** May you find forgiveness for yourself and forgive others. 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** May you share freely, never taking more than you give. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)************************************************************************* 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** This file contains the sqlite3_get_table() and sqlite3_free_table() 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** interface routines. These are just wrappers around the main 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** interface routine of sqlite3_exec(). 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** These routines are in a separate files so that they will not be linked 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** if they are not used. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sqliteInt.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdlib.h> 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string.h> 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef SQLITE_OMIT_GET_TABLE 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** This structure is used to pass data from sqlite3_get_table() through 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** to the callback function is uses to build the result. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct TabResult { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char **azResult; /* Accumulated output */ 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char *zErrMsg; /* Error message text, if an error occurs */ 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nAlloc; /* Slots allocated for azResult[] */ 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nRow; /* Number of rows in the result */ 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nColumn; /* Number of columns in the result */ 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nData; /* Slots used in azResult[]. (nRow+1)*nColumn */ 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int rc; /* Return code from sqlite3_exec() */ 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} TabResult; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** This routine is called once for each row in the result table. Its job 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** is to fill in the TabResult structure appropriately, allocating new 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** memory as necessary. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static int sqlite3_get_table_cb(void *pArg, int nCol, char **argv, char **colv){ 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TabResult *p = (TabResult*)pArg; /* Result accumulator */ 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int need; /* Slots needed in p->azResult[] */ 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int i; /* Loop counter */ 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char *z; /* A single column of result */ 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Make sure there is enough space in p->azResult to hold everything 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ** we need to remember from this invocation of the callback. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( p->nRow==0 && argv!=0 ){ 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) need = nCol*2; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }else{ 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) need = nCol; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( p->nData + need > p->nAlloc ){ 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char **azNew; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->nAlloc = p->nAlloc*2 + need; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) azNew = sqlite3_realloc( p->azResult, sizeof(char*)*p->nAlloc ); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( azNew==0 ) goto malloc_failed; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->azResult = azNew; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* If this is the first row, then generate an extra row containing 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ** the names of all columns. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( p->nRow==0 ){ 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->nColumn = nCol; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for(i=0; i<nCol; i++){ 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) z = sqlite3_mprintf("%s", colv[i]); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( z==0 ) goto malloc_failed; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->azResult[p->nData++] = z; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }else if( p->nColumn!=nCol ){ 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free(p->zErrMsg); 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->zErrMsg = sqlite3_mprintf( 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "sqlite3_get_table() called with two or more incompatible queries" 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->rc = SQLITE_ERROR; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 1; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Copy over the row data 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( argv!=0 ){ 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for(i=0; i<nCol; i++){ 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( argv[i]==0 ){ 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) z = 0; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }else{ 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int n = sqlite3Strlen30(argv[i])+1; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) z = sqlite3_malloc( n ); 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( z==0 ) goto malloc_failed; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) memcpy(z, argv[i], n); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->azResult[p->nData++] = z; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->nRow++; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)malloc_failed: 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) p->rc = SQLITE_NOMEM; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 1; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Query the database. But instead of invoking a callback for each row, 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** malloc() for space to hold the result and return the entire results 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** at the conclusion of the call. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** The result that is written to ***pazResult is held in memory obtained 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** from malloc(). But the caller cannot free this memory directly. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** Instead, the entire table should be passed to sqlite3_free_table() when 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** the calling procedure is finished using it. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int sqlite3_get_table( 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3 *db, /* The database on which the SQL executes */ 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char *zSql, /* The SQL to be executed */ 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char ***pazResult, /* Write the result table here */ 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *pnRow, /* Write the number of rows in the result here */ 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *pnColumn, /* Write the number of columns of result here */ 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char **pzErrMsg /* Write error messages here */ 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)){ 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int rc; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TabResult res; 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *pazResult = 0; 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pnColumn ) *pnColumn = 0; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pnRow ) *pnRow = 0; 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pzErrMsg ) *pzErrMsg = 0; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.zErrMsg = 0; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.nRow = 0; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.nColumn = 0; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.nData = 1; 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.nAlloc = 20; 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.rc = SQLITE_OK; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.azResult = sqlite3_malloc(sizeof(char*)*res.nAlloc ); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( res.azResult==0 ){ 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) db->errCode = SQLITE_NOMEM; 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return SQLITE_NOMEM; 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.azResult[0] = 0; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) rc = sqlite3_exec(db, zSql, sqlite3_get_table_cb, &res, pzErrMsg); 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert( sizeof(res.azResult[0])>= sizeof(res.nData) ); 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.azResult[0] = SQLITE_INT_TO_PTR(res.nData); 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( (rc&0xff)==SQLITE_ABORT ){ 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free_table(&res.azResult[1]); 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( res.zErrMsg ){ 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pzErrMsg ){ 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free(*pzErrMsg); 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *pzErrMsg = sqlite3_mprintf("%s",res.zErrMsg); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free(res.zErrMsg); 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) db->errCode = res.rc; /* Assume 32-bit assignment is atomic */ 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return res.rc; 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free(res.zErrMsg); 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( rc!=SQLITE_OK ){ 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free_table(&res.azResult[1]); 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return rc; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( res.nAlloc>res.nData ){ 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char **azNew; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) azNew = sqlite3_realloc( res.azResult, sizeof(char*)*res.nData ); 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( azNew==0 ){ 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free_table(&res.azResult[1]); 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) db->errCode = SQLITE_NOMEM; 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return SQLITE_NOMEM; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) res.azResult = azNew; 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *pazResult = &res.azResult[1]; 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pnColumn ) *pnColumn = res.nColumn; 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( pnRow ) *pnRow = res.nRow; 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return rc; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)** This routine frees the space the sqlite3_get_table() malloced. 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void sqlite3_free_table( 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char **azResult /* Result returned from from sqlite3_get_table() */ 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)){ 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if( azResult ){ 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int i, n; 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) azResult--; 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert( azResult!=0 ); 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) n = SQLITE_PTR_TO_INT(azResult[0]); 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for(i=1; i<n; i++){ if( azResult[i] ) sqlite3_free(azResult[i]); } 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sqlite3_free(azResult); 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* SQLITE_OMIT_GET_TABLE */ 198