Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Fix several compilation errors and warnings. More work in progress on docs. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | virtualTables |
Files: | files | file ages | folders |
SHA1: |
d0f5ab8e16d12597a744e3bb0a531382 |
User & Date: | mistachkin 2013-06-25 01:25:22.967 |
Context
2013-06-25
| ||
02:06 | Modify marshalling for the xUpdate method. More work on docs. check-in: 7825b411c7 user: mistachkin tags: virtualTables | |
01:25 | Fix several compilation errors and warnings. More work in progress on docs. check-in: d0f5ab8e16 user: mistachkin tags: virtualTables | |
2013-06-24
| ||
22:50 | Merge updates from trunk. check-in: d4f5e0a0ef user: mistachkin tags: virtualTables | |
Changes
Changes to System.Data.SQLite/SQLiteModule.cs.
︙ | ︙ | |||
45 46 47 48 49 50 51 | /////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Members /// <summary> /// Returns the underlying SQLite native handle associated with this /// object instance. /// </summary> | | | 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | /////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Members /// <summary> /// Returns the underlying SQLite native handle associated with this /// object instance. /// </summary> public IntPtr NativeHandle { get { return pContext; } } #endregion /////////////////////////////////////////////////////////////////////// |
︙ | ︙ | |||
223 224 225 226 227 228 229 | UnsafeNativeMethods.sqlite3_result_error_nomem(pContext); } /////////////////////////////////////////////////////////////////////// /// <summary> | | | | | 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | UnsafeNativeMethods.sqlite3_result_error_nomem(pContext); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Sets the context result to the specified <see cref="System.Byte" /> /// array value. /// </summary> /// <param name="value"> /// The <see cref="System.Byte" /> array value to use. /// </param> public void SetBlob(byte[] value) { if (pContext == IntPtr.Zero) throw new InvalidOperationException(); if (value == null) |
︙ | ︙ | |||
299 300 301 302 303 304 305 | /////////////////////////////////////////////////////////////////////// #region Private Constructors /// <summary> /// Constructs an instance of this class using the specified native /// value handle. /// </summary> | | | 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | /////////////////////////////////////////////////////////////////////// #region Private Constructors /// <summary> /// Constructs an instance of this class using the specified native /// value handle. /// </summary> /// <param name="pValue"> /// The native value handle to use. /// </param> internal SQLiteValue(IntPtr pValue) { this.pValue = pValue; } #endregion |
︙ | ︙ | |||
328 329 330 331 332 333 334 | /////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Members /// <summary> /// Returns the underlying SQLite native handle associated with this /// object instance. /// </summary> | | | 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | /////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Members /// <summary> /// Returns the underlying SQLite native handle associated with this /// object instance. /// </summary> public IntPtr NativeHandle { get { return pValue; } } #endregion /////////////////////////////////////////////////////////////////////// |
︙ | ︙ | |||
485 486 487 488 489 490 491 | if (pValue == IntPtr.Zero) return null; return SQLiteString.StringFromUtf8IntPtr(pValue, GetBytes()); } /////////////////////////////////////////////////////////////////////// /// <summary> | | | | | 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | if (pValue == IntPtr.Zero) return null; return SQLiteString.StringFromUtf8IntPtr(pValue, GetBytes()); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Gets and returns the <see cref="System.Byte" /> array associated /// with this value. /// </summary> /// <returns> /// The <see cref="System.Byte" /> array associated with this value. /// </returns> public byte[] GetBlob() { if (pValue == IntPtr.Zero) return null; return SQLiteMarshal.BytesFromIntPtr(pValue, GetBytes()); } |
︙ | ︙ | |||
1001 1002 1003 1004 1005 1006 1007 | /// This class represents the various inputs and outputs used with the /// <see cref="ISQLiteManagedModule.BestIndex" /> method. /// </summary> public sealed class SQLiteIndex { #region Internal Constructors /// <summary> | | > > | > | > > | > > | | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 | /// This class represents the various inputs and outputs used with the /// <see cref="ISQLiteManagedModule.BestIndex" /> method. /// </summary> public sealed class SQLiteIndex { #region Internal Constructors /// <summary> /// Constructs an instance of this class. /// </summary> /// <param name="nConstraint"> /// The number of <see cref="SQLiteIndexConstraint" /> (and /// <see cref="SQLiteIndexConstraintUsage" />) instances to /// pre-allocate space for. /// </param> /// <param name="nOrderBy"> /// The number of <see cref="SQLiteIndexOrderBy" /> instances to /// pre-allocate space for. /// </param> internal SQLiteIndex( int nConstraint, int nOrderBy ) { inputs = new SQLiteIndexInputs(nConstraint, nOrderBy); outputs = new SQLiteIndexOutputs(nConstraint); } #endregion /////////////////////////////////////////////////////////////////////// #region Public Properties private SQLiteIndexInputs inputs; /// <summary> /// The <see cref="SQLiteIndexInputs" /> object instance containing /// the inputs to the <see cref="ISQLiteManagedModule.BestIndex" /> /// method. /// </summary> public SQLiteIndexInputs Inputs { get { return inputs; } } /////////////////////////////////////////////////////////////////////// private SQLiteIndexOutputs outputs; /// <summary> /// The <see cref="SQLiteIndexOutputs" /> object instance containing /// the outputs from the <see cref="ISQLiteManagedModule.BestIndex" /> /// method. /// </summary> public SQLiteIndexOutputs Outputs { get { return outputs; } } #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteVirtualTable Base Class /// <summary> /// This class represents a managed virtual table implementation. It is /// not sealed and should be used as the base class for any user-defined /// virtual tables implemented in managed code. /// </summary> public class SQLiteVirtualTable : ISQLiteNativeHandle, IDisposable /* NOT SEALED */ { #region Private Constants /// <summary> /// The index within the array of strings provided to the /// <see cref="ISQLiteManagedModule.Create" /> and /// <see cref="ISQLiteManagedModule.Connect" /> methods containing the /// name of the module implementing this virtual table. /// </summary> private const int ModuleNameIndex = 0; /////////////////////////////////////////////////////////////////////// /// <summary> /// The index within the array of strings provided to the /// <see cref="ISQLiteManagedModule.Create" /> and /// <see cref="ISQLiteManagedModule.Connect" /> methods containing the /// name of the database containing this virtual table. /// </summary> private const int DatabaseNameIndex = 1; /////////////////////////////////////////////////////////////////////// /// <summary> /// The index within the array of strings provided to the /// <see cref="ISQLiteManagedModule.Create" /> and /// <see cref="ISQLiteManagedModule.Connect" /> methods containing the /// name of the virtual table. /// </summary> private const int TableNameIndex = 2; #endregion /////////////////////////////////////////////////////////////////////// #region Public Constructors /// <summary> /// Constructs an instance of this class. /// </summary> /// <param name="arguments"> /// The original array of strings provided to the /// <see cref="ISQLiteManagedModule.Create" /> and /// <see cref="ISQLiteManagedModule.Connect" /> methods. /// </param> public SQLiteVirtualTable( string[] arguments ) { this.arguments = arguments; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Properties private string[] arguments; /// <summary> /// The original array of strings provided to the /// <see cref="ISQLiteManagedModule.Create" /> and /// <see cref="ISQLiteManagedModule.Connect" /> methods. /// </summary> public virtual string[] Arguments { get { CheckDisposed(); return arguments; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// The name of the module implementing this virtual table. /// </summary> public virtual string ModuleName { get { CheckDisposed(); string[] arguments = Arguments; |
︙ | ︙ | |||
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 | return null; } } } /////////////////////////////////////////////////////////////////////// public virtual string DatabaseName { get { CheckDisposed(); string[] arguments = Arguments; | > > > | 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 | return null; } } } /////////////////////////////////////////////////////////////////////// /// <summary> /// The name of the database containing this virtual table. /// </summary> public virtual string DatabaseName { get { CheckDisposed(); string[] arguments = Arguments; |
︙ | ︙ | |||
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 | return null; } } } /////////////////////////////////////////////////////////////////////// public virtual string TableName { get { CheckDisposed(); string[] arguments = Arguments; | > > > | 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 | return null; } } } /////////////////////////////////////////////////////////////////////// /// <summary> /// The name of the virtual table. /// </summary> public virtual string TableName { get { CheckDisposed(); string[] arguments = Arguments; |
︙ | ︙ | |||
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods public virtual bool Rename( string name ) { CheckDisposed(); if ((arguments != null) && | > > > > > > > > > > | 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods /// <summary> /// Attempts to record the renaming of the virtual table associated /// with this object instance. /// </summary> /// <param name="name"> /// The new name for the virtual table. /// </param> /// <returns> /// Non-zero upon success. /// </returns> public virtual bool Rename( string name ) { CheckDisposed(); if ((arguments != null) && |
︙ | ︙ | |||
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 | internal set { nativeHandle = value; } } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable Members public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable "Pattern" Members private bool disposed; private void CheckDisposed() /* throw */ { #if THROW_ON_DISPOSED if (disposed) { throw new ObjectDisposedException( typeof(SQLiteVirtualTable).Name); } #endif } /////////////////////////////////////////////////////////////////////// protected virtual void Dispose(bool disposing) { if (!disposed) { //if (disposing) //{ // //////////////////////////////////// // // dispose managed resources here... // //////////////////////////////////// //} ////////////////////////////////////// // release unmanaged resources here... ////////////////////////////////////// disposed = true; } } #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteVirtualTableCursor Base Class | > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 | internal set { nativeHandle = value; } } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable Members /// <summary> /// Disposes of this object instance. /// </summary> public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable "Pattern" Members private bool disposed; /// <summary> /// Throws an <see cref="System.ObjectDisposedException"/> if this /// object instance has been disposed. /// </summary> private void CheckDisposed() /* throw */ { #if THROW_ON_DISPOSED if (disposed) { throw new ObjectDisposedException( typeof(SQLiteVirtualTable).Name); } #endif } /////////////////////////////////////////////////////////////////////// /// <summary> /// Disposes of this object instance. /// </summary> /// <param name="disposing"> /// Non-zero if this method is being called from the /// <see cref="Dispose()" /> method. Zero if this method is being called /// from the finalizer. /// </param> protected virtual void Dispose(bool disposing) { if (!disposed) { //if (disposing) //{ // //////////////////////////////////// // // dispose managed resources here... // //////////////////////////////////// //} ////////////////////////////////////// // release unmanaged resources here... ////////////////////////////////////// disposed = true; } } #endregion /////////////////////////////////////////////////////////////////////// #region Destructor /// <summary> /// Finalizes this object instance. /// </summary> ~SQLiteVirtualTable() { Dispose(false); } #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteVirtualTableCursor Base Class /// <summary> /// This class represents a managed virtual table cursor implementation. /// It is not sealed and should be used as the base class for any /// user-defined virtual table cursor implemented in managed code. /// </summary> public class SQLiteVirtualTableCursor : ISQLiteNativeHandle, IDisposable /* NOT SEALED */ { #region Public Constructors /// <summary> /// Constructs an instance of this class. /// </summary> /// <param name="table"> /// The <see cref="SQLiteVirtualTable" /> object instance associated /// with this object instance. /// </param> public SQLiteVirtualTableCursor( SQLiteVirtualTable table ) { this.table = table; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Properties private SQLiteVirtualTable table; /// <summary> /// The <see cref="SQLiteVirtualTable" /> object instance associated /// with this object instance. /// </summary> public virtual SQLiteVirtualTable Table { get { CheckDisposed(); return table; } } /////////////////////////////////////////////////////////////////////// private int indexNumber; /// <summary> /// Number used to help identify the selected index. This value will /// be set via the <see cref="Filter" /> method. /// </summary> public virtual int IndexNumber { get { CheckDisposed(); return indexNumber; } } /////////////////////////////////////////////////////////////////////// private string indexString; /// <summary> /// String used to help identify the selected index. This value will /// be set via the <see cref="Filter" /> method. /// </summary> public virtual string IndexString { get { CheckDisposed(); return indexString; } } /////////////////////////////////////////////////////////////////////// private SQLiteValue[] values; /// <summary> /// The values used to filter the rows returned via this cursor object /// instance. This value will be set via the <see cref="Filter" /> /// method. /// </summary> public virtual SQLiteValue[] Values { get { CheckDisposed(); return values; } } #endregion /////////////////////////////////////////////////////////////////////// #region Protected Methods /// <summary> /// Attempts to persist the specified <see cref="SQLiteValue" /> object /// instances in order to make them available after the /// <see cref="ISQLiteManagedModule.Filter" /> method returns. /// </summary> /// <param name="values"> /// The array of <see cref="SQLiteValue" /> object instances to be /// persisted. /// </param> /// <returns> /// The number of <see cref="SQLiteValue" /> object instances that were /// successfully persisted. /// </returns> protected virtual int TryPersistValues( SQLiteValue[] values ) { int result = 0; if (values != null) |
︙ | ︙ | |||
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 | return result; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods public virtual void Filter( int indexNumber, string indexString, SQLiteValue[] values ) { CheckDisposed(); | > > > > > > > > > > > > > > > | 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 | return result; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods /// <summary> /// This method should normally be used by the /// <see cref="ISQLiteManagedModule.Filter" /> method in order to /// perform filtering of the result rows and/or to record the filtering /// criteria provided by the SQLite core library. /// </summary> /// <param name="indexNumber"> /// Number used to help identify the selected index. /// </param> /// <param name="indexString"> /// String used to help identify the selected index. /// </param> /// <param name="values"> /// The values corresponding to each column in the selected index. /// </param> public virtual void Filter( int indexNumber, string indexString, SQLiteValue[] values ) { CheckDisposed(); |
︙ | ︙ | |||
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 | internal set { nativeHandle = value; } } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable Members public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable "Pattern" Members private bool disposed; private void CheckDisposed() /* throw */ { #if THROW_ON_DISPOSED if (disposed) { throw new ObjectDisposedException( typeof(SQLiteVirtualTableCursor).Name); } #endif } /////////////////////////////////////////////////////////////////////// protected virtual void Dispose(bool disposing) { if (!disposed) { //if (disposing) //{ // //////////////////////////////////// | > > > > > > > > > > > > > > > | 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 | internal set { nativeHandle = value; } } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable Members /// <summary> /// Disposes of this object instance. /// </summary> public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion /////////////////////////////////////////////////////////////////////// #region IDisposable "Pattern" Members private bool disposed; /// <summary> /// Throws an <see cref="System.ObjectDisposedException"/> if this /// object instance has been disposed. /// </summary> private void CheckDisposed() /* throw */ { #if THROW_ON_DISPOSED if (disposed) { throw new ObjectDisposedException( typeof(SQLiteVirtualTableCursor).Name); } #endif } /////////////////////////////////////////////////////////////////////// /// <summary> /// Disposes of this object instance. /// </summary> /// <param name="disposing"> /// Non-zero if this method is being called from the /// <see cref="Dispose()" /> method. Zero if this method is being called /// from the finalizer. /// </param> protected virtual void Dispose(bool disposing) { if (!disposed) { //if (disposing) //{ // //////////////////////////////////// |
︙ | ︙ | |||
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Destructor ~SQLiteVirtualTableCursor() { Dispose(false); } #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Interface public interface ISQLiteNativeHandle { IntPtr NativeHandle { get; } } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteNativeModule Interface public interface ISQLiteNativeModule { SQLiteErrorCode xCreate( IntPtr pDb, IntPtr pAux, int argc, IntPtr[] argv, ref IntPtr pVtab, ref IntPtr pError ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xConnect( IntPtr pDb, IntPtr pAux, int argc, IntPtr[] argv, ref IntPtr pVtab, ref IntPtr pError ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xBestIndex( IntPtr pVtab, IntPtr pIndex ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xDisconnect( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xDestroy( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xOpen( IntPtr pVtab, ref IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xClose( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xFilter( IntPtr pCursor, int idxNum, IntPtr idxStr, int argc, IntPtr[] argv ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xNext( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// int xEof( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xColumn( IntPtr pCursor, IntPtr pContext, int index ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xRowId( IntPtr pCursor, ref long rowId ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xUpdate( IntPtr pVtab, int nData, IntPtr apData, ref long rowId ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xBegin( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xSync( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xCommit( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xRollback( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// int xFindFunction( IntPtr pVtab, int nArg, IntPtr zName, ref SQLiteCallback callback, ref IntPtr pClientData ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xRename( IntPtr pVtab, IntPtr zNew ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xSavepoint( IntPtr pVtab, int iSavepoint ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xRelease( IntPtr pVtab, int iSavepoint ); /////////////////////////////////////////////////////////////////////// SQLiteErrorCode xRollbackTo( IntPtr pVtab, int iSavepoint ); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteManagedModule Interface public interface ISQLiteManagedModule { bool Declared { get; } string Name { get; } /////////////////////////////////////////////////////////////////////// SQLiteErrorCode Create( SQLiteConnection connection, /* in */ IntPtr pClientData, /* in */ | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Destructor /// <summary> /// Finalizes this object instance. /// </summary> ~SQLiteVirtualTableCursor() { Dispose(false); } #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteNativeHandle Interface /// <summary> /// This interface represents a native handle provided by the SQLite core /// library. /// </summary> public interface ISQLiteNativeHandle { /// <summary> /// The native handle value. /// </summary> IntPtr NativeHandle { get; } } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteNativeModule Interface /// <summary> /// This interface represents a virtual table implementation written in /// native code. /// </summary> public interface ISQLiteNativeModule { /// <summary> /// This method is called to create a new instance of a virtual table /// in response to a CREATE VIRTUAL TABLE statement. The db parameter /// is a pointer to the SQLite database connection that is executing /// the CREATE VIRTUAL TABLE statement. The pAux argument is the copy /// of the client data pointer that was the fourth argument to the /// sqlite3_create_module() or sqlite3_create_module_v2() call that /// registered the virtual table module. The argv parameter is an /// array of argc pointers to null terminated strings. The first /// string, argv[0], is the name of the module being invoked. The /// module name is the name provided as the second argument to /// sqlite3_create_module() and as the argument to the USING clause of /// the CREATE VIRTUAL TABLE statement that is running. The second, /// argv[1], is the name of the database in which the new virtual table /// is being created. The database name is "main" for the primary /// database, or "temp" for TEMP database, or the name given at the /// end of the ATTACH statement for attached databases. The third /// element of the array, argv[2], is the name of the new virtual /// table, as specified following the TABLE keyword in the CREATE /// VIRTUAL TABLE statement. If present, the fourth and subsequent /// strings in the argv[] array report the arguments to the module name /// in the CREATE VIRTUAL TABLE statement. /// /// The job of this method is to construct the new virtual table object /// (an sqlite3_vtab object) and return a pointer to it in *ppVTab. /// /// As part of the task of creating a new sqlite3_vtab structure, this /// method must invoke sqlite3_declare_vtab() to tell the SQLite core /// about the columns and datatypes in the virtual table. The /// sqlite3_declare_vtab() API has the following prototype: /// /// int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) /// /// The first argument to sqlite3_declare_vtab() must be the same /// database connection pointer as the first parameter to this method. /// The second argument to sqlite3_declare_vtab() must a /// zero-terminated UTF-8 string that contains a well-formed CREATE /// TABLE statement that defines the columns in the virtual table and /// their data types. The name of the table in this CREATE TABLE /// statement is ignored, as are all constraints. Only the column names /// and datatypes matter. The CREATE TABLE statement string need not to /// be held in persistent memory. The string can be deallocated and/or /// reused as soon as the sqlite3_declare_vtab() routine returns. /// </summary> /// <param name="pDb"> /// The native database connection handle. /// </param> /// <param name="pAux"> /// The original native pointer value that was provided to the /// sqlite3_create_module(), sqlite3_create_module_v2() or /// sqlite3_create_disposable_module() functions. /// </param> /// <param name="argc"> /// The number of arguments from the CREATE VIRTUAL TABLE statement. /// </param> /// <param name="argv"> /// The array of string arguments from the CREATE VIRTUAL TABLE /// statement. /// </param> /// <param name="pVtab"> /// Upon success, this parameter must be modified to point to the newly /// created native sqlite3_vtab derived structure. /// </param> /// <param name="pError"> /// Upon failure, this parameter must be modified to point to the error /// message, with the underlying memory having been obtained from the /// sqlite3_malloc() function. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xCreate( IntPtr pDb, IntPtr pAux, int argc, IntPtr[] argv, ref IntPtr pVtab, ref IntPtr pError ); /////////////////////////////////////////////////////////////////////// /// <summary> /// The xConnect method is very similar to xCreate. It has the same /// parameters and constructs a new sqlite3_vtab structure just like /// xCreate. And it must also call sqlite3_declare_vtab() like xCreate. /// /// The difference is that xConnect is called to establish a new /// connection to an existing virtual table whereas xCreate is called /// to create a new virtual table from scratch. /// /// The xCreate and xConnect methods are only different when the /// virtual table has some kind of backing store that must be /// initialized the first time the virtual table is created. The /// xCreate method creates and initializes the backing store. The /// xConnect method just connects to an existing backing store. /// /// As an example, consider a virtual table implementation that /// provides read-only access to existing comma-separated-value (CSV) /// files on disk. There is no backing store that needs to be created /// or initialized for such a virtual table (since the CSV files /// already exist on disk) so the xCreate and xConnect methods will be /// identical for that module. /// /// Another example is a virtual table that implements a full-text /// index. The xCreate method must create and initialize data /// structures to hold the dictionary and posting lists for that index. /// The xConnect method, on the other hand, only has to locate and use /// an existing dictionary and posting lists that were created by a /// prior xCreate call. /// /// The xConnect method must return SQLITE_OK if it is successful in /// creating the new virtual table, or SQLITE_ERROR if it is not /// successful. If not successful, the sqlite3_vtab structure must not /// be allocated. An error message may optionally be returned in *pzErr /// if unsuccessful. Space to hold the error message string must be /// allocated using an SQLite memory allocation function like /// sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will /// attempt to free the space using sqlite3_free() after the error has /// been reported up to the application. /// /// The xConnect method is required for every virtual table /// implementation, though the xCreate and xConnect pointers of the /// sqlite3_module object may point to the same function the virtual /// table does not need to initialize backing store. /// </summary> /// <param name="pDb"> /// The native database connection handle. /// </param> /// <param name="pAux"> /// The original native pointer value that was provided to the /// sqlite3_create_module(), sqlite3_create_module_v2() or /// sqlite3_create_disposable_module() functions. /// </param> /// <param name="argc"> /// The number of arguments from the CREATE VIRTUAL TABLE statement. /// </param> /// <param name="argv"> /// The array of string arguments from the CREATE VIRTUAL TABLE /// statement. /// </param> /// <param name="pVtab"> /// Upon success, this parameter must be modified to point to the newly /// created native sqlite3_vtab derived structure. /// </param> /// <param name="pError"> /// Upon failure, this parameter must be modified to point to the error /// message, with the underlying memory having been obtained from the /// sqlite3_malloc() function. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xConnect( IntPtr pDb, IntPtr pAux, int argc, IntPtr[] argv, ref IntPtr pVtab, ref IntPtr pError ); /////////////////////////////////////////////////////////////////////// /// <summary> /// SQLite uses the xBestIndex method of a virtual table module to /// determine the best way to access the virtual table. The xBestIndex /// method has a prototype like this: /// /// int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); /// /// The SQLite core communicates with the xBestIndex method by filling /// in certain fields of the sqlite3_index_info structure and passing a /// pointer to that structure into xBestIndex as the second parameter. /// The xBestIndex method fills out other fields of this structure /// which forms the reply. The sqlite3_index_info structure looks like /// this: /// /// struct sqlite3_index_info { /// /* Inputs */ /// const int nConstraint; /* Number of entries in aConstraint */ /// const struct sqlite3_index_constraint { /// int iColumn; /* Column on left-hand side of /// * constraint */ /// unsigned char op; /* Constraint operator */ /// unsigned char usable; /* True if this constraint is usable */ /// int iTermOffset; /* Used internally - xBestIndex should /// * ignore */ /// } *const aConstraint; /* Table of WHERE clause constraints */ /// const int nOrderBy; /* Number of terms in the ORDER BY /// * clause */ /// const struct sqlite3_index_orderby { /// int iColumn; /* Column number */ /// unsigned char desc; /* True for DESC. False for ASC. */ /// } *const aOrderBy; /* The ORDER BY clause */ /// /* Outputs */ /// struct sqlite3_index_constraint_usage { /// int argvIndex; /* if greater than zero, constraint is /// * part of argv to xFilter */ /// unsigned char omit; /* Do not code a test for this /// * constraint */ /// } *const aConstraintUsage; /// int idxNum; /* Number used to identify the index */ /// char *idxStr; /* String, possibly obtained from /// * sqlite3_malloc() */ /// int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if /// * true */ /// int orderByConsumed; /* True if output is already ordered */ /// double estimatedCost; /* Estimated cost of using this index */ /// }; /// /// In addition, there are some defined constants: /// /// #define SQLITE_INDEX_CONSTRAINT_EQ 2 /// #define SQLITE_INDEX_CONSTRAINT_GT 4 /// #define SQLITE_INDEX_CONSTRAINT_LE 8 /// #define SQLITE_INDEX_CONSTRAINT_LT 16 /// #define SQLITE_INDEX_CONSTRAINT_GE 32 /// #define SQLITE_INDEX_CONSTRAINT_MATCH 64 /// /// The SQLite core calls the xBestIndex method when it is compiling a /// query that involves a virtual table. In other words, SQLite calls /// this method when it is running sqlite3_prepare() or the equivalent. /// By calling this method, the SQLite core is saying to the virtual /// table that it needs to access some subset of the rows in the /// virtual table and it wants to know the most efficient way to do /// that access. The xBestIndex method replies with information that /// the SQLite core can then use to conduct an efficient search of the /// virtual table. /// /// While compiling a single SQL query, the SQLite core might call /// xBestIndex multiple times with different settings in /// sqlite3_index_info. The SQLite core will then select the /// combination that appears to give the best performance. /// /// Before calling this method, the SQLite core initializes an instance /// of the sqlite3_index_info structure with information about the /// query that it is currently trying to process. This information /// derives mainly from the WHERE clause and ORDER BY or GROUP BY /// clauses of the query, but also from any ON or USING clauses if the /// query is a join. The information that the SQLite core provides to /// the xBestIndex method is held in the part of the structure that is /// marked as "Inputs". The "Outputs" section is initialized to zero. /// /// The information in the sqlite3_index_info structure is ephemeral /// and may be overwritten or deallocated as soon as the xBestIndex /// method returns. If the xBestIndex method needs to remember any part /// of the sqlite3_index_info structure, it should make a copy. Care /// must be take to store the copy in a place where it will be /// deallocated, such as in the idxStr field with needToFreeIdxStr set /// to 1. /// /// Note that xBestIndex will always be called before xFilter, since /// the idxNum and idxStr outputs from xBestIndex are required inputs /// to xFilter. However, there is no guarantee that xFilter will be /// called following a successful xBestIndex. /// /// The xBestIndex method is required for every virtual table /// implementation. /// /// 2.3.1 Inputs /// /// The main thing that the SQLite core is trying to communicate to the /// virtual table is the constraints that are available to limit the /// number of rows that need to be searched. The aConstraint[] array /// contains one entry for each constraint. There will be exactly /// nConstraint entries in that array. /// /// Each constraint will correspond to a term in the WHERE clause or in /// a USING or ON clause that is of the form /// /// column OP EXPR /// /// Where "column" is a column in the virtual table, OP is an operator /// like "=" or "<", and EXPR is an arbitrary expression. So, for /// example, if the WHERE clause contained a term like this: /// /// a = 5 /// /// Then one of the constraints would be on the "a" column with /// operator "=" and an expression of "5". Constraints need not have a /// literal representation of the WHERE clause. The query optimizer /// might make transformations to the WHERE clause in order to extract /// as many constraints as it can. So, for example, if the WHERE clause /// contained something like this: /// /// x BETWEEN 10 AND 100 AND 999>y /// /// The query optimizer might translate this into three separate /// constraints: /// /// x >= 10 /// x <= 100 /// y < 999 /// /// For each constraint, the aConstraint[].iColumn field indicates /// which column appears on the left-hand side of the constraint. The /// first column of the virtual table is column 0. The rowid of the /// virtual table is column -1. The aConstraint[].op field indicates /// which operator is used. The SQLITE_INDEX_CONSTRAINT_* constants map /// integer constants into operator values. Columns occur in the order /// they were defined by the call to sqlite3_declare_vtab() in the /// xCreate or xConnect method. Hidden columns are counted when /// determining the column index. /// /// The aConstraint[] array contains information about all constraints /// that apply to the virtual table. But some of the constraints might /// not be usable because of the way tables are ordered in a join. The /// xBestIndex method must therefore only consider constraints that /// have an aConstraint[].usable flag which is true. /// /// In addition to WHERE clause constraints, the SQLite core also tells /// the xBestIndex method about the ORDER BY clause. (In an aggregate /// query, the SQLite core might put in GROUP BY clause information in /// place of the ORDER BY clause information, but this fact should not /// make any difference to the xBestIndex method.) If all terms of the /// ORDER BY clause are columns in the virtual table, then nOrderBy /// will be the number of terms in the ORDER BY clause and the /// aOrderBy[] array will identify the column for each term in the /// order by clause and whether or not that column is ASC or DESC. /// /// 2.3.2 Outputs /// /// Given all of the information above, the job of the xBestIndex /// method it to figure out the best way to search the virtual table. /// /// The xBestIndex method fills the idxNum and idxStr fields with /// information that communicates an indexing strategy to the xFilter /// method. The information in idxNum and idxStr is arbitrary as far as /// the SQLite core is concerned. The SQLite core just copies the /// information through to the xFilter method. Any desired meaning can /// be assigned to idxNum and idxStr as long as xBestIndex and xFilter /// agree on what that meaning is. /// /// The idxStr value may be a string obtained from an SQLite memory /// allocation function such as sqlite3_mprintf(). If this is the case, /// then the needToFreeIdxStr flag must be set to true so that the /// SQLite core will know to call sqlite3_free() on that string when it /// has finished with it, and thus avoid a memory leak. /// /// If the virtual table will output rows in the order specified by the /// ORDER BY clause, then the orderByConsumed flag may be set to true. /// If the output is not automatically in the correct order then /// orderByConsumed must be left in its default false setting. This /// will indicate to the SQLite core that it will need to do a separate /// sorting pass over the data after it comes out of the virtual table. /// /// The estimatedCost field should be set to the estimated number of /// disk access operations required to execute this query against the /// virtual table. The SQLite core will often call xBestIndex multiple /// times with different constraints, obtain multiple cost estimates, /// then choose the query plan that gives the lowest estimate. /// /// The aConstraintUsage[] array contains one element for each of the /// nConstraint constraints in the inputs section of the /// sqlite3_index_info structure. The aConstraintUsage[] array is used /// by xBestIndex to tell the core how it is using the constraints. /// /// The xBestIndex method may set aConstraintUsage[].argvIndex entries /// to values greater than one. Exactly one entry should be set to 1, /// another to 2, another to 3, and so forth up to as many or as few as /// the xBestIndex method wants. The EXPR of the corresponding /// constraints will then be passed in as the argv[] parameters to /// xFilter. /// /// For example, if the aConstraint[3].argvIndex is set to 1, then when /// xFilter is called, the argv[0] passed to xFilter will have the EXPR /// value of the aConstraint[3] constraint. /// /// By default, the SQLite core double checks all constraints on each /// row of the virtual table that it receives. If such a check is /// redundant, the xBestFilter method can suppress that double-check by /// setting aConstraintUsage[].omit. /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="pIndex"> /// The native pointer to the sqlite3_index_info structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xBestIndex( IntPtr pVtab, IntPtr pIndex ); /////////////////////////////////////////////////////////////////////// /// <summary> /// This method releases a connection to a virtual table. Only the /// sqlite3_vtab object is destroyed. The virtual table is not /// destroyed and any backing store associated with the virtual table /// persists. This method undoes the work of xConnect. /// /// This method is a destructor for a connection to the virtual table. /// Contrast this method with xDestroy. The xDestroy is a destructor /// for the entire virtual table. /// /// The xDisconnect method is required for every virtual table /// implementation, though it is acceptable for the xDisconnect and /// xDestroy methods to be the same function if that makes sense for /// the particular virtual table. /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xDisconnect( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// This method releases a connection to a virtual table, just like the /// xDisconnect method, and it also destroys the underlying table /// implementation. This method undoes the work of xCreate. /// /// The xDisconnect method is called whenever a database connection /// that uses a virtual table is closed. The xDestroy method is only /// called when a DROP TABLE statement is executed against the virtual /// table. /// /// The xDestroy method is required for every virtual table /// implementation, though it is acceptable for the xDisconnect and /// xDestroy methods to be the same function if that makes sense for /// the particular virtual table. /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xDestroy( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// The xOpen method creates a new cursor used for accessing (read /// and/or writing) a virtual table. A successful invocation of this /// method will allocate the memory for the sqlite3_vtab_cursor (or a /// subclass), initialize the new object, and make *ppCursor point to /// the new object. The successful call then returns SQLITE_OK. /// /// For every successful call to this method, the SQLite core will /// later invoke the xClose method to destroy the allocated cursor. /// /// The xOpen method need not initialize the pVtab field of the /// sqlite3_vtab_cursor structure. The SQLite core will take care of /// that chore automatically. /// /// A virtual table implementation must be able to support an arbitrary /// number of simultaneously open cursors. /// /// When initially opened, the cursor is in an undefined state. The /// SQLite core will invoke the xFilter method on the cursor prior to /// any attempt to position or read from the cursor. /// /// The xOpen method is required for every virtual table /// implementation. /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="pCursor"> /// Upon success, this parameter must be modified to point to the newly /// created native sqlite3_vtab_cursor derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xOpen( IntPtr pVtab, ref IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// /// <summary> /// The xClose method closes a cursor previously opened by xOpen. The /// SQLite core will always call xClose once for each cursor opened /// using xOpen. /// /// This method must release all resources allocated by the /// corresponding xOpen call. The routine will not be called again even /// if it returns an error. The SQLite core will not use the /// sqlite3_vtab_cursor again after it has been closed. /// /// The xClose method is required for every virtual table /// implementation. /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xClose( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// /// <summary> /// This method begins a search of a virtual table. The first argument /// is a cursor opened by xOpen. The next two argument define a /// particular search index previously chosen by xBestIndex. The /// specific meanings of idxNum and idxStr are unimportant as long as /// xFilter and xBestIndex agree on what that meaning is. /// /// The xBestIndex function may have requested the values of certain /// expressions using the aConstraintUsage[].argvIndex values of the /// sqlite3_index_info structure. Those values are passed to xFilter /// using the argc and argv parameters. /// /// If the virtual table contains one or more rows that match the /// search criteria, then the cursor must be left point at the first /// row. Subsequent calls to xEof must return false (zero). If there /// are no rows match, then the cursor must be left in a state that /// will cause the xEof to return true (non-zero). The SQLite engine /// will use the xColumn and xRowid methods to access that row content. /// The xNext method will be used to advance to the next row. /// /// This method must return SQLITE_OK if successful, or an sqlite error /// code if an error occurs. /// /// The xFilter method is required for every virtual table /// implementation. /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <param name="idxNum"> /// Number used to help identify the selected index. /// </param> /// <param name="idxStr"> /// The native pointer to the UTF-8 encoded string containing the /// string used to help identify the selected index. /// </param> /// <param name="argc"> /// The number of native pointers to sqlite3_value structures specified /// in <paramref name="argv" />. /// </param> /// <param name="argv"> /// An array of native pointers to sqlite3_value structures containing /// filtering criteria for the selected index. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xFilter( IntPtr pCursor, int idxNum, IntPtr idxStr, int argc, IntPtr[] argv ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xNext( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <returns> /// Non-zero if no more rows are available; zero otherwise. /// </returns> int xEof( IntPtr pCursor ); /////////////////////////////////////////////////////////////////////// /// <summary> /// The SQLite core invokes this method in order to find the value for /// the N-th column of the current row. N is zero-based so the first /// column is numbered 0. The xColumn method may return its result back /// to SQLite using one of the following interface: /// /// * sqlite3_result_blob() /// * sqlite3_result_double() /// * sqlite3_result_int() /// * sqlite3_result_int64() /// * sqlite3_result_null() /// * sqlite3_result_text() /// * sqlite3_result_text16() /// * sqlite3_result_text16le() /// * sqlite3_result_text16be() /// * sqlite3_result_zeroblob() /// /// If the xColumn method implementation calls none of the functions /// above, then the value of the column defaults to an SQL NULL. /// /// To raise an error, the xColumn method should use one of the /// result_text() methods to set the error message text, then return an /// appropriate error code. The xColumn method must return SQLITE_OK on /// success. /// /// The xColumn method is required for every virtual table /// implementation. /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <param name="pContext"> /// The native pointer to the sqlite3_context structure to be used /// for returning the specified column value to the SQLite core /// library. /// </param> /// <param name="index"> /// The zero-based index corresponding to the column containing the /// value to be returned. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xColumn( IntPtr pCursor, IntPtr pContext, int index ); /////////////////////////////////////////////////////////////////////// /// <summary> /// A successful invocation of this method will cause *pRowid to be /// filled with the rowid of row that the virtual table cursor pCur is /// currently pointing at. This method returns SQLITE_OK on success. It /// returns an appropriate error code on failure. /// /// The xRowid method is required for every virtual table /// implementation. /// </summary> /// <param name="pCursor"> /// The native pointer to the sqlite3_vtab_cursor derived structure. /// </param> /// <param name="rowId"> /// Upon success, this parameter must be modified to contain the unique /// integer row identifier for the current row for the specified cursor. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xRowId( IntPtr pCursor, ref long rowId ); /////////////////////////////////////////////////////////////////////// /// <summary> /// All changes to a virtual table are made using the xUpdate method. /// This one method can be used to insert, delete, or update. /// /// The argc parameter specifies the number of entries in the argv /// array. The value of argc will be 1 for a pure delete operation or /// N+2 for an insert or replace or update where N is the number of /// columns in the table. In the previous sentence, N includes any /// hidden columns. /// /// Every argv entry will have a non-NULL value in C but may contain /// the SQL value NULL. In other words, it is always true that /// argv[i]!=0 for i between 0 and argc-1. However, it might be the /// case that sqlite3_value_type(argv[i])==SQLITE_NULL. /// /// The argv[0] parameter is the rowid of a row in the virtual table /// to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. /// /// The argv[1] parameter is the rowid of a new row to be inserted into /// the virtual table. If argv[1] is an SQL NULL, then the /// implementation must choose a rowid for the newly inserted row. /// Subsequent argv[] entries contain values of the columns of the /// virtual table, in the order that the columns were declared. The /// number of columns will match the table declaration that the /// xConnect or xCreate method made using the sqlite3_declare_vtab() /// call. All hidden columns are included. /// /// When doing an insert without a rowid (argc>1, argv[1] is an SQL /// NULL), the implementation must set *pRowid to the rowid of the /// newly inserted row; this will become the value returned by the /// sqlite3_last_insert_rowid() function. Setting this value in all the /// other cases is a harmless no-op; the SQLite engine ignores the /// *pRowid return value if argc==1 or argv[1] is not an SQL NULL. /// /// Each call to xUpdate will fall into one of cases shown below. Note /// that references to argv[i] mean the SQL value held within the /// argv[i] object, not the argv[i] object itself. /// /// argc = 1 /// /// The single row with rowid equal to argv[0] is deleted. No /// insert occurs. /// /// argc > 1 /// argv[0] = NULL /// /// A new row is inserted with a rowid argv[1] and column /// values in argv[2] and following. If argv[1] is an SQL NULL, /// the a new unique rowid is generated automatically. /// /// argc > 1 /// argv[0] ? NULL /// argv[0] = argv[1] /// /// The row with rowid argv[0] is updated with new values in /// argv[2] and following parameters. /// /// argc > 1 /// argv[0] ? NULL /// argv[0] ? argv[1] /// /// The row with rowid argv[0] is updated with rowid argv[1] /// and new values in argv[2] and following parameters. This /// will occur when an SQL statement updates a rowid, as in /// the statement: /// /// UPDATE table SET rowid=rowid+1 WHERE ...; /// /// The xUpdate method must return SQLITE_OK if and only if it is /// successful. If a failure occurs, the xUpdate must return an /// appropriate error code. On a failure, the pVTab->zErrMsg element /// may optionally be replaced with error message text stored in memory /// allocated from SQLite using functions such as sqlite3_mprintf() or /// sqlite3_malloc(). /// /// If the xUpdate method violates some constraint of the virtual table /// (including, but not limited to, attempting to store a value of the /// wrong datatype, attempting to store a value that is too large or /// too small, or attempting to change a read-only value) then the /// xUpdate must fail with an appropriate error code. /// /// There might be one or more sqlite3_vtab_cursor objects open and in /// use on the virtual table instance and perhaps even on the row of /// the virtual table when the xUpdate method is invoked. The /// implementation of xUpdate must be prepared for attempts to delete /// or modify rows of the table out from other existing cursors. If the /// virtual table cannot accommodate such changes, the xUpdate method /// must return an error code. /// /// The xUpdate method is optional. If the xUpdate pointer in the /// sqlite3_module for a virtual table is a NULL pointer, then the /// virtual table is read-only. /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="nData"> /// The number of new or modified column values contained in /// <paramref name="apData" />. /// </param> /// <param name="apData"> /// /// </param> /// <param name="rowId"> /// Upon success, this parameter must be modified to contain the unique /// integer row identifier for the row that was inserted, if any. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xUpdate( IntPtr pVtab, int nData, IntPtr apData, ref long rowId ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xBegin( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xSync( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xCommit( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xRollback( IntPtr pVtab ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="nArg"> /// /// </param> /// <param name="zName"> /// /// </param> /// <param name="callback"> /// /// </param> /// <param name="pClientData"> /// /// </param> /// <returns> /// /// </returns> int xFindFunction( IntPtr pVtab, int nArg, IntPtr zName, ref SQLiteCallback callback, ref IntPtr pClientData ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="zNew"> /// The native pointer to the UTF-8 encoded string containing the new /// name for the virtual table. /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xRename( IntPtr pVtab, IntPtr zNew ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="iSavepoint"> /// /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xSavepoint( IntPtr pVtab, int iSavepoint ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="iSavepoint"> /// /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xRelease( IntPtr pVtab, int iSavepoint ); /////////////////////////////////////////////////////////////////////// /// <summary> /// /// </summary> /// <param name="pVtab"> /// The native pointer to the sqlite3_vtab derived structure. /// </param> /// <param name="iSavepoint"> /// /// </param> /// <returns> /// A standard SQLite return code. /// </returns> SQLiteErrorCode xRollbackTo( IntPtr pVtab, int iSavepoint ); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteManagedModule Interface /// <summary> /// This interface represents a virtual table implementation written in /// managed code. /// </summary> public interface ISQLiteManagedModule { bool Declared { get; } /////////////////////////////////////////////////////////////////////// string Name { get; } /////////////////////////////////////////////////////////////////////// SQLiteErrorCode Create( SQLiteConnection connection, /* in */ IntPtr pClientData, /* in */ |
︙ | ︙ |