blob: 3814b0355e29198adb60d8eb55b721b31e08626b [file] [log] [blame]
drhb9bb7c12006-06-11 23:41:55 +00001/*
2** 2006 June 10
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains code used to help implement virtual tables.
drhb9bb7c12006-06-11 23:41:55 +000013*/
14#ifndef SQLITE_OMIT_VIRTUALTABLE
15#include "sqliteInt.h"
16
drh63842412009-04-11 16:27:19 +000017/*
danb061d052011-04-25 18:49:57 +000018** Before a virtual table xCreate() or xConnect() method is invoked, the
19** sqlite3.pVtabCtx member variable is set to point to an instance of
20** this struct allocated on the stack. It is used by the implementation of
21** the sqlite3_declare_vtab() and sqlite3_vtab_config() APIs, both of which
22** are invoked only from within xCreate and xConnect methods.
23*/
24struct VtabCtx {
drh81028a42012-05-15 18:28:27 +000025 VTable *pVTable; /* The virtual table being constructed */
26 Table *pTab; /* The Table object to which the virtual table belongs */
dan75395cc2015-04-10 07:55:07 +000027 VtabCtx *pPrior; /* Parent context (if any) */
28 int bDeclared; /* True after sqlite3_declare_vtab() is called */
danb061d052011-04-25 18:49:57 +000029};
30
31/*
drh2fcc1592016-12-15 20:59:03 +000032** Construct and install a Module object for a virtual table. When this
33** routine is called, it is guaranteed that all appropriate locks are held
34** and the module is not already part of the connection.
drhcc5979d2019-08-16 22:58:29 +000035**
36** If there already exists a module with zName, replace it with the new one.
37** If pModule==0, then delete the module zName if it exists.
drh2fcc1592016-12-15 20:59:03 +000038*/
39Module *sqlite3VtabCreateModule(
40 sqlite3 *db, /* Database in which module is registered */
41 const char *zName, /* Name assigned to this module */
42 const sqlite3_module *pModule, /* The definition of the module */
43 void *pAux, /* Context pointer for xCreate/xConnect */
44 void (*xDestroy)(void *) /* Module destructor function */
45){
46 Module *pMod;
drhcc5979d2019-08-16 22:58:29 +000047 Module *pDel;
48 char *zCopy;
49 if( pModule==0 ){
50 zCopy = (char*)zName;
51 pMod = 0;
drh3ee14162017-10-02 13:20:43 +000052 }else{
drhcc5979d2019-08-16 22:58:29 +000053 int nName = sqlite3Strlen30(zName);
54 pMod = (Module *)sqlite3Malloc(sizeof(Module) + nName + 1);
55 if( pMod==0 ){
56 sqlite3OomFault(db);
57 return 0;
58 }
59 zCopy = (char *)(&pMod[1]);
drh2fcc1592016-12-15 20:59:03 +000060 memcpy(zCopy, zName, nName+1);
61 pMod->zName = zCopy;
62 pMod->pModule = pModule;
63 pMod->pAux = pAux;
64 pMod->xDestroy = xDestroy;
65 pMod->pEpoTab = 0;
drhcc5979d2019-08-16 22:58:29 +000066 pMod->nRefModule = 1;
67 }
68 pDel = (Module *)sqlite3HashInsert(&db->aModule,zCopy,(void*)pMod);
69 if( pDel ){
70 if( pDel==pMod ){
drh2fcc1592016-12-15 20:59:03 +000071 sqlite3OomFault(db);
72 sqlite3DbFree(db, pDel);
drh9a63f092016-12-16 02:14:15 +000073 pMod = 0;
drhcc5979d2019-08-16 22:58:29 +000074 }else{
drh87ca8062019-08-17 19:31:09 +000075 sqlite3VtabEponymousTableClear(db, pDel);
drhcc5979d2019-08-16 22:58:29 +000076 sqlite3VtabModuleUnref(db, pDel);
drh2fcc1592016-12-15 20:59:03 +000077 }
78 }
79 return pMod;
80}
81
82/*
drh63842412009-04-11 16:27:19 +000083** The actual function that does the work of creating a new module.
84** This function implements the sqlite3_create_module() and
85** sqlite3_create_module_v2() interfaces.
86*/
danielk1977832a58a2007-06-22 15:21:15 +000087static int createModule(
88 sqlite3 *db, /* Database in which module is registered */
89 const char *zName, /* Name assigned to this module */
90 const sqlite3_module *pModule, /* The definition of the module */
91 void *pAux, /* Context pointer for xCreate/xConnect */
92 void (*xDestroy)(void *) /* Module destructor function */
danielk1977595a5232009-07-24 17:58:53 +000093){
danca8b9ba2012-05-16 14:29:11 +000094 int rc = SQLITE_OK;
drh27641702007-08-22 02:56:42 +000095
96 sqlite3_mutex_enter(db->mutex);
drhcc5979d2019-08-16 22:58:29 +000097 (void)sqlite3VtabCreateModule(db, zName, pModule, pAux, xDestroy);
danca8b9ba2012-05-16 14:29:11 +000098 rc = sqlite3ApiExit(db, rc);
99 if( rc!=SQLITE_OK && xDestroy ) xDestroy(pAux);
drh27641702007-08-22 02:56:42 +0000100 sqlite3_mutex_leave(db->mutex);
101 return rc;
danielk1977832a58a2007-06-22 15:21:15 +0000102}
103
104
drhb9bb7c12006-06-11 23:41:55 +0000105/*
106** External API function used to create a new virtual-table module.
107*/
108int sqlite3_create_module(
109 sqlite3 *db, /* Database in which module is registered */
110 const char *zName, /* Name assigned to this module */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000111 const sqlite3_module *pModule, /* The definition of the module */
112 void *pAux /* Context pointer for xCreate/xConnect */
drhb9bb7c12006-06-11 23:41:55 +0000113){
drh9ca95732014-10-24 00:35:58 +0000114#ifdef SQLITE_ENABLE_API_ARMOR
115 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
116#endif
danielk1977832a58a2007-06-22 15:21:15 +0000117 return createModule(db, zName, pModule, pAux, 0);
118}
119
120/*
121** External API function used to create a new virtual-table module.
122*/
123int sqlite3_create_module_v2(
124 sqlite3 *db, /* Database in which module is registered */
125 const char *zName, /* Name assigned to this module */
126 const sqlite3_module *pModule, /* The definition of the module */
127 void *pAux, /* Context pointer for xCreate/xConnect */
128 void (*xDestroy)(void *) /* Module destructor function */
129){
drh9ca95732014-10-24 00:35:58 +0000130#ifdef SQLITE_ENABLE_API_ARMOR
131 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
132#endif
danielk1977832a58a2007-06-22 15:21:15 +0000133 return createModule(db, zName, pModule, pAux, xDestroy);
drhb9bb7c12006-06-11 23:41:55 +0000134}
135
drhb9bb7c12006-06-11 23:41:55 +0000136/*
drh5df84282019-08-17 19:45:25 +0000137** External API to drop all virtual-table modules, except those named
138** on the azNames list.
139*/
drh8c754a32019-08-19 20:35:30 +0000140int sqlite3_drop_modules(sqlite3 *db, const char** azNames){
drh5df84282019-08-17 19:45:25 +0000141 HashElem *pThis, *pNext;
142#ifdef SQLITE_ENABLE_API_ARMOR
mistachkin3722b3a2019-08-20 02:19:26 +0000143 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
drh5df84282019-08-17 19:45:25 +0000144#endif
145 for(pThis=sqliteHashFirst(&db->aModule); pThis; pThis=pNext){
146 Module *pMod = (Module*)sqliteHashData(pThis);
147 pNext = sqliteHashNext(pThis);
148 if( azNames ){
149 int ii;
150 for(ii=0; azNames[ii]!=0 && strcmp(azNames[ii],pMod->zName)!=0; ii++){}
151 if( azNames[ii]!=0 ) continue;
152 }
153 createModule(db, pMod->zName, 0, 0, 0);
154 }
155 return SQLITE_OK;
156}
157
158/*
drhcc5979d2019-08-16 22:58:29 +0000159** Decrement the reference count on a Module object. Destroy the
160** module when the reference count reaches zero.
161*/
162void sqlite3VtabModuleUnref(sqlite3 *db, Module *pMod){
163 assert( pMod->nRefModule>0 );
164 pMod->nRefModule--;
165 if( pMod->nRefModule==0 ){
166 if( pMod->xDestroy ){
167 pMod->xDestroy(pMod->pAux);
168 }
169 assert( pMod->pEpoTab==0 );
170 sqlite3DbFree(db, pMod);
171 }
172}
173
174/*
drh189d4af2006-09-02 20:57:52 +0000175** Lock the virtual table so that it cannot be disconnected.
176** Locks nest. Every lock should have a corresponding unlock.
177** If an unlock is omitted, resources leaks will occur.
178**
179** If a disconnect is attempted while a virtual table is locked,
180** the disconnect is deferred until all locks have been removed.
181*/
danielk1977595a5232009-07-24 17:58:53 +0000182void sqlite3VtabLock(VTable *pVTab){
183 pVTab->nRef++;
184}
185
186
187/*
188** pTab is a pointer to a Table structure representing a virtual-table.
189** Return a pointer to the VTable object used by connection db to access
190** this virtual-table, if one has been created, or NULL otherwise.
191*/
192VTable *sqlite3GetVTable(sqlite3 *db, Table *pTab){
193 VTable *pVtab;
194 assert( IsVirtual(pTab) );
drhf38524d2021-08-02 16:41:57 +0000195 for(pVtab=pTab->u.vtab.p; pVtab && pVtab->db!=db; pVtab=pVtab->pNext);
danielk1977595a5232009-07-24 17:58:53 +0000196 return pVtab;
drh189d4af2006-09-02 20:57:52 +0000197}
198
199/*
danielk1977595a5232009-07-24 17:58:53 +0000200** Decrement the ref-count on a virtual table object. When the ref-count
201** reaches zero, call the xDisconnect() method to delete the object.
drh189d4af2006-09-02 20:57:52 +0000202*/
danielk1977595a5232009-07-24 17:58:53 +0000203void sqlite3VtabUnlock(VTable *pVTab){
204 sqlite3 *db = pVTab->db;
205
206 assert( db );
207 assert( pVTab->nRef>0 );
drh5f9de6e2021-08-07 23:16:52 +0000208 assert( db->eOpenState==SQLITE_STATE_OPEN
209 || db->eOpenState==SQLITE_STATE_ZOMBIE );
danielk1977595a5232009-07-24 17:58:53 +0000210
211 pVTab->nRef--;
212 if( pVTab->nRef==0 ){
213 sqlite3_vtab *p = pVTab->pVtab;
drhcc5979d2019-08-16 22:58:29 +0000214 sqlite3VtabModuleUnref(pVTab->db, pVTab->pMod);
danielk1977595a5232009-07-24 17:58:53 +0000215 if( p ){
drh9978c972010-02-23 17:36:32 +0000216 p->pModule->xDisconnect(p);
danielk1977a04a34f2007-04-16 15:06:25 +0000217 }
danielk1977595a5232009-07-24 17:58:53 +0000218 sqlite3DbFree(db, pVTab);
219 }
220}
221
222/*
223** Table p is a virtual table. This function moves all elements in the
drhf38524d2021-08-02 16:41:57 +0000224** p->u.vtab.p list to the sqlite3.pDisconnect lists of their associated
danielk1977595a5232009-07-24 17:58:53 +0000225** database connections to be disconnected at the next opportunity.
226** Except, if argument db is not NULL, then the entry associated with
drhf38524d2021-08-02 16:41:57 +0000227** connection db is left in the p->u.vtab.p list.
danielk1977595a5232009-07-24 17:58:53 +0000228*/
229static VTable *vtabDisconnectAll(sqlite3 *db, Table *p){
230 VTable *pRet = 0;
drh78b2fa82021-10-07 12:11:20 +0000231 VTable *pVTable;
232
233 assert( IsVirtual(p) );
234 pVTable = p->u.vtab.p;
drhf38524d2021-08-02 16:41:57 +0000235 p->u.vtab.p = 0;
danielk1977595a5232009-07-24 17:58:53 +0000236
237 /* Assert that the mutex (if any) associated with the BtShared database
238 ** that contains table p is held by the caller. See header comments
239 ** above function sqlite3VtabUnlockList() for an explanation of why
240 ** this makes it safe to access the sqlite3.pDisconnect list of any
drhf38524d2021-08-02 16:41:57 +0000241 ** database connection that may have an entry in the p->u.vtab.p list.
drh9bbc2e22011-04-04 20:40:22 +0000242 */
243 assert( db==0 || sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
danielk1977595a5232009-07-24 17:58:53 +0000244
245 while( pVTable ){
246 sqlite3 *db2 = pVTable->db;
247 VTable *pNext = pVTable->pNext;
248 assert( db2 );
249 if( db2==db ){
250 pRet = pVTable;
drhf38524d2021-08-02 16:41:57 +0000251 p->u.vtab.p = pRet;
danielk1977595a5232009-07-24 17:58:53 +0000252 pRet->pNext = 0;
253 }else{
254 pVTable->pNext = db2->pDisconnect;
255 db2->pDisconnect = pVTable;
256 }
257 pVTable = pNext;
258 }
259
260 assert( !db || pRet );
261 return pRet;
262}
263
danbba02a92012-05-15 17:15:34 +0000264/*
265** Table *p is a virtual table. This function removes the VTable object
266** for table *p associated with database connection db from the linked
267** list in p->pVTab. It also decrements the VTable ref count. This is
268** used when closing database connection db to free all of its VTable
269** objects without disturbing the rest of the Schema object (which may
270** be being used by other shared-cache connections).
271*/
272void sqlite3VtabDisconnect(sqlite3 *db, Table *p){
273 VTable **ppVTab;
274
275 assert( IsVirtual(p) );
276 assert( sqlite3BtreeHoldsAllMutexes(db) );
277 assert( sqlite3_mutex_held(db->mutex) );
278
drhf38524d2021-08-02 16:41:57 +0000279 for(ppVTab=&p->u.vtab.p; *ppVTab; ppVTab=&(*ppVTab)->pNext){
danbba02a92012-05-15 17:15:34 +0000280 if( (*ppVTab)->db==db ){
281 VTable *pVTab = *ppVTab;
282 *ppVTab = pVTab->pNext;
283 sqlite3VtabUnlock(pVTab);
284 break;
285 }
286 }
287}
288
danielk1977595a5232009-07-24 17:58:53 +0000289
290/*
291** Disconnect all the virtual table objects in the sqlite3.pDisconnect list.
292**
293** This function may only be called when the mutexes associated with all
294** shared b-tree databases opened using connection db are held by the
295** caller. This is done to protect the sqlite3.pDisconnect list. The
296** sqlite3.pDisconnect list is accessed only as follows:
297**
298** 1) By this function. In this case, all BtShared mutexes and the mutex
299** associated with the database handle itself must be held.
300**
301** 2) By function vtabDisconnectAll(), when it adds a VTable entry to
302** the sqlite3.pDisconnect list. In this case either the BtShared mutex
303** associated with the database the virtual table is stored in is held
304** or, if the virtual table is stored in a non-sharable database, then
305** the database handle mutex is held.
306**
307** As a result, a sqlite3.pDisconnect cannot be accessed simultaneously
308** by multiple threads. It is thread-safe.
309*/
310void sqlite3VtabUnlockList(sqlite3 *db){
311 VTable *p = db->pDisconnect;
danielk1977595a5232009-07-24 17:58:53 +0000312
313 assert( sqlite3BtreeHoldsAllMutexes(db) );
314 assert( sqlite3_mutex_held(db->mutex) );
315
316 if( p ){
drh1de92a62019-10-05 19:24:52 +0000317 db->pDisconnect = 0;
drhba968db2018-07-24 22:02:12 +0000318 sqlite3ExpirePreparedStatements(db, 0);
danielk1977595a5232009-07-24 17:58:53 +0000319 do {
320 VTable *pNext = p->pNext;
321 sqlite3VtabUnlock(p);
322 p = pNext;
323 }while( p );
drh189d4af2006-09-02 20:57:52 +0000324 }
325}
326
327/*
drhb9bb7c12006-06-11 23:41:55 +0000328** Clear any and all virtual-table information from the Table record.
329** This routine is called, for example, just before deleting the Table
330** record.
danielk1977595a5232009-07-24 17:58:53 +0000331**
332** Since it is a virtual-table, the Table structure contains a pointer
333** to the head of a linked list of VTable structures. Each VTable
334** structure is associated with a single sqlite3* user of the schema.
335** The reference count of the VTable structure associated with database
336** connection db is decremented immediately (which may lead to the
337** structure being xDisconnected and free). Any other VTable structures
338** in the list are moved to the sqlite3.pDisconnect list of the associated
339** database connection.
drhb9bb7c12006-06-11 23:41:55 +0000340*/
dan1feeaed2010-07-23 15:41:47 +0000341void sqlite3VtabClear(sqlite3 *db, Table *p){
drh78b2fa82021-10-07 12:11:20 +0000342 assert( IsVirtual(p) );
drh41ce47c2022-08-22 02:00:26 +0000343 assert( db!=0 );
344 if( db->pnBytesFreed==0 ) vtabDisconnectAll(0, p);
drhf38524d2021-08-02 16:41:57 +0000345 if( p->u.vtab.azArg ){
drhb9bb7c12006-06-11 23:41:55 +0000346 int i;
drhf38524d2021-08-02 16:41:57 +0000347 for(i=0; i<p->u.vtab.nArg; i++){
348 if( i!=1 ) sqlite3DbFree(db, p->u.vtab.azArg[i]);
drhb9bb7c12006-06-11 23:41:55 +0000349 }
drhf38524d2021-08-02 16:41:57 +0000350 sqlite3DbFree(db, p->u.vtab.azArg);
drhb9bb7c12006-06-11 23:41:55 +0000351 }
352}
353
354/*
drhf38524d2021-08-02 16:41:57 +0000355** Add a new module argument to pTable->u.vtab.azArg[].
drhb9bb7c12006-06-11 23:41:55 +0000356** The string is not copied - the pointer is stored. The
357** string will be freed automatically when the table is
358** deleted.
359*/
drh0aa32312019-04-13 04:01:12 +0000360static void addModuleArgument(Parse *pParse, Table *pTable, char *zArg){
drh78b2fa82021-10-07 12:11:20 +0000361 sqlite3_int64 nBytes;
danielk1977b7a2f2e2006-06-23 11:34:54 +0000362 char **azModuleArg;
drh0aa32312019-04-13 04:01:12 +0000363 sqlite3 *db = pParse->db;
drh78b2fa82021-10-07 12:11:20 +0000364
365 assert( IsVirtual(pTable) );
366 nBytes = sizeof(char *)*(2+pTable->u.vtab.nArg);
drhf38524d2021-08-02 16:41:57 +0000367 if( pTable->u.vtab.nArg+3>=db->aLimit[SQLITE_LIMIT_COLUMN] ){
drh0aa32312019-04-13 04:01:12 +0000368 sqlite3ErrorMsg(pParse, "too many columns on %s", pTable->zName);
369 }
drhf38524d2021-08-02 16:41:57 +0000370 azModuleArg = sqlite3DbRealloc(db, pTable->u.vtab.azArg, nBytes);
danielk1977b7a2f2e2006-06-23 11:34:54 +0000371 if( azModuleArg==0 ){
drh633e6d52008-07-28 19:34:53 +0000372 sqlite3DbFree(db, zArg);
drhb9bb7c12006-06-11 23:41:55 +0000373 }else{
drhf38524d2021-08-02 16:41:57 +0000374 int i = pTable->u.vtab.nArg++;
danielk1977b7a2f2e2006-06-23 11:34:54 +0000375 azModuleArg[i] = zArg;
376 azModuleArg[i+1] = 0;
drhf38524d2021-08-02 16:41:57 +0000377 pTable->u.vtab.azArg = azModuleArg;
drhb9bb7c12006-06-11 23:41:55 +0000378 }
379}
380
381/*
382** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
383** statement. The module name has been parsed, but the optional list
384** of parameters that follow the module name are still pending.
385*/
386void sqlite3VtabBeginParse(
387 Parse *pParse, /* Parsing context */
388 Token *pName1, /* Name of new table, or database name */
389 Token *pName2, /* Name of new table or NULL */
drhb421b892012-01-28 19:41:53 +0000390 Token *pModuleName, /* Name of the module for the virtual table */
391 int ifNotExists /* No error if the table already exists */
drhb9bb7c12006-06-11 23:41:55 +0000392){
393 Table *pTable; /* The new virtual table */
drh17435752007-08-16 04:30:38 +0000394 sqlite3 *db; /* Database connection */
drhb9bb7c12006-06-11 23:41:55 +0000395
drhb421b892012-01-28 19:41:53 +0000396 sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, ifNotExists);
drhb9bb7c12006-06-11 23:41:55 +0000397 pTable = pParse->pNewTable;
drh748ce212009-05-20 20:10:47 +0000398 if( pTable==0 ) return;
danielk1977f1a381e2006-06-16 08:01:02 +0000399 assert( 0==pTable->pIndex );
drhf38524d2021-08-02 16:41:57 +0000400 pTable->eTabType = TABTYP_VTAB;
danielk1977f1a381e2006-06-16 08:01:02 +0000401
drh17435752007-08-16 04:30:38 +0000402 db = pParse->db;
danielk197770ba1642006-06-21 16:02:42 +0000403
drhf38524d2021-08-02 16:41:57 +0000404 assert( pTable->u.vtab.nArg==0 );
drh0aa32312019-04-13 04:01:12 +0000405 addModuleArgument(pParse, pTable, sqlite3NameFromToken(db, pModuleName));
406 addModuleArgument(pParse, pTable, 0);
407 addModuleArgument(pParse, pTable, sqlite3DbStrDup(db, pTable->zName));
dand89b8342014-11-27 11:36:36 +0000408 assert( (pParse->sNameToken.z==pName2->z && pName2->z!=0)
409 || (pParse->sNameToken.z==pName1->z && pName2->z==0)
410 );
411 pParse->sNameToken.n = (int)(
412 &pModuleName->z[pModuleName->n] - pParse->sNameToken.z
413 );
danielk1977f1a381e2006-06-16 08:01:02 +0000414
415#ifndef SQLITE_OMIT_AUTHORIZATION
416 /* Creating a virtual table invokes the authorization callback twice.
417 ** The first invocation, to obtain permission to INSERT a row into the
drh1e32bed2020-06-19 13:33:53 +0000418 ** sqlite_schema table, has already been made by sqlite3StartTable().
danielk1977f1a381e2006-06-16 08:01:02 +0000419 ** The second call, to obtain permission to create the table, is made now.
420 */
drhf38524d2021-08-02 16:41:57 +0000421 if( pTable->u.vtab.azArg ){
mistachkin7cc55952018-09-21 23:41:18 +0000422 int iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
423 assert( iDb>=0 ); /* The database the table is being created in */
danielk1977be718892006-06-23 08:05:19 +0000424 sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName,
drhf38524d2021-08-02 16:41:57 +0000425 pTable->u.vtab.azArg[0], pParse->db->aDb[iDb].zDbSName);
danielk1977f1a381e2006-06-16 08:01:02 +0000426 }
427#endif
drhb9bb7c12006-06-11 23:41:55 +0000428}
429
430/*
431** This routine takes the module argument that has been accumulating
432** in pParse->zArg[] and appends it to the list of arguments on the
433** virtual table currently under construction in pParse->pTable.
434*/
435static void addArgumentToVtab(Parse *pParse){
drhb421b892012-01-28 19:41:53 +0000436 if( pParse->sArg.z && pParse->pNewTable ){
drh7c2d87c2006-09-02 14:16:59 +0000437 const char *z = (const char*)pParse->sArg.z;
danielk197733b39332006-06-24 08:51:05 +0000438 int n = pParse->sArg.n;
drh17435752007-08-16 04:30:38 +0000439 sqlite3 *db = pParse->db;
drh0aa32312019-04-13 04:01:12 +0000440 addModuleArgument(pParse, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
drhb9bb7c12006-06-11 23:41:55 +0000441 }
drhb9bb7c12006-06-11 23:41:55 +0000442}
443
444/*
445** The parser calls this routine after the CREATE VIRTUAL TABLE statement
446** has been completely parsed.
447*/
448void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
danielk1977595a5232009-07-24 17:58:53 +0000449 Table *pTab = pParse->pNewTable; /* The table being constructed */
450 sqlite3 *db = pParse->db; /* The database connection */
drhb9bb7c12006-06-11 23:41:55 +0000451
danielk1977595a5232009-07-24 17:58:53 +0000452 if( pTab==0 ) return;
drh78b2fa82021-10-07 12:11:20 +0000453 assert( IsVirtual(pTab) );
drhb9bb7c12006-06-11 23:41:55 +0000454 addArgumentToVtab(pParse);
danielk197733b39332006-06-24 08:51:05 +0000455 pParse->sArg.z = 0;
drhf38524d2021-08-02 16:41:57 +0000456 if( pTab->u.vtab.nArg<1 ) return;
drhb9bb7c12006-06-11 23:41:55 +0000457
458 /* If the CREATE VIRTUAL TABLE statement is being entered for the
459 ** first time (in other words if the virtual table is actually being
drh1e32bed2020-06-19 13:33:53 +0000460 ** created now instead of just being read out of sqlite_schema) then
drhb9bb7c12006-06-11 23:41:55 +0000461 ** do additional initialization work and store the statement text
drh1e32bed2020-06-19 13:33:53 +0000462 ** in the sqlite_schema table.
drhb9bb7c12006-06-11 23:41:55 +0000463 */
464 if( !db->init.busy ){
465 char *zStmt;
danielk197778efaba2006-06-12 06:09:17 +0000466 char *zWhere;
drhb9bb7c12006-06-11 23:41:55 +0000467 int iDb;
dan73779452015-03-19 18:56:17 +0000468 int iReg;
drhb9bb7c12006-06-11 23:41:55 +0000469 Vdbe *v;
drhb9bb7c12006-06-11 23:41:55 +0000470
drh8e8c8892019-12-10 18:10:12 +0000471 sqlite3MayAbort(pParse);
472
drhb9bb7c12006-06-11 23:41:55 +0000473 /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
474 if( pEnd ){
drhb27b7f52008-12-10 18:03:45 +0000475 pParse->sNameToken.n = (int)(pEnd->z - pParse->sNameToken.z) + pEnd->n;
drhb9bb7c12006-06-11 23:41:55 +0000476 }
danielk19771e536952007-08-16 10:09:01 +0000477 zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
drhb9bb7c12006-06-11 23:41:55 +0000478
479 /* A slot for the record has already been allocated in the
drh346a70c2020-06-15 20:27:35 +0000480 ** schema table. We just need to update that slot with all
danielk197778efaba2006-06-12 06:09:17 +0000481 ** the information we've collected.
482 **
drhb7654112008-01-12 12:48:07 +0000483 ** The VM register number pParse->regRowid holds the rowid of an
drh1e32bed2020-06-19 13:33:53 +0000484 ** entry in the sqlite_schema table tht was created for this vtab
drhb7654112008-01-12 12:48:07 +0000485 ** by sqlite3StartTable().
drhb9bb7c12006-06-11 23:41:55 +0000486 */
487 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
488 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000489 "UPDATE %Q." LEGACY_SCHEMA_TABLE " "
danielk197778efaba2006-06-12 06:09:17 +0000490 "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
drhb7654112008-01-12 12:48:07 +0000491 "WHERE rowid=#%d",
drh346a70c2020-06-15 20:27:35 +0000492 db->aDb[iDb].zDbSName,
drhb9bb7c12006-06-11 23:41:55 +0000493 pTab->zName,
494 pTab->zName,
drhb7654112008-01-12 12:48:07 +0000495 zStmt,
496 pParse->regRowid
drhb9bb7c12006-06-11 23:41:55 +0000497 );
drhb9bb7c12006-06-11 23:41:55 +0000498 v = sqlite3GetVdbe(pParse);
drh9cbf3422008-01-17 16:22:13 +0000499 sqlite3ChangeCookie(pParse, iDb);
danielk197778efaba2006-06-12 06:09:17 +0000500
drh01c736d2016-05-20 15:15:07 +0000501 sqlite3VdbeAddOp0(v, OP_Expire);
drhf4f31df2019-12-21 19:37:09 +0000502 zWhere = sqlite3MPrintf(db, "name=%Q AND sql=%Q", pTab->zName, zStmt);
dan6a5a13d2021-02-17 20:08:22 +0000503 sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere, 0);
drhf4f31df2019-12-21 19:37:09 +0000504 sqlite3DbFree(db, zStmt);
dan73779452015-03-19 18:56:17 +0000505
506 iReg = ++pParse->nMem;
drh076e85f2015-09-03 13:46:12 +0000507 sqlite3VdbeLoadString(v, iReg, pTab->zName);
dan73779452015-03-19 18:56:17 +0000508 sqlite3VdbeAddOp2(v, OP_VCreate, iDb, iReg);
drhddfec002021-11-04 00:51:53 +0000509 }else{
510 /* If we are rereading the sqlite_schema table create the in-memory
511 ** record of the table. */
danielk197778efaba2006-06-12 06:09:17 +0000512 Table *pOld;
513 Schema *pSchema = pTab->pSchema;
514 const char *zName = pTab->zName;
drhddfec002021-11-04 00:51:53 +0000515 assert( zName!=0 );
516 sqlite3MarkAllShadowTablesOf(db, pTab);
drhacbcb7e2014-08-21 20:26:37 +0000517 pOld = sqlite3HashInsert(&pSchema->tblHash, zName, pTab);
danielk197778efaba2006-06-12 06:09:17 +0000518 if( pOld ){
drh4a642b62016-02-05 01:55:27 +0000519 sqlite3OomFault(db);
danielk197778efaba2006-06-12 06:09:17 +0000520 assert( pTab==pOld ); /* Malloc must have failed inside HashInsert() */
521 return;
522 }
danielk19777e6ebfb2006-06-12 11:24:37 +0000523 pParse->pNewTable = 0;
drhb9bb7c12006-06-11 23:41:55 +0000524 }
525}
526
527/*
528** The parser calls this routine when it sees the first token
529** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
530*/
531void sqlite3VtabArgInit(Parse *pParse){
532 addArgumentToVtab(pParse);
danielk197733b39332006-06-24 08:51:05 +0000533 pParse->sArg.z = 0;
534 pParse->sArg.n = 0;
drhb9bb7c12006-06-11 23:41:55 +0000535}
536
537/*
538** The parser calls this routine for each token after the first token
539** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
540*/
541void sqlite3VtabArgExtend(Parse *pParse, Token *p){
danielk197733b39332006-06-24 08:51:05 +0000542 Token *pArg = &pParse->sArg;
543 if( pArg->z==0 ){
544 pArg->z = p->z;
545 pArg->n = p->n;
546 }else{
drh542a1762015-04-19 23:11:10 +0000547 assert(pArg->z <= p->z);
drhb27b7f52008-12-10 18:03:45 +0000548 pArg->n = (int)(&p->z[p->n] - pArg->z);
drhb9bb7c12006-06-11 23:41:55 +0000549 }
drhb9bb7c12006-06-11 23:41:55 +0000550}
551
danielk197778efaba2006-06-12 06:09:17 +0000552/*
danielk19779da9d472006-06-14 06:58:15 +0000553** Invoke a virtual table constructor (either xCreate or xConnect). The
554** pointer to the function to invoke is passed as the fourth parameter
555** to this procedure.
556*/
557static int vtabCallConstructor(
558 sqlite3 *db,
559 Table *pTab,
danielk1977d1ab1ba2006-06-15 04:28:13 +0000560 Module *pMod,
drhe4102962006-09-11 00:34:22 +0000561 int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
danielk19779da9d472006-06-14 06:58:15 +0000562 char **pzErr
563){
dan75395cc2015-04-10 07:55:07 +0000564 VtabCtx sCtx;
danielk1977595a5232009-07-24 17:58:53 +0000565 VTable *pVTable;
danielk19779da9d472006-06-14 06:58:15 +0000566 int rc;
drh78b2fa82021-10-07 12:11:20 +0000567 const char *const*azArg;
drhf38524d2021-08-02 16:41:57 +0000568 int nArg = pTab->u.vtab.nArg;
drh4ca8aac2006-09-10 17:31:58 +0000569 char *zErr = 0;
dan75395cc2015-04-10 07:55:07 +0000570 char *zModuleName;
dan41fb5cd2012-10-04 19:33:00 +0000571 int iDb;
dan75395cc2015-04-10 07:55:07 +0000572 VtabCtx *pCtx;
danielk19779da9d472006-06-14 06:58:15 +0000573
drh78b2fa82021-10-07 12:11:20 +0000574 assert( IsVirtual(pTab) );
575 azArg = (const char *const*)pTab->u.vtab.azArg;
576
dan75395cc2015-04-10 07:55:07 +0000577 /* Check that the virtual-table is not already being initialized */
578 for(pCtx=db->pVtabCtx; pCtx; pCtx=pCtx->pPrior){
579 if( pCtx->pTab==pTab ){
580 *pzErr = sqlite3MPrintf(db,
581 "vtable constructor called recursively: %s", pTab->zName
582 );
583 return SQLITE_LOCKED;
584 }
585 }
586
drh3ee14162017-10-02 13:20:43 +0000587 zModuleName = sqlite3DbStrDup(db, pTab->zName);
danielk197701256832007-04-18 14:24:32 +0000588 if( !zModuleName ){
mistachkinfad30392016-02-13 23:43:46 +0000589 return SQLITE_NOMEM_BKPT;
danielk197701256832007-04-18 14:24:32 +0000590 }
591
drh3ee14162017-10-02 13:20:43 +0000592 pVTable = sqlite3MallocZero(sizeof(VTable));
danielk1977595a5232009-07-24 17:58:53 +0000593 if( !pVTable ){
drh3ee14162017-10-02 13:20:43 +0000594 sqlite3OomFault(db);
danielk1977595a5232009-07-24 17:58:53 +0000595 sqlite3DbFree(db, zModuleName);
mistachkinfad30392016-02-13 23:43:46 +0000596 return SQLITE_NOMEM_BKPT;
danielk1977595a5232009-07-24 17:58:53 +0000597 }
598 pVTable->db = db;
599 pVTable->pMod = pMod;
drh2928a152020-01-06 15:25:41 +0000600 pVTable->eVtabRisk = SQLITE_VTABRISK_Normal;
danielk1977595a5232009-07-24 17:58:53 +0000601
dan41fb5cd2012-10-04 19:33:00 +0000602 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drhf38524d2021-08-02 16:41:57 +0000603 pTab->u.vtab.azArg[1] = db->aDb[iDb].zDbSName;
dan41fb5cd2012-10-04 19:33:00 +0000604
danielk1977595a5232009-07-24 17:58:53 +0000605 /* Invoke the virtual table constructor */
danb061d052011-04-25 18:49:57 +0000606 assert( &db->pVtabCtx );
607 assert( xConstruct );
608 sCtx.pTab = pTab;
609 sCtx.pVTable = pVTable;
dan75395cc2015-04-10 07:55:07 +0000610 sCtx.pPrior = db->pVtabCtx;
611 sCtx.bDeclared = 0;
danb061d052011-04-25 18:49:57 +0000612 db->pVtabCtx = &sCtx;
danielk1977595a5232009-07-24 17:58:53 +0000613 rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVTable->pVtab, &zErr);
dan75395cc2015-04-10 07:55:07 +0000614 db->pVtabCtx = sCtx.pPrior;
drh4a642b62016-02-05 01:55:27 +0000615 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
dan75395cc2015-04-10 07:55:07 +0000616 assert( sCtx.pTab==pTab );
danielk19779da9d472006-06-14 06:58:15 +0000617
618 if( SQLITE_OK!=rc ){
drh4ca8aac2006-09-10 17:31:58 +0000619 if( zErr==0 ){
danielk19771e536952007-08-16 10:09:01 +0000620 *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
drh4ca8aac2006-09-10 17:31:58 +0000621 }else {
danielk19771e536952007-08-16 10:09:01 +0000622 *pzErr = sqlite3MPrintf(db, "%s", zErr);
drhb9755982010-07-24 16:34:37 +0000623 sqlite3_free(zErr);
drhfe1368e2006-09-10 17:08:29 +0000624 }
danielk1977595a5232009-07-24 17:58:53 +0000625 sqlite3DbFree(db, pVTable);
626 }else if( ALWAYS(pVTable->pVtab) ){
627 /* Justification of ALWAYS(): A correct vtab constructor must allocate
628 ** the sqlite3_vtab object if successful. */
drh5604cc02014-10-14 20:25:43 +0000629 memset(pVTable->pVtab, 0, sizeof(pVTable->pVtab[0]));
danielk1977595a5232009-07-24 17:58:53 +0000630 pVTable->pVtab->pModule = pMod->pModule;
drhcc5979d2019-08-16 22:58:29 +0000631 pMod->nRefModule++;
danielk1977595a5232009-07-24 17:58:53 +0000632 pVTable->nRef = 1;
dan75395cc2015-04-10 07:55:07 +0000633 if( sCtx.bDeclared==0 ){
danielk1977595a5232009-07-24 17:58:53 +0000634 const char *zFormat = "vtable constructor did not declare schema: %s";
635 *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
636 sqlite3VtabUnlock(pVTable);
637 rc = SQLITE_ERROR;
638 }else{
639 int iCol;
drhc1431142019-10-17 17:54:05 +0000640 u16 oooHidden = 0;
danielk1977595a5232009-07-24 17:58:53 +0000641 /* If everything went according to plan, link the new VTable structure
drhf38524d2021-08-02 16:41:57 +0000642 ** into the linked list headed by pTab->u.vtab.p. Then loop through the
danielk1977595a5232009-07-24 17:58:53 +0000643 ** columns of the table to see if any of them contain the token "hidden".
drha371ace2012-09-13 14:22:47 +0000644 ** If so, set the Column COLFLAG_HIDDEN flag and remove the token from
danielk1977595a5232009-07-24 17:58:53 +0000645 ** the type string. */
drhf38524d2021-08-02 16:41:57 +0000646 pVTable->pNext = pTab->u.vtab.p;
647 pTab->u.vtab.p = pVTable;
danielk1977034ca142007-06-26 10:38:54 +0000648
danielk1977595a5232009-07-24 17:58:53 +0000649 for(iCol=0; iCol<pTab->nCol; iCol++){
drhd7564862016-03-22 20:05:09 +0000650 char *zType = sqlite3ColumnType(&pTab->aCol[iCol], "");
danielk1977595a5232009-07-24 17:58:53 +0000651 int nType;
652 int i = 0;
danielk1977595a5232009-07-24 17:58:53 +0000653 nType = sqlite3Strlen30(zType);
drhd7564862016-03-22 20:05:09 +0000654 for(i=0; i<nType; i++){
655 if( 0==sqlite3StrNICmp("hidden", &zType[i], 6)
656 && (i==0 || zType[i-1]==' ')
657 && (zType[i+6]=='\0' || zType[i+6]==' ')
658 ){
659 break;
danielk1977034ca142007-06-26 10:38:54 +0000660 }
661 }
danielk1977595a5232009-07-24 17:58:53 +0000662 if( i<nType ){
663 int j;
664 int nDel = 6 + (zType[i+6] ? 1 : 0);
665 for(j=i; (j+nDel)<=nType; j++){
666 zType[j] = zType[j+nDel];
667 }
668 if( zType[i]=='\0' && i>0 ){
669 assert(zType[i-1]==' ');
670 zType[i-1] = '\0';
671 }
drha371ace2012-09-13 14:22:47 +0000672 pTab->aCol[iCol].colFlags |= COLFLAG_HIDDEN;
drh6f6e60d2021-02-18 15:45:34 +0000673 pTab->tabFlags |= TF_HasHidden;
drha21f78b2015-04-19 18:32:43 +0000674 oooHidden = TF_OOOHidden;
675 }else{
676 pTab->tabFlags |= oooHidden;
danielk1977034ca142007-06-26 10:38:54 +0000677 }
danielk1977034ca142007-06-26 10:38:54 +0000678 }
679 }
680 }
danielk1977595a5232009-07-24 17:58:53 +0000681
682 sqlite3DbFree(db, zModuleName);
danielk19779da9d472006-06-14 06:58:15 +0000683 return rc;
684}
685
686/*
danielk19777e6ebfb2006-06-12 11:24:37 +0000687** This function is invoked by the parser to call the xConnect() method
danielk1977fe3fcbe22006-06-12 12:08:45 +0000688** of the virtual table pTab. If an error occurs, an error code is returned
689** and an error left in pParse.
690**
691** This call is a no-op if table pTab is not a virtual table.
danielk19777e6ebfb2006-06-12 11:24:37 +0000692*/
693int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
danielk1977595a5232009-07-24 17:58:53 +0000694 sqlite3 *db = pParse->db;
695 const char *zMod;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000696 Module *pMod;
danielk1977595a5232009-07-24 17:58:53 +0000697 int rc;
danielk19777e6ebfb2006-06-12 11:24:37 +0000698
drh748ce212009-05-20 20:10:47 +0000699 assert( pTab );
drh06b72812021-11-04 11:34:04 +0000700 assert( IsVirtual(pTab) );
701 if( sqlite3GetVTable(db, pTab) ){
danielk19777e6ebfb2006-06-12 11:24:37 +0000702 return SQLITE_OK;
703 }
704
danielk1977595a5232009-07-24 17:58:53 +0000705 /* Locate the required virtual table module */
drhf38524d2021-08-02 16:41:57 +0000706 zMod = pTab->u.vtab.azArg[0];
drhacbcb7e2014-08-21 20:26:37 +0000707 pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
danielk1977595a5232009-07-24 17:58:53 +0000708
danielk1977d1ab1ba2006-06-15 04:28:13 +0000709 if( !pMod ){
drhf38524d2021-08-02 16:41:57 +0000710 const char *zModule = pTab->u.vtab.azArg[0];
danielk1977a4e76362006-06-14 06:31:28 +0000711 sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
danielk19777e6ebfb2006-06-12 11:24:37 +0000712 rc = SQLITE_ERROR;
danielk1977595a5232009-07-24 17:58:53 +0000713 }else{
danielk19779da9d472006-06-14 06:58:15 +0000714 char *zErr = 0;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000715 rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
danielk19779da9d472006-06-14 06:58:15 +0000716 if( rc!=SQLITE_OK ){
717 sqlite3ErrorMsg(pParse, "%s", zErr);
drh7524b612017-08-09 22:55:09 +0000718 pParse->rc = rc;
danielk19777e6ebfb2006-06-12 11:24:37 +0000719 }
drh633e6d52008-07-28 19:34:53 +0000720 sqlite3DbFree(db, zErr);
danielk19777e6ebfb2006-06-12 11:24:37 +0000721 }
722
723 return rc;
724}
danielk19779da9d472006-06-14 06:58:15 +0000725/*
dan2cac2072011-05-25 18:46:22 +0000726** Grow the db->aVTrans[] array so that there is room for at least one
727** more v-table. Return SQLITE_NOMEM if a malloc fails, or SQLITE_OK otherwise.
danielk1977e7ff4032006-06-17 11:30:32 +0000728*/
dan2cac2072011-05-25 18:46:22 +0000729static int growVTrans(sqlite3 *db){
danielk1977e7ff4032006-06-17 11:30:32 +0000730 const int ARRAY_INCR = 5;
731
732 /* Grow the sqlite3.aVTrans array if required */
733 if( (db->nVTrans%ARRAY_INCR)==0 ){
danielk1977595a5232009-07-24 17:58:53 +0000734 VTable **aVTrans;
drh0aa32312019-04-13 04:01:12 +0000735 sqlite3_int64 nBytes = sizeof(sqlite3_vtab*)*
736 ((sqlite3_int64)db->nVTrans + ARRAY_INCR);
danielk197726783a52007-08-29 14:06:22 +0000737 aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
danielk1977e7ff4032006-06-17 11:30:32 +0000738 if( !aVTrans ){
mistachkinfad30392016-02-13 23:43:46 +0000739 return SQLITE_NOMEM_BKPT;
danielk1977e7ff4032006-06-17 11:30:32 +0000740 }
741 memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
742 db->aVTrans = aVTrans;
743 }
744
dan2cac2072011-05-25 18:46:22 +0000745 return SQLITE_OK;
746}
747
748/*
749** Add the virtual table pVTab to the array sqlite3.aVTrans[]. Space should
750** have already been reserved using growVTrans().
751*/
752static void addToVTrans(sqlite3 *db, VTable *pVTab){
danielk1977e7ff4032006-06-17 11:30:32 +0000753 /* Add pVtab to the end of sqlite3.aVTrans */
danielk1977595a5232009-07-24 17:58:53 +0000754 db->aVTrans[db->nVTrans++] = pVTab;
755 sqlite3VtabLock(pVTab);
danielk1977e7ff4032006-06-17 11:30:32 +0000756}
757
758/*
danielk19779da9d472006-06-14 06:58:15 +0000759** This function is invoked by the vdbe to call the xCreate method
760** of the virtual table named zTab in database iDb.
761**
drh2e5c5052016-08-27 20:21:51 +0000762** If an error occurs, *pzErr is set to point to an English language
danielk19779da9d472006-06-14 06:58:15 +0000763** description of the error and an SQLITE_XXX error code is returned.
drh633e6d52008-07-28 19:34:53 +0000764** In this case the caller must call sqlite3DbFree(db, ) on *pzErr.
danielk19779da9d472006-06-14 06:58:15 +0000765*/
766int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
767 int rc = SQLITE_OK;
768 Table *pTab;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000769 Module *pMod;
danielk1977595a5232009-07-24 17:58:53 +0000770 const char *zMod;
danielk19779da9d472006-06-14 06:58:15 +0000771
drh69c33822016-08-18 14:33:11 +0000772 pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
drhf38524d2021-08-02 16:41:57 +0000773 assert( pTab && IsVirtual(pTab) && !pTab->u.vtab.p );
danielk1977595a5232009-07-24 17:58:53 +0000774
775 /* Locate the required virtual table module */
drhf38524d2021-08-02 16:41:57 +0000776 zMod = pTab->u.vtab.azArg[0];
drhacbcb7e2014-08-21 20:26:37 +0000777 pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
danielk19779da9d472006-06-14 06:58:15 +0000778
779 /* If the module has been registered and includes a Create method,
780 ** invoke it now. If the module has not been registered, return an
781 ** error. Otherwise, do nothing.
782 */
drhd8b1bfc2015-08-20 23:21:34 +0000783 if( pMod==0 || pMod->pModule->xCreate==0 || pMod->pModule->xDestroy==0 ){
danielk1977595a5232009-07-24 17:58:53 +0000784 *pzErr = sqlite3MPrintf(db, "no such module: %s", zMod);
danielk19779da9d472006-06-14 06:58:15 +0000785 rc = SQLITE_ERROR;
786 }else{
danielk1977d1ab1ba2006-06-15 04:28:13 +0000787 rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
danielk19779da9d472006-06-14 06:58:15 +0000788 }
789
drh748ce212009-05-20 20:10:47 +0000790 /* Justification of ALWAYS(): The xConstructor method is required to
791 ** create a valid sqlite3_vtab if it returns SQLITE_OK. */
danielk1977595a5232009-07-24 17:58:53 +0000792 if( rc==SQLITE_OK && ALWAYS(sqlite3GetVTable(db, pTab)) ){
dan2cac2072011-05-25 18:46:22 +0000793 rc = growVTrans(db);
794 if( rc==SQLITE_OK ){
795 addToVTrans(db, sqlite3GetVTable(db, pTab));
796 }
danielk1977e7ff4032006-06-17 11:30:32 +0000797 }
798
danielk19779da9d472006-06-14 06:58:15 +0000799 return rc;
800}
danielk1977be8a7832006-06-13 15:00:54 +0000801
802/*
danielk1977fe3fcbe22006-06-12 12:08:45 +0000803** This function is used to set the schema of a virtual table. It is only
804** valid to call this function from within the xCreate() or xConnect() of a
805** virtual table module.
806*/
danielk19777e6ebfb2006-06-12 11:24:37 +0000807int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
dan4e235362015-04-10 16:05:33 +0000808 VtabCtx *pCtx;
danielk19777e6ebfb2006-06-12 11:24:37 +0000809 int rc = SQLITE_OK;
drh27641702007-08-22 02:56:42 +0000810 Table *pTab;
drh6903bf62017-08-01 20:59:41 +0000811 Parse sParse;
drhebd1ff62021-09-24 12:59:33 +0000812 int initBusy;
danielk19777e6ebfb2006-06-12 11:24:37 +0000813
drh9ca95732014-10-24 00:35:58 +0000814#ifdef SQLITE_ENABLE_API_ARMOR
drh96c707a2015-02-13 16:36:14 +0000815 if( !sqlite3SafetyCheckOk(db) || zCreateTable==0 ){
816 return SQLITE_MISUSE_BKPT;
817 }
drh9ca95732014-10-24 00:35:58 +0000818#endif
drh27641702007-08-22 02:56:42 +0000819 sqlite3_mutex_enter(db->mutex);
dan4e235362015-04-10 16:05:33 +0000820 pCtx = db->pVtabCtx;
dan75395cc2015-04-10 07:55:07 +0000821 if( !pCtx || pCtx->bDeclared ){
drh13f40da2014-08-22 18:00:11 +0000822 sqlite3Error(db, SQLITE_MISUSE);
drh27641702007-08-22 02:56:42 +0000823 sqlite3_mutex_leave(db->mutex);
drh413c3d32010-02-23 20:11:56 +0000824 return SQLITE_MISUSE_BKPT;
danielk19777e6ebfb2006-06-12 11:24:37 +0000825 }
dan75395cc2015-04-10 07:55:07 +0000826 pTab = pCtx->pTab;
drh44266ec2017-02-16 14:48:08 +0000827 assert( IsVirtual(pTab) );
danielk19777e6ebfb2006-06-12 11:24:37 +0000828
drhc692df22022-01-24 15:34:55 +0000829 sqlite3ParseObjectInit(&sParse, db);
dancf8f2892018-08-09 20:47:01 +0000830 sParse.eParseMode = PARSE_MODE_DECLARE_VTAB;
drh1a25be12022-03-14 20:31:57 +0000831 sParse.disableTriggers = 1;
drhebd1ff62021-09-24 12:59:33 +0000832 /* We should never be able to reach this point while loading the
833 ** schema. Nevertheless, defend against that (turn off db->init.busy)
834 ** in case a bug arises. */
835 assert( db->init.busy==0 );
836 initBusy = db->init.busy;
837 db->init.busy = 0;
drh6903bf62017-08-01 20:59:41 +0000838 sParse.nQueryLoop = 1;
drh54bc6382021-12-31 19:20:42 +0000839 if( SQLITE_OK==sqlite3RunParser(&sParse, zCreateTable)
drh16118262021-12-31 17:54:48 +0000840 && ALWAYS(sParse.pNewTable!=0)
841 && ALWAYS(!db->mallocFailed)
drhf38524d2021-08-02 16:41:57 +0000842 && IsOrdinaryTable(sParse.pNewTable)
drh6903bf62017-08-01 20:59:41 +0000843 ){
drh54bc6382021-12-31 19:20:42 +0000844 assert( sParse.zErrMsg==0 );
drh6903bf62017-08-01 20:59:41 +0000845 if( !pTab->aCol ){
846 Table *pNew = sParse.pNewTable;
847 Index *pIdx;
848 pTab->aCol = pNew->aCol;
drhf38524d2021-08-02 16:41:57 +0000849 sqlite3ExprListDelete(db, pNew->u.tab.pDfltList);
drh7dec8042021-02-04 22:59:19 +0000850 pTab->nNVCol = pTab->nCol = pNew->nCol;
drh6903bf62017-08-01 20:59:41 +0000851 pTab->tabFlags |= pNew->tabFlags & (TF_WithoutRowid|TF_NoVisibleRowid);
852 pNew->nCol = 0;
853 pNew->aCol = 0;
854 assert( pTab->pIndex==0 );
drhe3740f22017-08-10 15:19:39 +0000855 assert( HasRowid(pNew) || sqlite3PrimaryKeyIndex(pNew)!=0 );
856 if( !HasRowid(pNew)
857 && pCtx->pVTable->pMod->pModule->xUpdate!=0
858 && sqlite3PrimaryKeyIndex(pNew)->nKeyCol!=1
859 ){
860 /* WITHOUT ROWID virtual tables must either be read-only (xUpdate==0)
861 ** or else must have a single-column PRIMARY KEY */
drh6903bf62017-08-01 20:59:41 +0000862 rc = SQLITE_ERROR;
danielk1977595a5232009-07-24 17:58:53 +0000863 }
drh6903bf62017-08-01 20:59:41 +0000864 pIdx = pNew->pIndex;
865 if( pIdx ){
866 assert( pIdx->pNext==0 );
867 pTab->pIndex = pIdx;
868 pNew->pIndex = 0;
869 pIdx->pTable = pTab;
870 }
drhe98c9042009-06-02 21:31:38 +0000871 }
drh6903bf62017-08-01 20:59:41 +0000872 pCtx->bDeclared = 1;
873 }else{
drh54bc6382021-12-31 19:20:42 +0000874 sqlite3ErrorWithMsg(db, SQLITE_ERROR,
875 (sParse.zErrMsg ? "%s" : 0), sParse.zErrMsg);
876 sqlite3DbFree(db, sParse.zErrMsg);
drh6903bf62017-08-01 20:59:41 +0000877 rc = SQLITE_ERROR;
danielk19777e6ebfb2006-06-12 11:24:37 +0000878 }
dancf8f2892018-08-09 20:47:01 +0000879 sParse.eParseMode = PARSE_MODE_NORMAL;
drh6903bf62017-08-01 20:59:41 +0000880
881 if( sParse.pVdbe ){
882 sqlite3VdbeFinalize(sParse.pVdbe);
883 }
884 sqlite3DeleteTable(db, sParse.pNewTable);
drhc692df22022-01-24 15:34:55 +0000885 sqlite3ParseObjectReset(&sParse);
drhebd1ff62021-09-24 12:59:33 +0000886 db->init.busy = initBusy;
danielk19777e6ebfb2006-06-12 11:24:37 +0000887
drh4ac285a2006-09-15 07:28:50 +0000888 assert( (rc&0xff)==rc );
drh27641702007-08-22 02:56:42 +0000889 rc = sqlite3ApiExit(db, rc);
890 sqlite3_mutex_leave(db->mutex);
891 return rc;
danielk19777e6ebfb2006-06-12 11:24:37 +0000892}
893
894/*
danielk19779e39ce82006-06-12 16:01:21 +0000895** This function is invoked by the vdbe to call the xDestroy method
896** of the virtual table named zTab in database iDb. This occurs
897** when a DROP TABLE is mentioned.
898**
899** This call is a no-op if zTab is not a virtual table.
900*/
drh748ce212009-05-20 20:10:47 +0000901int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab){
danielk19779e39ce82006-06-12 16:01:21 +0000902 int rc = SQLITE_OK;
903 Table *pTab;
danielk19779e39ce82006-06-12 16:01:21 +0000904
drh69c33822016-08-18 14:33:11 +0000905 pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
drh7b108e42021-11-06 20:25:29 +0000906 if( ALWAYS(pTab!=0)
907 && ALWAYS(IsVirtual(pTab))
908 && ALWAYS(pTab->u.vtab.p!=0)
909 ){
drha68d6282015-03-24 13:32:53 +0000910 VTable *p;
mistachkin197d59f2015-08-20 21:14:31 +0000911 int (*xDestroy)(sqlite3_vtab *);
drhf38524d2021-08-02 16:41:57 +0000912 for(p=pTab->u.vtab.p; p; p=p->pNext){
drha68d6282015-03-24 13:32:53 +0000913 assert( p->pVtab );
914 if( p->pVtab->nRef>0 ){
915 return SQLITE_LOCKED;
916 }
917 }
918 p = vtabDisconnectAll(db, pTab);
mistachkin197d59f2015-08-20 21:14:31 +0000919 xDestroy = p->pMod->pModule->xDestroy;
drha1ca00e2019-12-11 15:07:09 +0000920 if( xDestroy==0 ) xDestroy = p->pMod->pModule->xDisconnect;
921 assert( xDestroy!=0 );
danc589acb2019-04-30 15:36:32 +0000922 pTab->nTabRef++;
drha1ca00e2019-12-11 15:07:09 +0000923 rc = xDestroy(p->pVtab);
danielk1977595a5232009-07-24 17:58:53 +0000924 /* Remove the sqlite3_vtab* from the aVTrans[] array, if applicable */
danielk19779e39ce82006-06-12 16:01:21 +0000925 if( rc==SQLITE_OK ){
drhf38524d2021-08-02 16:41:57 +0000926 assert( pTab->u.vtab.p==p && p->pNext==0 );
danielk1977595a5232009-07-24 17:58:53 +0000927 p->pVtab = 0;
drhf38524d2021-08-02 16:41:57 +0000928 pTab->u.vtab.p = 0;
danielk1977595a5232009-07-24 17:58:53 +0000929 sqlite3VtabUnlock(p);
danielk19779e39ce82006-06-12 16:01:21 +0000930 }
danc589acb2019-04-30 15:36:32 +0000931 sqlite3DeleteTable(db, pTab);
danielk19779e39ce82006-06-12 16:01:21 +0000932 }
933
934 return rc;
935}
936
danielk1977f9e7dda2006-06-16 16:08:53 +0000937/*
danielk1977e7ff4032006-06-17 11:30:32 +0000938** This function invokes either the xRollback or xCommit method
939** of each of the virtual tables in the sqlite3.aVTrans array. The method
940** called is identified by the second argument, "offset", which is
941** the offset of the method to call in the sqlite3_module structure.
942**
943** The array is cleared after invoking the callbacks.
944*/
drh7209c692008-04-27 18:40:11 +0000945static void callFinaliser(sqlite3 *db, int offset){
danielk1977e7ff4032006-06-17 11:30:32 +0000946 int i;
danielk19770b83fa82007-04-19 14:48:37 +0000947 if( db->aVTrans ){
dane4bec372014-12-18 18:25:48 +0000948 VTable **aVTrans = db->aVTrans;
949 db->aVTrans = 0;
drh748ce212009-05-20 20:10:47 +0000950 for(i=0; i<db->nVTrans; i++){
dane4bec372014-12-18 18:25:48 +0000951 VTable *pVTab = aVTrans[i];
danielk1977595a5232009-07-24 17:58:53 +0000952 sqlite3_vtab *p = pVTab->pVtab;
953 if( p ){
954 int (*x)(sqlite3_vtab *);
955 x = *(int (**)(sqlite3_vtab *))((char *)p->pModule + offset);
956 if( x ) x(p);
957 }
drh346506f2011-05-25 01:16:42 +0000958 pVTab->iSavepoint = 0;
danielk1977595a5232009-07-24 17:58:53 +0000959 sqlite3VtabUnlock(pVTab);
danielk19770b83fa82007-04-19 14:48:37 +0000960 }
dane4bec372014-12-18 18:25:48 +0000961 sqlite3DbFree(db, aVTrans);
danielk19770b83fa82007-04-19 14:48:37 +0000962 db->nVTrans = 0;
danielk1977e7ff4032006-06-17 11:30:32 +0000963 }
danielk1977e7ff4032006-06-17 11:30:32 +0000964}
965
966/*
danielk19773e3a84d2008-08-01 17:37:40 +0000967** Invoke the xSync method of all virtual tables in the sqlite3.aVTrans
968** array. Return the error code for the first error that occurs, or
969** SQLITE_OK if all xSync operations are successful.
970**
dan016f7812013-08-21 17:35:48 +0000971** If an error message is available, leave it in p->zErrMsg.
danielk1977f9e7dda2006-06-16 16:08:53 +0000972*/
dan016f7812013-08-21 17:35:48 +0000973int sqlite3VtabSync(sqlite3 *db, Vdbe *p){
danielk1977e7ff4032006-06-17 11:30:32 +0000974 int i;
975 int rc = SQLITE_OK;
danielk1977595a5232009-07-24 17:58:53 +0000976 VTable **aVTrans = db->aVTrans;
danielk197720b1eaf2006-07-26 16:22:14 +0000977
danielk197720b1eaf2006-07-26 16:22:14 +0000978 db->aVTrans = 0;
drh748ce212009-05-20 20:10:47 +0000979 for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
danielk1977e7ff4032006-06-17 11:30:32 +0000980 int (*x)(sqlite3_vtab *);
danielk1977595a5232009-07-24 17:58:53 +0000981 sqlite3_vtab *pVtab = aVTrans[i]->pVtab;
982 if( pVtab && (x = pVtab->pModule->xSync)!=0 ){
danielk1977e7ff4032006-06-17 11:30:32 +0000983 rc = x(pVtab);
dan016f7812013-08-21 17:35:48 +0000984 sqlite3VtabImportErrmsg(p, pVtab);
danielk1977e7ff4032006-06-17 11:30:32 +0000985 }
986 }
danielk197720b1eaf2006-07-26 16:22:14 +0000987 db->aVTrans = aVTrans;
danielk1977e7ff4032006-06-17 11:30:32 +0000988 return rc;
danielk1977f9e7dda2006-06-16 16:08:53 +0000989}
990
991/*
992** Invoke the xRollback method of all virtual tables in the
993** sqlite3.aVTrans array. Then clear the array itself.
994*/
995int sqlite3VtabRollback(sqlite3 *db){
drh7209c692008-04-27 18:40:11 +0000996 callFinaliser(db, offsetof(sqlite3_module,xRollback));
danielk1977e7ff4032006-06-17 11:30:32 +0000997 return SQLITE_OK;
danielk1977f9e7dda2006-06-16 16:08:53 +0000998}
999
1000/*
1001** Invoke the xCommit method of all virtual tables in the
1002** sqlite3.aVTrans array. Then clear the array itself.
1003*/
1004int sqlite3VtabCommit(sqlite3 *db){
drh7209c692008-04-27 18:40:11 +00001005 callFinaliser(db, offsetof(sqlite3_module,xCommit));
danielk1977e7ff4032006-06-17 11:30:32 +00001006 return SQLITE_OK;
danielk1977f9e7dda2006-06-16 16:08:53 +00001007}
1008
1009/*
1010** If the virtual table pVtab supports the transaction interface
1011** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
1012** not currently open, invoke the xBegin method now.
1013**
1014** If the xBegin call is successful, place the sqlite3_vtab pointer
1015** in the sqlite3.aVTrans array.
1016*/
danielk1977595a5232009-07-24 17:58:53 +00001017int sqlite3VtabBegin(sqlite3 *db, VTable *pVTab){
danielk1977f9e7dda2006-06-16 16:08:53 +00001018 int rc = SQLITE_OK;
danielk197720b1eaf2006-07-26 16:22:14 +00001019 const sqlite3_module *pModule;
1020
1021 /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
1022 ** than zero, then this function is being called from within a
1023 ** virtual module xSync() callback. It is illegal to write to
drh748ce212009-05-20 20:10:47 +00001024 ** virtual module tables in this case, so return SQLITE_LOCKED.
danielk197720b1eaf2006-07-26 16:22:14 +00001025 */
danielk1977093e0f62008-11-13 18:00:14 +00001026 if( sqlite3VtabInSync(db) ){
danielk197720b1eaf2006-07-26 16:22:14 +00001027 return SQLITE_LOCKED;
1028 }
danielk1977595a5232009-07-24 17:58:53 +00001029 if( !pVTab ){
danielk197720b1eaf2006-07-26 16:22:14 +00001030 return SQLITE_OK;
1031 }
danielk1977595a5232009-07-24 17:58:53 +00001032 pModule = pVTab->pVtab->pModule;
danielk197720b1eaf2006-07-26 16:22:14 +00001033
danielk1977f9e7dda2006-06-16 16:08:53 +00001034 if( pModule->xBegin ){
1035 int i;
1036
1037 /* If pVtab is already in the aVTrans array, return early */
drh748ce212009-05-20 20:10:47 +00001038 for(i=0; i<db->nVTrans; i++){
danielk1977595a5232009-07-24 17:58:53 +00001039 if( db->aVTrans[i]==pVTab ){
danielk1977f9e7dda2006-06-16 16:08:53 +00001040 return SQLITE_OK;
1041 }
1042 }
1043
dan2cac2072011-05-25 18:46:22 +00001044 /* Invoke the xBegin method. If successful, add the vtab to the
1045 ** sqlite3.aVTrans[] array. */
1046 rc = growVTrans(db);
danielk19773e3a84d2008-08-01 17:37:40 +00001047 if( rc==SQLITE_OK ){
dan2cac2072011-05-25 18:46:22 +00001048 rc = pModule->xBegin(pVTab->pVtab);
1049 if( rc==SQLITE_OK ){
dan65c4f592015-09-29 16:41:23 +00001050 int iSvpt = db->nStatement + db->nSavepoint;
dan2cac2072011-05-25 18:46:22 +00001051 addToVTrans(db, pVTab);
dan914b7e42016-08-02 11:29:16 +00001052 if( iSvpt && pModule->xSavepoint ){
1053 pVTab->iSavepoint = iSvpt;
1054 rc = pModule->xSavepoint(pVTab->pVtab, iSvpt-1);
1055 }
dan2cac2072011-05-25 18:46:22 +00001056 }
danielk1977f9e7dda2006-06-16 16:08:53 +00001057 }
danielk1977f9e7dda2006-06-16 16:08:53 +00001058 }
1059 return rc;
1060}
1061
dand9495cd2011-04-27 12:08:04 +00001062/*
1063** Invoke either the xSavepoint, xRollbackTo or xRelease method of all
1064** virtual tables that currently have an open transaction. Pass iSavepoint
1065** as the second argument to the virtual table method invoked.
1066**
1067** If op is SAVEPOINT_BEGIN, the xSavepoint method is invoked. If it is
1068** SAVEPOINT_ROLLBACK, the xRollbackTo method. Otherwise, if op is
1069** SAVEPOINT_RELEASE, then the xRelease method of each virtual table with
1070** an open transaction is invoked.
1071**
1072** If any virtual table method returns an error code other than SQLITE_OK,
1073** processing is abandoned and the error returned to the caller of this
1074** function immediately. If all calls to virtual table methods are successful,
1075** SQLITE_OK is returned.
1076*/
dana311b802011-04-26 19:21:34 +00001077int sqlite3VtabSavepoint(sqlite3 *db, int op, int iSavepoint){
dana311b802011-04-26 19:21:34 +00001078 int rc = SQLITE_OK;
1079
1080 assert( op==SAVEPOINT_RELEASE||op==SAVEPOINT_ROLLBACK||op==SAVEPOINT_BEGIN );
danea8562e2015-04-18 16:25:54 +00001081 assert( iSavepoint>=-1 );
dand9495cd2011-04-27 12:08:04 +00001082 if( db->aVTrans ){
1083 int i;
1084 for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
drhe4855222011-05-24 15:36:01 +00001085 VTable *pVTab = db->aVTrans[i];
1086 const sqlite3_module *pMod = pVTab->pMod->pModule;
dan341cade2011-10-29 11:43:04 +00001087 if( pVTab->pVtab && pMod->iVersion>=2 ){
dand9495cd2011-04-27 12:08:04 +00001088 int (*xMethod)(sqlite3_vtab *, int);
dan83a635a2019-02-04 16:25:40 +00001089 sqlite3VtabLock(pVTab);
dand9495cd2011-04-27 12:08:04 +00001090 switch( op ){
1091 case SAVEPOINT_BEGIN:
1092 xMethod = pMod->xSavepoint;
drh346506f2011-05-25 01:16:42 +00001093 pVTab->iSavepoint = iSavepoint+1;
dand9495cd2011-04-27 12:08:04 +00001094 break;
1095 case SAVEPOINT_ROLLBACK:
1096 xMethod = pMod->xRollbackTo;
1097 break;
1098 default:
1099 xMethod = pMod->xRelease;
1100 break;
1101 }
drh346506f2011-05-25 01:16:42 +00001102 if( xMethod && pVTab->iSavepoint>iSavepoint ){
dan341cade2011-10-29 11:43:04 +00001103 rc = xMethod(pVTab->pVtab, iSavepoint);
drh346506f2011-05-25 01:16:42 +00001104 }
dan83a635a2019-02-04 16:25:40 +00001105 sqlite3VtabUnlock(pVTab);
dana311b802011-04-26 19:21:34 +00001106 }
1107 }
1108 }
1109 return rc;
1110}
1111
drhb7f6f682006-07-08 17:06:43 +00001112/*
1113** The first parameter (pDef) is a function implementation. The
1114** second parameter (pExpr) is the first argument to this function.
1115** If pExpr is a column in a virtual table, then let the virtual
1116** table implementation have an opportunity to overload the function.
1117**
1118** This routine is used to allow virtual table implementations to
1119** overload MATCH, LIKE, GLOB, and REGEXP operators.
1120**
1121** Return either the pDef argument (indicating no change) or a
1122** new FuncDef structure that is marked as ephemeral using the
1123** SQLITE_FUNC_EPHEM flag.
1124*/
1125FuncDef *sqlite3VtabOverloadFunction(
drh17435752007-08-16 04:30:38 +00001126 sqlite3 *db, /* Database connection for reporting malloc problems */
drhb7f6f682006-07-08 17:06:43 +00001127 FuncDef *pDef, /* Function to possibly overload */
1128 int nArg, /* Number of arguments to the function */
1129 Expr *pExpr /* First argument to the function */
1130){
1131 Table *pTab;
1132 sqlite3_vtab *pVtab;
1133 sqlite3_module *pMod;
drh2d801512016-01-14 22:19:58 +00001134 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**) = 0;
drhdc5ea5c2008-12-10 17:19:59 +00001135 void *pArg = 0;
drhb7f6f682006-07-08 17:06:43 +00001136 FuncDef *pNew;
drh777b17a2007-09-20 10:02:54 +00001137 int rc = 0;
drhb7f6f682006-07-08 17:06:43 +00001138
1139 /* Check to see the left operand is a column in a virtual table */
drh748ce212009-05-20 20:10:47 +00001140 if( NEVER(pExpr==0) ) return pDef;
drhb7f6f682006-07-08 17:06:43 +00001141 if( pExpr->op!=TK_COLUMN ) return pDef;
drh477572b2021-10-07 20:46:29 +00001142 assert( ExprUseYTab(pExpr) );
drheda079c2018-09-20 19:02:15 +00001143 pTab = pExpr->y.pTab;
drh63b3a642022-10-20 13:36:32 +00001144 if( NEVER(pTab==0) ) return pDef;
drh44266ec2017-02-16 14:48:08 +00001145 if( !IsVirtual(pTab) ) return pDef;
danielk1977595a5232009-07-24 17:58:53 +00001146 pVtab = sqlite3GetVTable(db, pTab)->pVtab;
drhb7f6f682006-07-08 17:06:43 +00001147 assert( pVtab!=0 );
1148 assert( pVtab->pModule!=0 );
danielk19775bd270b2006-07-25 15:14:52 +00001149 pMod = (sqlite3_module *)pVtab->pModule;
drhb7f6f682006-07-08 17:06:43 +00001150 if( pMod->xFindFunction==0 ) return pDef;
1151
rseb72e88d2007-09-20 11:32:18 +00001152 /* Call the xFindFunction method on the virtual table implementation
drh92011842018-05-26 16:00:26 +00001153 ** to see if the implementation wants to overload this function.
1154 **
1155 ** Though undocumented, we have historically always invoked xFindFunction
1156 ** with an all lower-case function name. Continue in this tradition to
1157 ** avoid any chance of an incompatibility.
drha70034d2006-09-18 20:24:02 +00001158 */
drh92011842018-05-26 16:00:26 +00001159#ifdef SQLITE_DEBUG
1160 {
1161 int i;
1162 for(i=0; pDef->zName[i]; i++){
1163 unsigned char x = (unsigned char)pDef->zName[i];
1164 assert( x==sqlite3UpperToLower[x] );
drh17435752007-08-16 04:30:38 +00001165 }
drha70034d2006-09-18 20:24:02 +00001166 }
drh92011842018-05-26 16:00:26 +00001167#endif
1168 rc = pMod->xFindFunction(pVtab, nArg, pDef->zName, &xSFunc, &pArg);
drha70034d2006-09-18 20:24:02 +00001169 if( rc==0 ){
drhb7f6f682006-07-08 17:06:43 +00001170 return pDef;
1171 }
1172
1173 /* Create a new ephemeral function definition for the overloaded
1174 ** function */
drhea678832008-12-10 19:26:22 +00001175 pNew = sqlite3DbMallocZero(db, sizeof(*pNew)
danielk1977e25a50b2009-07-01 18:04:20 +00001176 + sqlite3Strlen30(pDef->zName) + 1);
drhb7f6f682006-07-08 17:06:43 +00001177 if( pNew==0 ){
1178 return pDef;
1179 }
1180 *pNew = *pDef;
drh6ad224e2016-02-24 19:57:11 +00001181 pNew->zName = (const char*)&pNew[1];
1182 memcpy((char*)&pNew[1], pDef->zName, sqlite3Strlen30(pDef->zName)+1);
drh2d801512016-01-14 22:19:58 +00001183 pNew->xSFunc = xSFunc;
drhb7f6f682006-07-08 17:06:43 +00001184 pNew->pUserData = pArg;
drhd36e1042013-09-06 13:10:12 +00001185 pNew->funcFlags |= SQLITE_FUNC_EPHEM;
drhb7f6f682006-07-08 17:06:43 +00001186 return pNew;
1187}
1188
drh4f3dd152008-04-28 18:46:43 +00001189/*
1190** Make sure virtual table pTab is contained in the pParse->apVirtualLock[]
1191** array so that an OP_VBegin will get generated for it. Add pTab to the
1192** array if it is missing. If pTab is already in the array, this routine
1193** is a no-op.
1194*/
1195void sqlite3VtabMakeWritable(Parse *pParse, Table *pTab){
dan65a7cd12009-09-01 12:16:01 +00001196 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drh4f3dd152008-04-28 18:46:43 +00001197 int i, n;
drh748ce212009-05-20 20:10:47 +00001198 Table **apVtabLock;
1199
drh4f3dd152008-04-28 18:46:43 +00001200 assert( IsVirtual(pTab) );
dan65a7cd12009-09-01 12:16:01 +00001201 for(i=0; i<pToplevel->nVtabLock; i++){
1202 if( pTab==pToplevel->apVtabLock[i] ) return;
drh4f3dd152008-04-28 18:46:43 +00001203 }
dan65a7cd12009-09-01 12:16:01 +00001204 n = (pToplevel->nVtabLock+1)*sizeof(pToplevel->apVtabLock[0]);
drhd924e7b2020-05-17 00:26:44 +00001205 apVtabLock = sqlite3Realloc(pToplevel->apVtabLock, n);
drh748ce212009-05-20 20:10:47 +00001206 if( apVtabLock ){
dan65a7cd12009-09-01 12:16:01 +00001207 pToplevel->apVtabLock = apVtabLock;
1208 pToplevel->apVtabLock[pToplevel->nVtabLock++] = pTab;
drh344c38e2008-05-05 13:23:04 +00001209 }else{
drh4a642b62016-02-05 01:55:27 +00001210 sqlite3OomFault(pToplevel->db);
drh4f3dd152008-04-28 18:46:43 +00001211 }
1212}
1213
drhef45bb72011-05-05 15:39:50 +00001214/*
drh0b2c1402016-06-03 18:21:04 +00001215** Check to see if virtual table module pMod can be have an eponymous
drh51be3872015-08-19 02:32:25 +00001216** virtual table instance. If it can, create one if one does not already
danbd24e8f2021-07-08 18:29:25 +00001217** exist. Return non-zero if either the eponymous virtual table instance
1218** exists when this routine returns or if an attempt to create it failed
1219** and an error message was left in pParse.
drh51be3872015-08-19 02:32:25 +00001220**
1221** An eponymous virtual table instance is one that is named after its
1222** module, and more importantly, does not require a CREATE VIRTUAL TABLE
1223** statement in order to come into existance. Eponymous virtual table
1224** instances always exist. They cannot be DROP-ed.
1225**
1226** Any virtual table module for which xConnect and xCreate are the same
1227** method can have an eponymous virtual table instance.
1228*/
1229int sqlite3VtabEponymousTableInit(Parse *pParse, Module *pMod){
1230 const sqlite3_module *pModule = pMod->pModule;
1231 Table *pTab;
1232 char *zErr = 0;
drh51be3872015-08-19 02:32:25 +00001233 int rc;
1234 sqlite3 *db = pParse->db;
1235 if( pMod->pEpoTab ) return 1;
drh398f8722015-08-19 13:54:20 +00001236 if( pModule->xCreate!=0 && pModule->xCreate!=pModule->xConnect ) return 0;
drh0b2c1402016-06-03 18:21:04 +00001237 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh51be3872015-08-19 02:32:25 +00001238 if( pTab==0 ) return 0;
drh0b2c1402016-06-03 18:21:04 +00001239 pTab->zName = sqlite3DbStrDup(db, pMod->zName);
1240 if( pTab->zName==0 ){
1241 sqlite3DbFree(db, pTab);
1242 return 0;
1243 }
drh51be3872015-08-19 02:32:25 +00001244 pMod->pEpoTab = pTab;
drh79df7782016-12-14 14:07:35 +00001245 pTab->nTabRef = 1;
drhf38524d2021-08-02 16:41:57 +00001246 pTab->eTabType = TABTYP_VTAB;
drh51be3872015-08-19 02:32:25 +00001247 pTab->pSchema = db->aDb[0].pSchema;
drhf38524d2021-08-02 16:41:57 +00001248 assert( pTab->u.vtab.nArg==0 );
drh509c3fc2015-08-19 19:01:28 +00001249 pTab->iPKey = -1;
drh3d8c92d2021-04-22 18:02:48 +00001250 pTab->tabFlags |= TF_Eponymous;
drh0aa32312019-04-13 04:01:12 +00001251 addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
1252 addModuleArgument(pParse, pTab, 0);
1253 addModuleArgument(pParse, pTab, sqlite3DbStrDup(db, pTab->zName));
drh51be3872015-08-19 02:32:25 +00001254 rc = vtabCallConstructor(db, pTab, pMod, pModule->xConnect, &zErr);
1255 if( rc ){
1256 sqlite3ErrorMsg(pParse, "%s", zErr);
1257 sqlite3DbFree(db, zErr);
1258 sqlite3VtabEponymousTableClear(db, pMod);
drh51be3872015-08-19 02:32:25 +00001259 }
1260 return 1;
1261}
1262
1263/*
1264** Erase the eponymous virtual table instance associated with
1265** virtual table module pMod, if it exists.
1266*/
1267void sqlite3VtabEponymousTableClear(sqlite3 *db, Module *pMod){
1268 Table *pTab = pMod->pEpoTab;
drhd7fd6aa2015-10-08 02:44:42 +00001269 if( pTab!=0 ){
drh0b2c1402016-06-03 18:21:04 +00001270 /* Mark the table as Ephemeral prior to deleting it, so that the
1271 ** sqlite3DeleteTable() routine will know that it is not stored in
1272 ** the schema. */
1273 pTab->tabFlags |= TF_Ephemeral;
1274 sqlite3DeleteTable(db, pTab);
drh51be3872015-08-19 02:32:25 +00001275 pMod->pEpoTab = 0;
1276 }
1277}
1278
1279/*
drhef45bb72011-05-05 15:39:50 +00001280** Return the ON CONFLICT resolution mode in effect for the virtual
1281** table update operation currently in progress.
1282**
1283** The results of this routine are undefined unless it is called from
1284** within an xUpdate method.
1285*/
danb061d052011-04-25 18:49:57 +00001286int sqlite3_vtab_on_conflict(sqlite3 *db){
drhef45bb72011-05-05 15:39:50 +00001287 static const unsigned char aMap[] = {
drh87f67bf2011-05-05 17:41:58 +00001288 SQLITE_ROLLBACK, SQLITE_ABORT, SQLITE_FAIL, SQLITE_IGNORE, SQLITE_REPLACE
danb061d052011-04-25 18:49:57 +00001289 };
drh9ca95732014-10-24 00:35:58 +00001290#ifdef SQLITE_ENABLE_API_ARMOR
1291 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1292#endif
danb061d052011-04-25 18:49:57 +00001293 assert( OE_Rollback==1 && OE_Abort==2 && OE_Fail==3 );
1294 assert( OE_Ignore==4 && OE_Replace==5 );
1295 assert( db->vtabOnConflict>=1 && db->vtabOnConflict<=5 );
drhef45bb72011-05-05 15:39:50 +00001296 return (int)aMap[db->vtabOnConflict-1];
danb061d052011-04-25 18:49:57 +00001297}
1298
drhef45bb72011-05-05 15:39:50 +00001299/*
1300** Call from within the xCreate() or xConnect() methods to provide
1301** the SQLite core with additional information about the behavior
1302** of the virtual table being implemented.
1303*/
danb061d052011-04-25 18:49:57 +00001304int sqlite3_vtab_config(sqlite3 *db, int op, ...){
1305 va_list ap;
1306 int rc = SQLITE_OK;
drh2928a152020-01-06 15:25:41 +00001307 VtabCtx *p;
danb061d052011-04-25 18:49:57 +00001308
drh9ca95732014-10-24 00:35:58 +00001309#ifdef SQLITE_ENABLE_API_ARMOR
1310 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1311#endif
danb061d052011-04-25 18:49:57 +00001312 sqlite3_mutex_enter(db->mutex);
drh2928a152020-01-06 15:25:41 +00001313 p = db->pVtabCtx;
1314 if( !p ){
1315 rc = SQLITE_MISUSE_BKPT;
1316 }else{
1317 assert( p->pTab==0 || IsVirtual(p->pTab) );
1318 va_start(ap, op);
1319 switch( op ){
1320 case SQLITE_VTAB_CONSTRAINT_SUPPORT: {
danb061d052011-04-25 18:49:57 +00001321 p->pVTable->bConstraint = (u8)va_arg(ap, int);
drh2928a152020-01-06 15:25:41 +00001322 break;
danb061d052011-04-25 18:49:57 +00001323 }
drh2928a152020-01-06 15:25:41 +00001324 case SQLITE_VTAB_INNOCUOUS: {
1325 p->pVTable->eVtabRisk = SQLITE_VTABRISK_Low;
1326 break;
1327 }
1328 case SQLITE_VTAB_DIRECTONLY: {
1329 p->pVTable->eVtabRisk = SQLITE_VTABRISK_High;
1330 break;
1331 }
1332 default: {
1333 rc = SQLITE_MISUSE_BKPT;
1334 break;
1335 }
danb061d052011-04-25 18:49:57 +00001336 }
drh2928a152020-01-06 15:25:41 +00001337 va_end(ap);
danb061d052011-04-25 18:49:57 +00001338 }
danb061d052011-04-25 18:49:57 +00001339
drh13f40da2014-08-22 18:00:11 +00001340 if( rc!=SQLITE_OK ) sqlite3Error(db, rc);
danb061d052011-04-25 18:49:57 +00001341 sqlite3_mutex_leave(db->mutex);
1342 return rc;
1343}
1344
drhb9bb7c12006-06-11 23:41:55 +00001345#endif /* SQLITE_OMIT_VIRTUALTABLE */