SQLiteQuery.java revision 650de3dcfcbc7635da3c070410ef1dc4027ae464
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.database.sqlite; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.CursorWindow; 206a353876178ca2fe4bc61f128130067d2c2574d1Brad Fitzpatrickimport android.os.SystemClock; 21b18f27dbf43ee9028a11cafbca23d3fa318e278bVasu Noriimport android.util.Log; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A SQLite program that represents a query that reads the resulting rows into a CursorWindow. 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class is used by SQLiteCursor and isn't useful itself. 26f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * 27f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * SQLiteQuery is not internally synchronized so code using a SQLiteQuery from multiple 28f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * threads should perform its own synchronization when using the SQLiteQuery. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SQLiteQuery extends SQLiteProgram { 310732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori private static final String TAG = "SQLiteQuery"; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 33650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown private static final boolean DEBUG_FILL_WINDOW_PERFORMANCE = false; 34650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown 35650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown private static native long nativeFillWindow(int databasePtr, int statementPtr, int windowPtr, 36650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown int offsetParam, int startPos, int requiredPos, boolean countAllRows); 377ce745248d4de0e6543a559c93423df899832100Jeff Brown private static native int nativeColumnCount(int statementPtr); 387ce745248d4de0e6543a559c93423df899832100Jeff Brown private static native String nativeColumnName(int statementPtr, int columnIndex); 397ce745248d4de0e6543a559c93423df899832100Jeff Brown 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The index of the unbound OFFSET parameter */ 410732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori private int mOffsetIndex = 0; 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mClosed = false; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a persistent query object. 470732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori * 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param db The database that this query object is associated with 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param query The SQL string for this query. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param offsetIndex The 1-based index to the OFFSET parameter, 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ SQLiteQuery(SQLiteDatabase db, String query, int offsetIndex, String[] bindArgs) { 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(db, query); 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOffsetIndex = offsetIndex; 550732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori bindAllArgsAsStrings(bindArgs); 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5965a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * Constructor used to create new instance to replace a given instance of this class. 6065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * This constructor is used when the current Query object is now associated with a different 6165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * {@link SQLiteDatabase} object. 6265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * 6365a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * @param db The database that this query object is associated with 6465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * @param query the instance of {@link SQLiteQuery} to be replaced 6565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori */ 6665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /* package */ SQLiteQuery(SQLiteDatabase db, SQLiteQuery query) { 670732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori super(db, query.mSql); 680732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori this.mBindArgs = query.mBindArgs; 69b18f27dbf43ee9028a11cafbca23d3fa318e278bVasu Nori this.mOffsetIndex = query.mOffsetIndex; 7065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 7165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori 7265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /** 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Reads rows into a buffer. This method acquires the database lock. 74722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick * 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param window The window to fill into 76650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * @param startPos The start position for filling the window. 77650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * @param requiredPos The position of a row that MUST be in the window. 78650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * If it won't fit, then the query should discard part of what it filled. 79650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * @param countAllRows True to count all rows that the query would 80650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * return regardless of whether they fit in the window. 81650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * @return Number of rows that were enumerated. Might not be all rows 82650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown * unless countAllRows is true. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 84650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown /* package */ int fillWindow(CursorWindow window, 85650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown int startPos, int requiredPos, boolean countAllRows) { 8616057fad00d47e920fc20721b70c7cafb765f7f8Vasu Nori mDatabase.lock(mSql); 876a353876178ca2fe4bc61f128130067d2c2574d1Brad Fitzpatrick long timeStart = SystemClock.uptimeMillis(); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project window.acquireReference(); 92650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown long result = nativeFillWindow(nHandle, nStatement, window.mWindowPtr, 93650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown mOffsetIndex, startPos, requiredPos, countAllRows); 94650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown int actualPos = (int)(result >> 32); 95650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown int countedRows = (int)result; 96650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown window.setStartPosition(actualPos); 97650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown if (DEBUG_FILL_WINDOW_PERFORMANCE) { 98650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown Log.d(TAG, "fillWindow: window=\"" + window 99650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + "\", startPos=" + startPos + ", requiredPos=" + requiredPos 100650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + ", countAllRows=" + countAllRows 101650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + ", offset=" + mOffsetIndex 102650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + ", actualPos=" + actualPos + ", filledRows=" + window.getNumRows() 103650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + ", countedRows=" + countedRows 104650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + ", took " + (SystemClock.uptimeMillis() - timeStart) 105650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown + " ms, query=\"" + mSql + "\""); 106650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown } 10712311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor mDatabase.logTimeStat(mSql, timeStart); 108650de3dcfcbc7635da3c070410ef1dc4027ae464Jeff Brown return countedRows; 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (IllegalStateException e){ 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // simply ignore it 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 0; 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.onCorruption(); 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 115b18f27dbf43ee9028a11cafbca23d3fa318e278bVasu Nori } catch (SQLiteException e) { 116b18f27dbf43ee9028a11cafbca23d3fa318e278bVasu Nori Log.e(TAG, "exception: " + e.getMessage() + "; query: " + mSql); 117b18f27dbf43ee9028a11cafbca23d3fa318e278bVasu Nori throw e; 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 119722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick window.releaseReference(); 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDatabase.unlock(); 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the column count for the statement. Only valid on query based 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * statements. The database must be locked 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The number of column in the statement's result set. 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int columnCountLocked() { 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1377ce745248d4de0e6543a559c93423df899832100Jeff Brown return nativeColumnCount(nStatement); 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieves the column name for the given column index. The database must be locked 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when calling this method. 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columnIndex the index of the column to get the name for 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The requested column's name 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ String columnNameLocked(int columnIndex) { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project acquireReference(); 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1537ce745248d4de0e6543a559c93423df899832100Jeff Brown return nativeColumnName(nStatement, columnIndex); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project releaseReference(); 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1587ce745248d4de0e6543a559c93423df899832100Jeff Brown 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 1615a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori return "SQLiteQuery: " + mSql; 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1637ce745248d4de0e6543a559c93423df899832100Jeff Brown 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close() { 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.close(); 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mClosed = true; 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called by SQLiteCursor when it is requeried. 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void requery() { 1740732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (mClosed) { 1750732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori throw new IllegalStateException("requerying a closed cursor"); 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1770732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori compileAndbindAllArgs(); 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 180