SQLiteDatabase.java revision 0732f7912ccec9a1cc379b535ac0b56ae50972b3
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 1901e4cfc47d0a2c7e7ab383d2fb23224ec52c0301Dianne Hackbornimport android.app.AppGlobals; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.ContentValues; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.Cursor; 22062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Noriimport android.database.DatabaseErrorHandler; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.DatabaseUtils; 24062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Noriimport android.database.DefaultDatabaseErrorHandler; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.SQLException; 26c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport android.database.sqlite.SQLiteDebug.DbStats; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Debug; 28a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Noriimport android.os.StatFs; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.SystemClock; 3090142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikovimport android.os.SystemProperties; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.text.TextUtils; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Config; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.EventLog; 3490142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikovimport android.util.Log; 35c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport android.util.Pair; 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 37cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrickimport dalvik.system.BlockGuard; 38cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.File; 40c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport java.lang.ref.WeakReference; 41c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport java.util.ArrayList; 420732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Noriimport java.util.Collections; 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.HashMap; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Iterator; 4520f549fd2f40db524242c9038d7d63356adf95fcVasu Noriimport java.util.LinkedHashMap; 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Locale; 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Map; 4812311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnorimport java.util.Random; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.WeakHashMap; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.concurrent.locks.ReentrantLock; 51d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrickimport java.util.regex.Pattern; 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Exposes methods to manage a SQLite database. 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>SQLiteDatabase has methods to create, delete, execute SQL commands, and 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * perform other common database management tasks. 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>See the Notepad sample application in the SDK for an example of creating 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and managing a database. 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> Database names must be unique within an application, not across all 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * applications. 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <h3>Localized Collation - ORDER BY</h3> 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>In addition to SQLite's default <code>BINARY</code> collator, Android supplies 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * two more, <code>LOCALIZED</code>, which changes with the system's current locale 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if you wire it up correctly (XXX a link needed!), and <code>UNICODE</code>, which 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is the Unicode Collation Algorithm and not tailored to the current locale. 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class SQLiteDatabase extends SQLiteClosable { 69fb16cbd9b2e86d6878d4bff820422bc09c8938deVasu Nori private static final String TAG = "SQLiteDatabase"; 70082c2af6859dff103e781b372dfde927cc0f869fJeff Hamilton private static final int EVENT_DB_OPERATION = 52000; 71082c2af6859dff103e781b372dfde927cc0f869fJeff Hamilton private static final int EVENT_DB_CORRUPT = 75004; 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Algorithms used in ON CONFLICT clause 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.sqlite.org/lang_conflict.html 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 778d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 788d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * When a constraint violation occurs, an immediate ROLLBACK occurs, 798d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * thus ending the current transaction, and the command aborts with a 808d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * return code of SQLITE_CONSTRAINT. If no transaction is active 818d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * (other than the implied transaction that is created on every command) 828d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * then this algorithm works the same as ABORT. 838d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 848d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_ROLLBACK = 1; 85600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 868d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 878d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * When a constraint violation occurs,no ROLLBACK is executed 888d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * so changes from prior commands within the same transaction 898d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * are preserved. This is the default behavior. 908d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 918d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_ABORT = 2; 92600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 938d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 948d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * When a constraint violation occurs, the command aborts with a return 958d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * code SQLITE_CONSTRAINT. But any changes to the database that 968d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * the command made prior to encountering the constraint violation 978d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * are preserved and are not backed out. 988d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 998d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_FAIL = 3; 100600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 1018d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 1028d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * When a constraint violation occurs, the one row that contains 1038d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * the constraint violation is not inserted or changed. 1048d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * But the command continues executing normally. Other rows before and 1058d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * after the row that contained the constraint violation continue to be 1068d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * inserted or updated normally. No error is returned. 1078d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 1088d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_IGNORE = 4; 109600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 1108d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 1118d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * When a UNIQUE constraint violation occurs, the pre-existing rows that 1128d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * are causing the constraint violation are removed prior to inserting 1138d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * or updating the current row. Thus the insert or update always occurs. 1148d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * The command continues executing normally. No error is returned. 1158d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * If a NOT NULL constraint violation occurs, the NULL value is replaced 1168d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * by the default value for that column. If the column has no default 1178d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * value, then the ABORT algorithm is used. If a CHECK constraint 1188d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * violation occurs then the IGNORE algorithm is used. When this conflict 1198d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * resolution strategy deletes rows in order to satisfy a constraint, 1208d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * it does not invoke delete triggers on those rows. 1218d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * This behavior might change in a future release. 1228d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 1238d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_REPLACE = 5; 1246eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori 1258d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori /** 1268d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * use the following when no conflict action is specified. 1278d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori */ 1288d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori public static final int CONFLICT_NONE = 0; 1298d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori private static final String[] CONFLICT_VALUES = new String[] 1308d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori {"", " OR ROLLBACK ", " OR ABORT ", " OR FAIL ", " OR IGNORE ", " OR REPLACE "}; 131600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Maximum Length Of A LIKE Or GLOB Pattern 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The pattern matching algorithm used in the default LIKE and GLOB implementation 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of SQLite can exhibit O(N^2) performance (where N is the number of characters in 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the pattern) for certain pathological cases. To avoid denial-of-service attacks 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the length of the LIKE or GLOB pattern is limited to SQLITE_MAX_LIKE_PATTERN_LENGTH bytes. 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The default value of this limit is 50000. A modern workstation can evaluate 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * even a pathological LIKE or GLOB pattern of 50000 bytes relatively quickly. 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The denial of service problem only comes into play when the pattern length gets 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * into millions of bytes. Nevertheless, since most useful LIKE or GLOB patterns 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * are at most a few dozen bytes in length, paranoid application developers may 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * want to reduce this parameter to something in the range of a few hundred 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if they know that external users are able to generate arbitrary patterns. 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SQLITE_MAX_LIKE_PATTERN_LENGTH = 50000; 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #openDatabase} to open the database for reading and writing. 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If the disk is full, this may fail even before you actually write anything. 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@more} Note that the value of this flag is 0, so it is the default. 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int OPEN_READWRITE = 0x00000000; // update native code if changing 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #openDatabase} to open the database for reading only. 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is the only reliable way to open a database if the disk may be full. 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int OPEN_READONLY = 0x00000001; // update native code if changing 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final int OPEN_READ_MASK = 0x00000001; // update native code if changing 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #openDatabase} to open the database without support for localized collators. 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@more} This causes the collator <code>LOCALIZED</code> not to be created. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You must be consistent when using this flag to use the setting the database was 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * created with. If this is set, {@link #setLocale} will do nothing. 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int NO_LOCALIZED_COLLATORS = 0x00000010; // update native code if changing 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #openDatabase} to create the database file if it does not already exist. 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int CREATE_IF_NECESSARY = 0x10000000; // update native code if changing 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Indicates whether the most-recently started transaction has been marked as successful. 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mInnerTransactionIsSuccessful; 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Valid during the life of a transaction, and indicates whether the entire transaction (the 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * outer one and all of the inner ones) so far has been successful. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mTransactionIsSuccessful; 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 189c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana /** 190c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * Valid during the life of a transaction. 191c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana */ 192c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana private SQLiteTransactionListener mTransactionListener; 193c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana 194ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /** 195ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * this member is set if {@link #execSQL(String)} is used to begin and end transactions. 196ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori */ 197ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori private boolean mTransactionUsingExecSql; 198ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Synchronize on this when accessing the database */ 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private final ReentrantLock mLock = new ReentrantLock(true); 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private long mLockAcquiredWallTime = 0L; 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private long mLockAcquiredThreadTime = 0L; 204600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // limit the frequency of complaints about each database to one within 20 sec 206600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov // unless run command adb shell setprop log.tag.Database VERBOSE 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final int LOCK_WARNING_WINDOW_IN_MS = 20000; 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** If the lock is held this long then a warning will be printed when it is released. */ 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final int LOCK_ACQUIRED_WARNING_TIME_IN_MS = 300; 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final int LOCK_ACQUIRED_WARNING_THREAD_TIME_IN_MS = 100; 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final int LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT = 2000; 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 213b43b58d3494426eda6117101635de25bb43efc20Dmitri Plotnikov private static final int SLEEP_AFTER_YIELD_QUANTUM = 1000; 214600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 215d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick // The pattern we remove from database filenames before 216d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick // potentially logging them. 217d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick private static final Pattern EMAIL_IN_DB_PATTERN = Pattern.compile("[\\w\\.\\-]+@[\\w\\.\\-]+"); 218d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private long mLastLockMessageTime = 0L; 220600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 221b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // Things related to query logging/sampling for debugging 222b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // slow/frequent queries during development. Always log queries 223722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // which take (by default) 500ms+; shorter queries are sampled 224722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // accordingly. Commit statements, which are typically slow, are 225722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // logged together with the most recently executed SQL statement, 226722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // for disambiguation. The 500ms value is configurable via a 227722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // SystemProperty, but developers actively debugging database I/O 228722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // should probably use the regular log tunable, 229722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // LOG_SLOW_QUERIES_PROPERTY, defined below. 230722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick private static int sQueryLogTimeInMillis = 0; // lazily initialized 23112311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor private static final int QUERY_LOG_SQL_LENGTH = 64; 232b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick private static final String COMMIT_SQL = "COMMIT;"; 23312311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor private final Random mRandom = new Random(); 234b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick private String mLastSqlStatement = null; 23512311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor 236722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // String prefix for slow database query EventLog records that show 237722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // lock acquistions of the database. 238722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick /* package */ static final String GET_LOCK_LOG_PREFIX = "GETLOCK:"; 239722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick 2406f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /** Used by native code, do not rename. make it volatile, so it is thread-safe. */ 2416f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /* package */ volatile int mNativeHandle = 0; 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 243a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori /** 244a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori * The size, in bytes, of a block on "/data". This corresponds to the Unix 245a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori * statfs.f_bsize field. note that this field is lazily initialized. 246a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori */ 247a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori private static int sBlockSize = 0; 248a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The path for the database file */ 250ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori private final String mPath; 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 252d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick /** The anonymized path for the database file for logging purposes */ 253d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick private String mPathForLogs = null; // lazily populated 254d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The flags passed to open/create */ 256ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori private final int mFlags; 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The optional factory to use when creating new Cursors */ 259ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori private final CursorFactory mFactory; 260600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 2612134369e803e944af84e73dcaf9356609a5481c6Vasu Nori private final WeakHashMap<SQLiteClosable, Object> mPrograms; 262600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 2635a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /** 26420f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * for each instance of this class, a LRU cache is maintained to store 2655a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * the compiled query statement ids returned by sqlite database. 266ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * key = SQL statement with "?" for bind args 2675a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * value = {@link SQLiteCompiledSql} 2685a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * If an application opens the database and keeps it open during its entire life, then 269ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * there will not be an overhead of compilation of SQL statements by sqlite. 2705a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * 2715a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * why is this cache NOT static? because sqlite attaches compiledsql statements to the 2725a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * struct created when {@link SQLiteDatabase#openDatabase(String, CursorFactory, int)} is 2735a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * invoked. 2745a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * 2755a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * this cache has an upper limit of mMaxSqlCacheSize (settable by calling the method 2769504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori * (@link setMaxSqlCacheSize(int)}). 2775a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori */ 27820f549fd2f40db524242c9038d7d63356adf95fcVasu Nori // default statement-cache size per database connection ( = instance of this class) 27920f549fd2f40db524242c9038d7d63356adf95fcVasu Nori private int mMaxSqlCacheSize = 25; 2802134369e803e944af84e73dcaf9356609a5481c6Vasu Nori /* package */ final Map<String, SQLiteCompiledSql> mCompiledQueries = 28120f549fd2f40db524242c9038d7d63356adf95fcVasu Nori new LinkedHashMap<String, SQLiteCompiledSql>(mMaxSqlCacheSize + 1, 0.75f, true) { 28220f549fd2f40db524242c9038d7d63356adf95fcVasu Nori @Override 28320f549fd2f40db524242c9038d7d63356adf95fcVasu Nori public boolean removeEldestEntry(Map.Entry<String, SQLiteCompiledSql> eldest) { 2849504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori // eldest = least-recently used entry 2859504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori // if it needs to be removed to accommodate a new entry, 2869504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori // close {@link SQLiteCompiledSql} represented by this entry, if not in use 2879504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori // and then let it be removed from the Map. 2889463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // when this is called, the caller must be trying to add a just-compiled stmt 2899463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // to cache; i.e., caller should already have acquired database lock AND 2909463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // the lock on mCompiledQueries. do as assert of these two 2 facts. 2919463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori verifyLockOwner(); 2929463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori if (this.size() <= mMaxSqlCacheSize) { 2939463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // cache is not full. nothing needs to be removed 2949463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori return false; 2959504c70f8862f5ffc55b07bc374e0b18b78a2dc6Vasu Nori } 2969463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // cache is full. eldest will be removed. 2979463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori SQLiteCompiledSql entry = eldest.getValue(); 2989463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori if (!entry.isInUse()) { 2999463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // this {@link SQLiteCompiledSql} is not in use. release it. 3009463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori entry.releaseSqlStatement(); 3019463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori } 3029463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori // return true, so that this entry is removed automatically by the caller. 3039463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori return true; 30420f549fd2f40db524242c9038d7d63356adf95fcVasu Nori } 30520f549fd2f40db524242c9038d7d63356adf95fcVasu Nori }; 306e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori /** 30720f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * absolute max value that can be set by {@link #setMaxSqlCacheSize(int)} 30890a36726b7553a1e7efd2f4ecbe01d7e1b3e7a67Vasu Nori * size of each prepared-statement is between 1K - 6K, depending on the complexity of the 309ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * SQL statement & schema. 310e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori */ 31190a36726b7553a1e7efd2f4ecbe01d7e1b3e7a67Vasu Nori public static final int MAX_SQL_CACHE_SIZE = 100; 312e9d9210205b280b4ea0402f78d7dd717068af650Vasu Nori private int mCacheFullWarnings; 31349d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori private static final int MAX_WARNINGS_ON_CACHESIZE_CONDITION = 1; 3145a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 3155a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /** maintain stats about number of cache hits and misses */ 3165a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori private int mNumCacheHits; 3175a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori private int mNumCacheMisses; 3185a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 319d606b4bf2c1a2308b40785860853cfb95a77bf58Vasu Nori /** Used to find out where this object was created in case it never got closed. */ 3202134369e803e944af84e73dcaf9356609a5481c6Vasu Nori private final Throwable mStackTrace; 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 32290142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov // System property that enables logging of slow queries. Specify the threshold in ms. 32390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov private static final String LOG_SLOW_QUERIES_PROPERTY = "db.log.slow_query_threshold"; 32490142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov private final int mSlowQueryThreshold; 32590142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov 3266f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /** stores the list of statement ids that need to be finalized by sqlite */ 3272134369e803e944af84e73dcaf9356609a5481c6Vasu Nori private final ArrayList<Integer> mClosedStatementIds = new ArrayList<Integer>(); 3286f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori 329062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori /** {@link DatabaseErrorHandler} to be used when SQLite returns any of the following errors 330062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * Corruption 331062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * */ 3322134369e803e944af84e73dcaf9356609a5481c6Vasu Nori private final DatabaseErrorHandler mErrorHandler; 333062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori 3346c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** The Database connection pool {@link DatabaseConnectionPool}. 3356c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Visibility is package-private for testing purposes. otherwise, private visibility is enough. 3366c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 3376c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /* package */ volatile DatabaseConnectionPool mConnectionPool = null; 3386c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 3396c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** Each database connection handle in the pool is assigned a number 1..N, where N is the 3406c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * size of the connection pool. 3416c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * The main connection handle to which the pool is attached is assigned a value of 0. 3426c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 3436c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /* package */ final short mConnectionNum; 3446c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 34565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /** on pooled database connections, this member points to the parent ( = main) 34665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * database connection handle. 34765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori * package visibility only for testing purposes 34865a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori */ 34965a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /* package */ SQLiteDatabase mParentConnObj = null; 35065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori 351a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori private static final String MEMORY_DB_PATH = ":memory:"; 352a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori 3530732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori /** stores reference to all databases opened in the current process. */ 3540732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori private static ArrayList<WeakReference<SQLiteDatabase>> mActiveDatabases = 3550732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori new ArrayList<WeakReference<SQLiteDatabase>>(); 3560732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori 3572827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori synchronized void addSQLiteClosable(SQLiteClosable closable) { 3582827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori // mPrograms is per instance of SQLiteDatabase and it doesn't actually touch the database 3592827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori // itself. so, there is no need to lock(). 3602827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori mPrograms.put(closable, null); 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 362600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 3632827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori synchronized void removeSQLiteClosable(SQLiteClosable closable) { 3642827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori mPrograms.remove(closable); 365600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov } 366600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onAllReferencesReleased() { 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (isOpen()) { 370ad239ab8fabe53e5f82ff80fb8c9260386dd900cVasu Nori // close the database which will close all pending statements to be finalized also 371ad239ab8fabe53e5f82ff80fb8c9260386dd900cVasu Nori close(); 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to release memory that SQLite holds but does not require to 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * operate properly. Typically this memory will come from the page cache. 378600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the number of bytes actually released 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 381600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov static public native int releaseMemory(); 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether or not the SQLiteDatabase is made thread-safe by using locks 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * around critical sections. This is pretty expensive, so if you know that your 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * DB will only be used by a single thread then you should set this to false. 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The default is true. 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param lockingEnabled set to true to enable locks, false otherwise 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setLockingEnabled(boolean lockingEnabled) { 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockingEnabled = lockingEnabled; 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If set then the SQLiteDatabase is made thread-safe by using locks 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * around critical sections 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mLockingEnabled = true; 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void onCorruption() { 401f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori EventLog.writeEvent(EVENT_DB_CORRUPT, mPath); 402ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori mErrorHandler.onCorruption(this); 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Locks the database for exclusive access. The database lock must be held when 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * touch the native sqlite3* object since it is single threaded and uses 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a polling lock contention algorithm. The lock is recursive, and may be acquired 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * multiple times by the same thread. This is a no-op if mLockingEnabled is false. 410600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #unlock() 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void lock() { 4147b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori verifyDbIsOpen(); 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mLockingEnabled) return; 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLock.lock(); 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) { 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() == 1) { 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Use elapsed real-time since the CPU may sleep when waiting for IO 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredWallTime = SystemClock.elapsedRealtime(); 4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredThreadTime = Debug.threadCpuTimeNanos(); 4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Locks the database for exclusive access. The database lock must be held when 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * touch the native sqlite3* object since it is single threaded and uses 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a polling lock contention algorithm. The lock is recursive, and may be acquired 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * multiple times by the same thread. 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #unlockForced() 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void lockForced() { 4357b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori verifyDbIsOpen(); 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLock.lock(); 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) { 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() == 1) { 4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Use elapsed real-time since the CPU may sleep when waiting for IO 4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredWallTime = SystemClock.elapsedRealtime(); 4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredThreadTime = Debug.threadCpuTimeNanos(); 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Releases the database lock. This is a no-op if mLockingEnabled is false. 448600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #unlock() 4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ void unlock() { 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mLockingEnabled) return; 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) { 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() == 1) { 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkLockHoldTime(); 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLock.unlock(); 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Releases the database lock. 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #unlockForced() 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void unlockForced() { 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) { 4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() == 1) { 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project checkLockHoldTime(); 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLock.unlock(); 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void checkLockHoldTime() { 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Use elapsed real-time since the CPU may sleep when waiting for IO 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project long elapsedTime = SystemClock.elapsedRealtime(); 478600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov long lockedTime = elapsedTime - mLockAcquiredWallTime; 4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (lockedTime < LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT && 4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project !Log.isLoggable(TAG, Log.VERBOSE) && 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (elapsedTime - mLastLockMessageTime) < LOCK_WARNING_WINDOW_IN_MS) { 4829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (lockedTime > LOCK_ACQUIRED_WARNING_TIME_IN_MS) { 4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int threadTime = (int) 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ((Debug.threadCpuTimeNanos() - mLockAcquiredThreadTime) / 1000000); 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (threadTime > LOCK_ACQUIRED_WARNING_THREAD_TIME_IN_MS || 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project lockedTime > LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT) { 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLastLockMessageTime = elapsedTime; 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String msg = "lock held on " + mPath + " for " + lockedTime + "ms. Thread time was " 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + threadTime + "ms"; 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING_STACK_TRACE) { 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.d(TAG, msg, new Exception()); 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.d(TAG, msg); 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 502ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Begins a transaction in EXCLUSIVE mode. 503ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 504ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Transactions can be nested. 505ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * When the outer transaction is ended all of 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the work done in that transaction and all of the nested transactions will be committed or 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * rolled back. The changes will be rolled back if any transaction is ended without being 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed. 509ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </p> 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Here is the standard idiom for transactions: 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre> 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * db.beginTransaction(); 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * try { 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ... 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * db.setTransactionSuccessful(); 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } finally { 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * db.endTransaction(); 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </pre> 5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void beginTransaction() { 5236c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori beginTransaction(null /* transactionStatusCallback */, true); 5246c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 5256c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 5266c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** 5276c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Begins a transaction in IMMEDIATE mode. Transactions can be nested. When 5286c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * the outer transaction is ended all of the work done in that transaction 5296c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * and all of the nested transactions will be committed or rolled back. The 5306c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * changes will be rolled back if any transaction is ended without being 5316c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * marked as clean (by calling setTransactionSuccessful). Otherwise they 5326c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * will be committed. 5336c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 5346c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Here is the standard idiom for transactions: 5356c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * 5366c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <pre> 5376c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.beginTransactionNonExclusive(); 5386c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * try { 5396c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * ... 5406c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.setTransactionSuccessful(); 5416c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * } finally { 5426c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.endTransaction(); 5436c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * } 5446c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * </pre> 5456c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 5466c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori public void beginTransactionNonExclusive() { 5476c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori beginTransaction(null /* transactionStatusCallback */, false); 548c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 549c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana 550c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana /** 551ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Begins a transaction in EXCLUSIVE mode. 552ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 553ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Transactions can be nested. 554ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * When the outer transaction is ended all of 555c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * the work done in that transaction and all of the nested transactions will be committed or 556c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * rolled back. The changes will be rolled back if any transaction is ended without being 557c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed. 558ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </p> 559c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * <p>Here is the standard idiom for transactions: 560c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * 561c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * <pre> 562c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * db.beginTransactionWithListener(listener); 563c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * try { 564c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * ... 565c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * db.setTransactionSuccessful(); 566c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * } finally { 567c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * db.endTransaction(); 568c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * } 569c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * </pre> 570ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * 571c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * @param transactionListener listener that should be notified when the transaction begins, 572c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * commits, or is rolled back, either explicitly or by a call to 573c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana * {@link #yieldIfContendedSafely}. 574c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana */ 575c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana public void beginTransactionWithListener(SQLiteTransactionListener transactionListener) { 5766c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori beginTransaction(transactionListener, true); 5776c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 5786c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 5796c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** 5806c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Begins a transaction in IMMEDIATE mode. Transactions can be nested. When 5816c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * the outer transaction is ended all of the work done in that transaction 5826c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * and all of the nested transactions will be committed or rolled back. The 5836c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * changes will be rolled back if any transaction is ended without being 5846c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * marked as clean (by calling setTransactionSuccessful). Otherwise they 5856c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * will be committed. 5866c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 5876c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Here is the standard idiom for transactions: 5886c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * 5896c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <pre> 5906c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.beginTransactionWithListenerNonExclusive(listener); 5916c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * try { 5926c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * ... 5936c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.setTransactionSuccessful(); 5946c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * } finally { 5956c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.endTransaction(); 5966c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * } 5976c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * </pre> 5986c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * 5996c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * @param transactionListener listener that should be notified when the 6006c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * transaction begins, commits, or is rolled back, either 6016c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * explicitly or by a call to {@link #yieldIfContendedSafely}. 6026c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 6036c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori public void beginTransactionWithListenerNonExclusive( 6046c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori SQLiteTransactionListener transactionListener) { 6056c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori beginTransaction(transactionListener, false); 6066c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 6076c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 6086c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private void beginTransaction(SQLiteTransactionListener transactionListener, 6096c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori boolean exclusive) { 610ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 611c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori lockForced(); 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean ok = false; 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // If this thread already had the lock then get out 6159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() > 1) { 6169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mInnerTransactionIsSuccessful) { 6179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String msg = "Cannot call beginTransaction between " 6189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "calling setTransactionSuccessful and endTransaction"; 6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project IllegalStateException e = new IllegalStateException(msg); 6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e(TAG, "beginTransaction() failed", e); 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ok = true; 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // This thread didn't already have the lock, so begin a database 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // transaction now. 62957feb5d9a7fd5329c2ae5daeca0ce8f10a7372a7Vasu Nori if (exclusive && mConnectionPool == null) { 6306c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori execSQL("BEGIN EXCLUSIVE;"); 6316c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } else { 6326c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori execSQL("BEGIN IMMEDIATE;"); 6336c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 634c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana mTransactionListener = transactionListener; 6359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mTransactionIsSuccessful = true; 6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mInnerTransactionIsSuccessful = false; 637c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana if (transactionListener != null) { 638c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana try { 639c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana transactionListener.onBegin(); 640c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } catch (RuntimeException e) { 641c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana execSQL("ROLLBACK;"); 642c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana throw e; 643c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 644c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ok = true; 6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!ok) { 6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // beginTransaction is called before the try block so we must release the lock in 6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // the case of failure. 6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project unlockForced(); 6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * End a transaction. See beginTransaction for notes about how to use this and when transactions 6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * are committed and rolled back. 6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void endTransaction() { 660ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyLockOwner(); 6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mInnerTransactionIsSuccessful) { 6639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mInnerTransactionIsSuccessful = false; 6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 6659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mTransactionIsSuccessful = false; 6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getHoldCount() != 1) { 6689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 670c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana RuntimeException savedException = null; 671c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana if (mTransactionListener != null) { 672c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana try { 673c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana if (mTransactionIsSuccessful) { 674c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana mTransactionListener.onCommit(); 675c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } else { 676c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana mTransactionListener.onRollback(); 677c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 678c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } catch (RuntimeException e) { 679c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana savedException = e; 680c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana mTransactionIsSuccessful = false; 681c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 682c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mTransactionIsSuccessful) { 684b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick execSQL(COMMIT_SQL); 6856c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // if write-ahead logging is used, we have to take care of checkpoint. 6866c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // TODO: should applications be given the flexibility of choosing when to 6876c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // trigger checkpoint? 6886c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // for now, do checkpoint after every COMMIT because that is the fastest 6896c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // way to guarantee that readers will see latest data. 6906c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // but this is the slowest way to run sqlite with in write-ahead logging mode. 6916c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (this.mConnectionPool != null) { 6926c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori execSQL("PRAGMA wal_checkpoint;"); 6936c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (SQLiteDebug.DEBUG_SQL_STATEMENTS) { 6946c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori Log.i(TAG, "PRAGMA wal_Checkpoint done"); 6956c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 6966c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project execSQL("ROLLBACK;"); 700c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana if (savedException != null) { 701c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana throw savedException; 702c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana } 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLException e) { 7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (Config.LOGD) { 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.d(TAG, "exception during rollback, maybe the DB previously " 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "performed an auto-rollback"); 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 711c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana mTransactionListener = null; 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project unlockForced(); 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (Config.LOGV) { 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.v(TAG, "unlocked " + Thread.currentThread() 7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + ", holdCount is " + mLock.getHoldCount()); 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Marks the current transaction as successful. Do not do any more database work between 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calling this and calling endTransaction. Do as little non-database work as possible in that 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * situation too. If any errors are encountered between this and endTransaction the transaction 7249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will still be committed. 7259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws IllegalStateException if the current thread is not in a transaction or the 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * transaction is already marked as successful. 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setTransactionSuccessful() { 730ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 7319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mLock.isHeldByCurrentThread()) { 7329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("no transaction pending"); 7339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mInnerTransactionIsSuccessful) { 7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "setTransactionSuccessful may only be called once per call to beginTransaction"); 7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mInnerTransactionIsSuccessful = true; 7399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return true if there is a transaction pending 7439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean inTransaction() { 745ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori return mLock.getHoldCount() > 0 || mTransactionUsingExecSql; 746ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 747ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori 748ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ synchronized void setTransactionUsingExecSqlFlag() { 749ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 750ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, "found execSQL('begin transaction')"); 751ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 752ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori mTransactionUsingExecSql = true; 753ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 754ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori 755ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ synchronized void resetTransactionUsingExecSqlFlag() { 756ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 757ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (mTransactionUsingExecSql) { 758ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, "found execSQL('commit or end or rollback')"); 759ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 760ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 761ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori mTransactionUsingExecSql = false; 762ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 763ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori 764ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /** 765ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * Returns true if the caller is considered part of the current transaction, if any. 766ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * <p> 767ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * Caller is part of the current transaction if either of the following is true 768ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * <ol> 769ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * <li>If transaction is started by calling beginTransaction() methods AND if the caller is 770ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * in the same thread as the thread that started the transaction. 771ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * </li> 772ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * <li>If the transaction is started by calling {@link #execSQL(String)} like this: 773ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * execSQL("BEGIN transaction"). In this case, every thread in the process is considered 774ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * part of the current transaction.</li> 775ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * </ol> 776ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * 777ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * @return true if the caller is considered part of the current transaction, if any. 778ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori */ 779ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ synchronized boolean amIInTransaction() { 780ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori // always do this test on the main database connection - NOT on pooled database connection 781ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori // since transactions always occur on the main database connections only. 782ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori SQLiteDatabase db = (isPooledConnection()) ? mParentConnObj : this; 783ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori boolean b = (!db.inTransaction()) ? false : 784ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori db.mTransactionUsingExecSql || db.mLock.isHeldByCurrentThread(); 785ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 786ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, "amIinTransaction: " + b); 787ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 788ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori return b; 7899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks if the database lock is held by this thread. 7939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true, if this thread is holding the database lock. 7959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isDbLockedByCurrentThread() { 7979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLock.isHeldByCurrentThread(); 7989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks if the database is locked by another thread. This is 8029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * just an estimate, since this status can change at any time, 8039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * including after the call is made but before the result has 8049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * been acted upon. 8059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true, if the database is locked by another thread 8079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isDbLockedByOtherThreads() { 8099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return !mLock.isHeldByCurrentThread() && mLock.isLocked(); 8109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Temporarily end the transaction to let other threads run. The transaction is assumed to be 8149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * successful so far. Do not call setTransactionSuccessful before calling this. When this 8159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * returns a new transaction will have been created but not marked as successful. 8169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the transaction was yielded 8179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @deprecated if the db is locked more than once (becuase of nested transactions) then the lock 8189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will not be yielded. Use yieldIfContendedSafely instead. 8199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8204a51c20ce607c74914f90fd897f04080121ac13bDianne Hackborn @Deprecated 8219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean yieldIfContended() { 8225c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana return yieldIfContendedHelper(false /* do not check yielding */, 8235c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana -1 /* sleepAfterYieldDelay */); 8249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Temporarily end the transaction to let other threads run. The transaction is assumed to be 8289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * successful so far. Do not call setTransactionSuccessful before calling this. When this 8299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * returns a new transaction will have been created but not marked as successful. This assumes 8309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that there are no nested transactions (beginTransaction has only been called once) and will 8315c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * throw an exception if that is not the case. 8329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the transaction was yielded 8339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean yieldIfContendedSafely() { 8355c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana return yieldIfContendedHelper(true /* check yielding */, -1 /* sleepAfterYieldDelay*/); 8369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8385c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana /** 8395c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * Temporarily end the transaction to let other threads run. The transaction is assumed to be 8405c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * successful so far. Do not call setTransactionSuccessful before calling this. When this 8415c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * returns a new transaction will have been created but not marked as successful. This assumes 8425c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * that there are no nested transactions (beginTransaction has only been called once) and will 8435c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * throw an exception if that is not the case. 8445c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * @param sleepAfterYieldDelay if > 0, sleep this long before starting a new transaction if 8455c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * the lock was actually yielded. This will allow other background threads to make some 8465c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * more progress than they would if we started the transaction immediately. 8475c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana * @return true if the transaction was yielded 8485c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana */ 8495c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana public boolean yieldIfContendedSafely(long sleepAfterYieldDelay) { 8505c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana return yieldIfContendedHelper(true /* check yielding */, sleepAfterYieldDelay); 8515c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana } 8525c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana 8535c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana private boolean yieldIfContendedHelper(boolean checkFullyYielded, long sleepAfterYieldDelay) { 8549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mLock.getQueueLength() == 0) { 8559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Reset the lock acquire time since we know that the thread was willing to yield 8569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // the lock at this time. 8579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredWallTime = SystemClock.elapsedRealtime(); 8589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLockAcquiredThreadTime = Debug.threadCpuTimeNanos(); 8599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 8609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setTransactionSuccessful(); 862c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana SQLiteTransactionListener transactionListener = mTransactionListener; 8639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project endTransaction(); 8649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (checkFullyYielded) { 8659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (this.isDbLockedByCurrentThread()) { 8669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 8679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Db locked more than once. yielfIfContended cannot yield"); 8689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8705c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana if (sleepAfterYieldDelay > 0) { 871600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov // Sleep for up to sleepAfterYieldDelay milliseconds, waking up periodically to 872600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov // check if anyone is using the database. If the database is not contended, 873600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov // retake the lock and return. 874600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov long remainingDelay = sleepAfterYieldDelay; 875600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov while (remainingDelay > 0) { 876600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov try { 877600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov Thread.sleep(remainingDelay < SLEEP_AFTER_YIELD_QUANTUM ? 878600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov remainingDelay : SLEEP_AFTER_YIELD_QUANTUM); 879600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov } catch (InterruptedException e) { 880600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov Thread.interrupted(); 881600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov } 882600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov remainingDelay -= SLEEP_AFTER_YIELD_QUANTUM; 883600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov if (mLock.getQueueLength() == 0) { 884600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov break; 885600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov } 8865c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana } 8875c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana } 888c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana beginTransactionWithListener(transactionListener); 8899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 8909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 89395675137f417173dc711a2d39232a1f545799013Vasu Nori * @deprecated This method no longer serves any useful purpose and has been deprecated. 8949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 89595675137f417173dc711a2d39232a1f545799013Vasu Nori @Deprecated 89695675137f417173dc711a2d39232a1f545799013Vasu Nori public Map<String, String> getSyncedTables() { 89795675137f417173dc711a2d39232a1f545799013Vasu Nori return new HashMap<String, String>(0); 8989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Used to allow returning sub-classes of {@link Cursor} when calling query. 9029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface CursorFactory { 9049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See 9069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SQLiteCursor#SQLiteCursor(SQLiteDatabase, SQLiteCursorDriver, 9079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * String, SQLiteQuery)}. 9089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor newCursor(SQLiteDatabase db, 9109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SQLiteCursorDriver masterQuery, String editTable, 9119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SQLiteQuery query); 9129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Open the database according to the flags {@link #OPEN_READWRITE} 9169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #OPEN_READONLY} {@link #CREATE_IF_NECESSARY} and/or {@link #NO_LOCALIZED_COLLATORS}. 9179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Sets the locale of the database to the the system's current locale. 9199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call {@link #setLocale} if you would like something else.</p> 9209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param path to database file to open and/or create 9229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param factory an optional factory class that is called to instantiate a 9239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cursor when query is called, or null for default 9249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags to control database access mode 9259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the newly opened database 9269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLiteException if the database cannot be opened 9279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static SQLiteDatabase openDatabase(String path, CursorFactory factory, int flags) { 929062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori return openDatabase(path, factory, flags, new DefaultDatabaseErrorHandler()); 930062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 931062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori 932062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori /** 93374f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * Open the database according to the flags {@link #OPEN_READWRITE} 93474f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * {@link #OPEN_READONLY} {@link #CREATE_IF_NECESSARY} and/or {@link #NO_LOCALIZED_COLLATORS}. 93574f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * 93674f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * <p>Sets the locale of the database to the the system's current locale. 93774f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * Call {@link #setLocale} if you would like something else.</p> 93874f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * 93974f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * <p>Accepts input param: a concrete instance of {@link DatabaseErrorHandler} to be 94074f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * used to handle corruption when sqlite reports database corruption.</p> 94174f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * 94274f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @param path to database file to open and/or create 94374f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @param factory an optional factory class that is called to instantiate a 94474f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * cursor when query is called, or null for default 94574f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @param flags to control database access mode 94674f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @param errorHandler the {@link DatabaseErrorHandler} obj to be used to handle corruption 94774f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * when sqlite reports database corruption 94874f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @return the newly opened database 94974f170f9468d3cf6d7d0ef453320141a3e63571bVasu Nori * @throws SQLiteException if the database cannot be opened 950062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori */ 951062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori public static SQLiteDatabase openDatabase(String path, CursorFactory factory, int flags, 952062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori DatabaseErrorHandler errorHandler) { 9536c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori SQLiteDatabase sqliteDatabase = openDatabase(path, factory, flags, errorHandler, 9546c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori (short) 0 /* the main connection handle */); 955a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori 956a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori // set sqlite pagesize to mBlockSize 957a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori if (sBlockSize == 0) { 958a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori // TODO: "/data" should be a static final String constant somewhere. it is hardcoded 959a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori // in several places right now. 960a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori sBlockSize = new StatFs("/data").getBlockSize(); 961a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori } 962a8c24904ebb301d1a95f9c780aabbe4ebe7026c8Vasu Nori sqliteDatabase.setPageSize(sBlockSize); 96357feb5d9a7fd5329c2ae5daeca0ce8f10a7372a7Vasu Nori //STOPSHIP - uncomment the following line 96457feb5d9a7fd5329c2ae5daeca0ce8f10a7372a7Vasu Nori //sqliteDatabase.setJournalMode(path, "TRUNCATE"); 96557feb5d9a7fd5329c2ae5daeca0ce8f10a7372a7Vasu Nori // STOPSHIP remove the following lines 9667b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori if (!path.equalsIgnoreCase(MEMORY_DB_PATH)) { 9677b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori sqliteDatabase.enableWriteAheadLogging(); 9687b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori } 9697b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori // END STOPSHIP 970f9e2bd085f50d557ec48f4e4728fe5a79d37ede5Vasu Nori 971ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori // add this database to the list of databases opened in this process 9720732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori synchronized(mActiveDatabases) { 9730732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori mActiveDatabases.add(new WeakReference<SQLiteDatabase>(sqliteDatabase)); 9740732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 975c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori return sqliteDatabase; 9769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9786c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private static SQLiteDatabase openDatabase(String path, CursorFactory factory, int flags, 9796c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori DatabaseErrorHandler errorHandler, short connectionNum) { 9806c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori SQLiteDatabase db = new SQLiteDatabase(path, factory, flags, errorHandler, connectionNum); 981062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori try { 982ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 983ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, "opening the db : " + path); 984ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 9856c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // Open the database. 9866c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.dbopen(path, flags); 9876c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.setLocale(Locale.getDefault()); 9886c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (SQLiteDebug.DEBUG_SQL_STATEMENTS) { 9896c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.enableSqlTracing(path, connectionNum); 9906c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 9916c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (SQLiteDebug.DEBUG_SQL_TIME) { 9926c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.enableSqlProfiling(path, connectionNum); 9936c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 9946c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori return db; 9956c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } catch (SQLiteDatabaseCorruptException e) { 9966c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.mErrorHandler.onCorruption(db); 9976c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori return SQLiteDatabase.openDatabase(path, factory, flags, errorHandler); 9986c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } catch (SQLiteException e) { 9996c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori Log.e(TAG, "Failed to open the database. closing it.", e); 10006c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori db.close(); 1001062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori throw e; 1002062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 1003062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 1004062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori 10059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Equivalent to openDatabase(file.getPath(), factory, CREATE_IF_NECESSARY). 10079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static SQLiteDatabase openOrCreateDatabase(File file, CursorFactory factory) { 10099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return openOrCreateDatabase(file.getPath(), factory); 10109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Equivalent to openDatabase(path, factory, CREATE_IF_NECESSARY). 10149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static SQLiteDatabase openOrCreateDatabase(String path, CursorFactory factory) { 10169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return openDatabase(path, factory, CREATE_IF_NECESSARY); 10179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10206c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Equivalent to openDatabase(path, factory, CREATE_IF_NECESSARY, errorHandler). 1021062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori */ 1022062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori public static SQLiteDatabase openOrCreateDatabase(String path, CursorFactory factory, 1023062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori DatabaseErrorHandler errorHandler) { 1024062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori return openDatabase(path, factory, CREATE_IF_NECESSARY, errorHandler); 1025062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 1026062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori 1027a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori private void setJournalMode(final String dbPath, final String mode) { 1028a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori // journal mode can be set only for non-memory databases 1029a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori if (!dbPath.equalsIgnoreCase(MEMORY_DB_PATH)) { 1030a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori String s = DatabaseUtils.stringForQuery(this, "PRAGMA journal_mode=" + mode, null); 1031a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori if (!s.equalsIgnoreCase(mode)) { 1032a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori Log.e(TAG, "setting journal_mode to " + mode + " failed for db: " + dbPath + 1033a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori " (on pragma set journal_mode, sqlite returned:" + s); 1034a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori } 1035a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori } 1036a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori } 1037a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori 1038062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori /** 10399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a memory backed SQLite database. Its contents will be destroyed 10409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when the database is closed. 10419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Sets the locale of the database to the the system's current locale. 10439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call {@link #setLocale} if you would like something else.</p> 10449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param factory an optional factory class that is called to instantiate a 10469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * cursor when query is called 10479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return a SQLiteDatabase object, or null if the database can't be created 10489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static SQLiteDatabase create(CursorFactory factory) { 10509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // This is a magic string with special meaning for SQLite. 1051a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori return openDatabase(MEMORY_DB_PATH, factory, CREATE_IF_NECESSARY); 10529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Close the database. 10569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close() { 1058f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori if (!isOpen()) { 1059f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori return; // already closed 1060f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori } 1061ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 10627501010b71d57264a06f82937f5fb29cb9f4b509Vasu Nori Log.i(TAG, "closing db: " + mPath + " (connection # " + mConnectionNum); 10637501010b71d57264a06f82937f5fb29cb9f4b509Vasu Nori } 10649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project lock(); 10659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 10669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project closeClosable(); 1067fea6f6dcb70e3fa7f60cab970ed444b5e5e2a3faVasu Nori // finalize ALL statements queued up so far 1068fea6f6dcb70e3fa7f60cab970ed444b5e5e2a3faVasu Nori closePendingStatements(); 10699d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood releaseCustomFunctions(); 1070f6373e9513002f55bbe00180a5eb9f1051d53547Vasu Nori // close this database instance - regardless of its reference count value 1071ad239ab8fabe53e5f82ff80fb8c9260386dd900cVasu Nori dbclose(); 10726c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (mConnectionPool != null) { 1073ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 1074ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori assert mConnectionPool != null; 1075ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, mConnectionPool.toString()); 1076ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 10776c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori mConnectionPool.close(); 10786c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 10799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 10809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project unlock(); 10819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void closeClosable() { 1085ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori /* deallocate all compiled SQL statement objects from mCompiledQueries cache. 1086e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * this should be done before de-referencing all {@link SQLiteClosable} objects 1087e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * from this database object because calling 1088e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * {@link SQLiteClosable#onAllReferencesReleasedFromContainer()} could cause the database 1089e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * to be closed. sqlite doesn't let a database close if there are 1090e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * any unfinalized statements - such as the compiled-sql objects in mCompiledQueries. 1091e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori */ 1092e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori deallocCachedSqlStatements(); 1093e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 10949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Iterator<Map.Entry<SQLiteClosable, Object>> iter = mPrograms.entrySet().iterator(); 10959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project while (iter.hasNext()) { 10969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Map.Entry<SQLiteClosable, Object> entry = iter.next(); 10979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SQLiteClosable program = entry.getKey(); 10989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (program != null) { 10999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project program.onAllReferencesReleasedFromContainer(); 11009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1101600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov } 11029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1103600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 11049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Native call to close the database. 11069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native void dbclose(); 11089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11109d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * A callback interface for a custom sqlite3 function. 11119d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * This can be used to create a function that can be called from 11129d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * sqlite3 database triggers. 11139d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * @hide 11149d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood */ 11159d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood public interface CustomFunction { 11169d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood public void callback(String[] args); 11179d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11189d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood 11199d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood /** 11209d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * Registers a CustomFunction callback as a function that can be called from 11219d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * sqlite3 database triggers. 11229d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * @param name the name of the sqlite3 function 11239d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * @param numArgs the number of arguments for the function 11249d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * @param function callback to call when the function is executed 11259d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood * @hide 11269d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood */ 11279d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood public void addCustomFunction(String name, int numArgs, CustomFunction function) { 11289d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood verifyDbIsOpen(); 11299d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood synchronized (mCustomFunctions) { 11309d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood int ref = native_addCustomFunction(name, numArgs, function); 11319d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood if (ref != 0) { 11329d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood // save a reference to the function for cleanup later 11339d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood mCustomFunctions.add(new Integer(ref)); 11349d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } else { 11359d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood throw new SQLiteException("failed to add custom function " + name); 11369d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11379d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11389d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11399d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood 11409d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood private void releaseCustomFunctions() { 11419d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood synchronized (mCustomFunctions) { 11429d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood for (int i = 0; i < mCustomFunctions.size(); i++) { 11439d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood Integer function = mCustomFunctions.get(i); 11449d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood native_releaseCustomFunction(function.intValue()); 11459d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11469d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood mCustomFunctions.clear(); 11479d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11489d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 11499d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood 11509d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood // list of CustomFunction references so we can clean up when the database closes 11519d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood private final ArrayList<Integer> mCustomFunctions = 11529d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood new ArrayList<Integer>(); 11539d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood 11549d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood private native int native_addCustomFunction(String name, int numArgs, CustomFunction function); 11559d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood private native void native_releaseCustomFunction(int function); 11569d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood 11579d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood /** 11589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the database version. 11599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the database version 11619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getVersion() { 1163ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori return ((Long) DatabaseUtils.longForQuery(this, "PRAGMA user_version;", null)).intValue(); 11649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the database version. 11689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param version the new database version 11709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setVersion(int version) { 11729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project execSQL("PRAGMA user_version = " + version); 11739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the maximum size the database may grow to. 11779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the new maximum database size 11799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long getMaximumSize() { 1181ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori long pageCount = DatabaseUtils.longForQuery(this, "PRAGMA max_page_count;", null); 1182ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori return pageCount * getPageSize(); 11839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the maximum size the database will grow to. The maximum size cannot 11879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be set below the current size. 11889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numBytes the maximum database size, in bytes 11909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the new maximum database size 11919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long setMaximumSize(long numBytes) { 1193ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori long pageSize = getPageSize(); 1194ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori long numPages = numBytes / pageSize; 1195ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori // If numBytes isn't a multiple of pageSize, bump up a page 1196ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori if ((numBytes % pageSize) != 0) { 1197ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori numPages++; 11989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori long newPageCount = DatabaseUtils.longForQuery(this, "PRAGMA max_page_count = " + numPages, 1200ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori null); 1201ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori return newPageCount * pageSize; 12029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the current database page size, in bytes. 12069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the database page size, in bytes 12089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long getPageSize() { 1210ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori return DatabaseUtils.longForQuery(this, "PRAGMA page_size;", null); 12119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the database page size. The page size must be a power of two. This 12159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * method does not work if any data has been written to the database file, 12169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and must be called right after the database has been created. 12179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numBytes the database page size, in bytes 12199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setPageSize(long numBytes) { 12219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project execSQL("PRAGMA page_size = " + numBytes); 12229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Mark this table as syncable. When an update occurs in this table the 12269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * _sync_dirty field will be set to ensure proper syncing operation. 12279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to mark as syncable 12299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param deletedTable The deleted table that corresponds to the 12309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * syncable table 123195675137f417173dc711a2d39232a1f545799013Vasu Nori * @deprecated This method no longer serves any useful purpose and has been deprecated. 12329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 123395675137f417173dc711a2d39232a1f545799013Vasu Nori @Deprecated 12349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void markTableSyncable(String table, String deletedTable) { 12359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Mark this table as syncable, with the _sync_dirty residing in another 12399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * table. When an update occurs in this table the _sync_dirty field of the 12409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * row in updateTable with the _id in foreignKey will be set to 12419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ensure proper syncing operation. 12429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table an update on this table will trigger a sync time removal 12449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param foreignKey this is the column in table whose value is an _id in 12459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * updateTable 12469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param updateTable this is the table that will have its _sync_dirty 124795675137f417173dc711a2d39232a1f545799013Vasu Nori * @deprecated This method no longer serves any useful purpose and has been deprecated. 12489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 124995675137f417173dc711a2d39232a1f545799013Vasu Nori @Deprecated 125095675137f417173dc711a2d39232a1f545799013Vasu Nori public void markTableSyncable(String table, String foreignKey, String updateTable) { 12519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Finds the name of the first table, which is editable. 12559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tables a list of tables 12579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the first table listed 12589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static String findEditTable(String tables) { 12609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!TextUtils.isEmpty(tables)) { 12619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // find the first word terminated by either a space or a comma 12629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int spacepos = tables.indexOf(' '); 12639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int commapos = tables.indexOf(','); 12649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (spacepos > 0 && (spacepos < commapos || commapos < 0)) { 12669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return tables.substring(0, spacepos); 12679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else if (commapos > 0 && (commapos < spacepos || spacepos < 0) ) { 12689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return tables.substring(0, commapos); 12699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return tables; 12719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 12729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("Invalid tables"); 12739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Compiles an SQL statement into a reusable pre-compiled statement object. 12789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The parameters are identical to {@link #execSQL(String)}. You may put ?s in the 12799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * statement and fill in those values with {@link SQLiteProgram#bindString} 12809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and {@link SQLiteProgram#bindLong} each time you want to run the 12819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * statement. Statements may not return result sets larger than 1x1. 12822827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori *<p> 12832827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori * No two threads should be using the same {@link SQLiteStatement} at the same time. 12849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param sql The raw SQL statement, may contain ? for unknown values to be 12869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * bound later. 1287f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A pre-compiled {@link SQLiteStatement} object. Note that 1288f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link SQLiteStatement}s are not synchronized, see the documentation for more details. 12899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SQLiteStatement compileStatement(String sql) throws SQLException { 1291ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 12920732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori return new SQLiteStatement(this, sql, null); 12939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Query the given URL, returning a {@link Cursor} over the result set. 12979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param distinct true if you want each row to be unique, false otherwise. 12999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table The table name to compile the query against. 13009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columns A list of which columns to return. Passing null will 13019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return all columns, which is discouraged to prevent reading 13029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data from storage that isn't going to be used. 13039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selection A filter declaring which rows to return, formatted as an 13049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SQL WHERE clause (excluding the WHERE itself). Passing null 13059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will return all rows for the given table. 13069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in selection, which will be 13079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaced by the values from selectionArgs, in order that they 13089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appear in the selection. The values will be bound as Strings. 13099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupBy A filter declaring how to group rows, formatted as an SQL 13109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * GROUP BY clause (excluding the GROUP BY itself). Passing null 13119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will cause the rows to not be grouped. 13129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param having A filter declare which row groups to include in the cursor, 13139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if row grouping is being used, formatted as an SQL HAVING 13149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clause (excluding the HAVING itself). Passing null will cause 13159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * all row groups to be included, and is required when row 13169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * grouping is not being used. 13179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause 13189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (excluding the ORDER BY itself). Passing null will use the 13199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default sort order, which may be unordered. 13209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param limit Limits the number of rows returned by the query, 13219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * formatted as LIMIT clause. Passing null denotes no LIMIT clause. 1322f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1323f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 13249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Cursor 13259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor query(boolean distinct, String table, String[] columns, 13279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String selection, String[] selectionArgs, String groupBy, 13289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String having, String orderBy, String limit) { 13299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return queryWithFactory(null, distinct, table, columns, selection, selectionArgs, 13309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project groupBy, having, orderBy, limit); 13319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Query the given URL, returning a {@link Cursor} over the result set. 13359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 13369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param cursorFactory the cursor factory to use, or null for the default factory 13379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param distinct true if you want each row to be unique, false otherwise. 13389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table The table name to compile the query against. 13399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columns A list of which columns to return. Passing null will 13409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return all columns, which is discouraged to prevent reading 13419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data from storage that isn't going to be used. 13429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selection A filter declaring which rows to return, formatted as an 13439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SQL WHERE clause (excluding the WHERE itself). Passing null 13449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will return all rows for the given table. 13459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in selection, which will be 13469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaced by the values from selectionArgs, in order that they 13479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appear in the selection. The values will be bound as Strings. 13489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupBy A filter declaring how to group rows, formatted as an SQL 13499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * GROUP BY clause (excluding the GROUP BY itself). Passing null 13509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will cause the rows to not be grouped. 13519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param having A filter declare which row groups to include in the cursor, 13529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if row grouping is being used, formatted as an SQL HAVING 13539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clause (excluding the HAVING itself). Passing null will cause 13549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * all row groups to be included, and is required when row 13559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * grouping is not being used. 13569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause 13579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (excluding the ORDER BY itself). Passing null will use the 13589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default sort order, which may be unordered. 13599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param limit Limits the number of rows returned by the query, 13609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * formatted as LIMIT clause. Passing null denotes no LIMIT clause. 1361f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1362f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 13639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Cursor 13649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor queryWithFactory(CursorFactory cursorFactory, 13669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean distinct, String table, String[] columns, 13679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String selection, String[] selectionArgs, String groupBy, 13689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String having, String orderBy, String limit) { 1369ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 13709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String sql = SQLiteQueryBuilder.buildQueryString( 13719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project distinct, table, columns, selection, groupBy, having, orderBy, limit); 13729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return rawQueryWithFactory( 13749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project cursorFactory, sql, selectionArgs, findEditTable(table)); 13759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Query the given table, returning a {@link Cursor} over the result set. 13799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 13809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table The table name to compile the query against. 13819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columns A list of which columns to return. Passing null will 13829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return all columns, which is discouraged to prevent reading 13839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data from storage that isn't going to be used. 13849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selection A filter declaring which rows to return, formatted as an 13859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SQL WHERE clause (excluding the WHERE itself). Passing null 13869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will return all rows for the given table. 13879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in selection, which will be 13889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaced by the values from selectionArgs, in order that they 13899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appear in the selection. The values will be bound as Strings. 13909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupBy A filter declaring how to group rows, formatted as an SQL 13919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * GROUP BY clause (excluding the GROUP BY itself). Passing null 13929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will cause the rows to not be grouped. 13939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param having A filter declare which row groups to include in the cursor, 13949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if row grouping is being used, formatted as an SQL HAVING 13959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clause (excluding the HAVING itself). Passing null will cause 13969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * all row groups to be included, and is required when row 13979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * grouping is not being used. 13989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause 13999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (excluding the ORDER BY itself). Passing null will use the 14009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default sort order, which may be unordered. 1401f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1402f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 14039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Cursor 14049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor query(String table, String[] columns, String selection, 14069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String[] selectionArgs, String groupBy, String having, 14079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String orderBy) { 14089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return query(false, table, columns, selection, selectionArgs, groupBy, 14109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project having, orderBy, null /* limit */); 14119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 14149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Query the given table, returning a {@link Cursor} over the result set. 14159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 14169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table The table name to compile the query against. 14179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param columns A list of which columns to return. Passing null will 14189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return all columns, which is discouraged to prevent reading 14199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data from storage that isn't going to be used. 14209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selection A filter declaring which rows to return, formatted as an 14219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SQL WHERE clause (excluding the WHERE itself). Passing null 14229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will return all rows for the given table. 14239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in selection, which will be 14249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaced by the values from selectionArgs, in order that they 14259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appear in the selection. The values will be bound as Strings. 14269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupBy A filter declaring how to group rows, formatted as an SQL 14279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * GROUP BY clause (excluding the GROUP BY itself). Passing null 14289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will cause the rows to not be grouped. 14299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param having A filter declare which row groups to include in the cursor, 14309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if row grouping is being used, formatted as an SQL HAVING 14319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clause (excluding the HAVING itself). Passing null will cause 14329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * all row groups to be included, and is required when row 14339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * grouping is not being used. 14349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause 14359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (excluding the ORDER BY itself). Passing null will use the 14369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default sort order, which may be unordered. 14379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param limit Limits the number of rows returned by the query, 14389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * formatted as LIMIT clause. Passing null denotes no LIMIT clause. 1439f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1440f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 14419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Cursor 14429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor query(String table, String[] columns, String selection, 14449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String[] selectionArgs, String groupBy, String having, 14459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String orderBy, String limit) { 14469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return query(false, table, columns, selection, selectionArgs, groupBy, 14489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project having, orderBy, limit); 14499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 14529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Runs the provided SQL and returns a {@link Cursor} over the result set. 14539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 14549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param sql the SQL query. The SQL string must not be ; terminated 14559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in where clause in the query, 14569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * which will be replaced by the values from selectionArgs. The 14579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * values will be bound as Strings. 1458f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1459f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 14609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor rawQuery(String sql, String[] selectionArgs) { 14629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return rawQueryWithFactory(null, sql, selectionArgs, null); 14639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 14669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Runs the provided SQL and returns a cursor over the result set. 14679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 14689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param cursorFactory the cursor factory to use, or null for the default factory 14699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param sql the SQL query. The SQL string must not be ; terminated 14709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in where clause in the query, 14719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * which will be replaced by the values from selectionArgs. The 14729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * values will be bound as Strings. 14739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param editTable the name of the first table, which is editable 1474f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1475f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 14769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Cursor rawQueryWithFactory( 14789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CursorFactory cursorFactory, String sql, String[] selectionArgs, 14799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String editTable) { 1480ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 1481cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick BlockGuard.getThreadPolicy().onReadFromDisk(); 14829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project long timeStart = 0; 14839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 148490142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov if (Config.LOGV || mSlowQueryThreshold != -1) { 14859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project timeStart = System.currentTimeMillis(); 14869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14886c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori SQLiteDatabase db = getDbConnection(sql); 14896c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori SQLiteCursorDriver driver = new SQLiteDirectCursorDriver(db, sql, editTable); 14909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 149190142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov Cursor cursor = null; 14929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 149390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov cursor = driver.query( 14949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project cursorFactory != null ? cursorFactory : mFactory, 14959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project selectionArgs); 14969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 149790142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov if (Config.LOGV || mSlowQueryThreshold != -1) { 149890142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov 1499020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori // Force query execution 1500020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori int count = -1; 1501020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori if (cursor != null) { 1502020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori count = cursor.getCount(); 1503020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori } 1504020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori 15059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project long duration = System.currentTimeMillis() - timeStart; 15069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 150790142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov if (Config.LOGV || duration >= mSlowQueryThreshold) { 150890142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov Log.v(SQLiteCursor.TAG, 150990142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov "query (" + duration + " ms): " + driver.toString() + ", args are " 151090142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov + (selectionArgs != null 151190142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov ? TextUtils.join(",", selectionArgs) 1512020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori : "<null>") + ", count is " + count); 151390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov } 15149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15156c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori releaseDbConnection(db); 15169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 151790142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov return cursor; 15189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Runs the provided SQL and returns a cursor over the result set. 1522600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * The cursor will read an initial set of rows and the return to the caller. 1523600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * It will continue to read in batches and send data changed notifications 15249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when the later batches are ready. 15259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param sql the SQL query. The SQL string must not be ; terminated 15269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectionArgs You may include ?s in where clause in the query, 15279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * which will be replaced by the values from selectionArgs. The 15289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * values will be bound as Strings. 15299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialRead set the initial count of items to read from the cursor 15309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param maxRead set the count of items to read on each iteration after the first 1531f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * @return A {@link Cursor} object, which is positioned before the first entry. Note that 1532f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton * {@link Cursor}s are not synchronized, see the documentation for more details. 1533600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov * 1534f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler * This work is incomplete and not fully tested or reviewed, so currently 1535f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler * hidden. 1536f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler * @hide 15379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1538600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov public Cursor rawQuery(String sql, String[] selectionArgs, 15399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int initialRead, int maxRead) { 15409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SQLiteCursor c = (SQLiteCursor)rawQueryWithFactory( 15419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project null, sql, selectionArgs, null); 15429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project c.setLoadStyle(initialRead, maxRead); 15439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return c; 15449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1545600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 15469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for inserting a row into the database. 15489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to insert the row into 15509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param nullColumnHack SQL doesn't allow inserting a completely empty row, 15519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * so if initialValues is empty this column will explicitly be 15529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * assigned a NULL value 15539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param values this map contains the initial column values for the 15549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * row. The keys should be the column names and the values the 15559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column values 15569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the row ID of the newly inserted row, or -1 if an error occurred 15579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long insert(String table, String nullColumnHack, ContentValues values) { 15599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 15608d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori return insertWithOnConflict(table, nullColumnHack, values, CONFLICT_NONE); 15619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLException e) { 15629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e(TAG, "Error inserting " + values, e); 15639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return -1; 15649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for inserting a row into the database. 15699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to insert the row into 15719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param nullColumnHack SQL doesn't allow inserting a completely empty row, 15729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * so if initialValues is empty this column will explicitly be 15739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * assigned a NULL value 15749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param values this map contains the initial column values for the 15759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * row. The keys should be the column names and the values the 15769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column values 15779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLException 15789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the row ID of the newly inserted row, or -1 if an error occurred 15799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long insertOrThrow(String table, String nullColumnHack, ContentValues values) 15819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws SQLException { 15828d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori return insertWithOnConflict(table, nullColumnHack, values, CONFLICT_NONE); 15839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for replacing a row in the database. 15879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table in which to replace the row 15899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param nullColumnHack SQL doesn't allow inserting a completely empty row, 15909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * so if initialValues is empty this row will explicitly be 15919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * assigned a NULL value 15929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialValues this map contains the initial column values for 15939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the row. The key 15949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the row ID of the newly inserted row, or -1 if an error occurred 15959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long replace(String table, String nullColumnHack, ContentValues initialValues) { 15979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1598600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov return insertWithOnConflict(table, nullColumnHack, initialValues, 15998d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori CONFLICT_REPLACE); 16009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLException e) { 16019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e(TAG, "Error inserting " + initialValues, e); 16029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return -1; 16039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for replacing a row in the database. 16089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table in which to replace the row 16109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param nullColumnHack SQL doesn't allow inserting a completely empty row, 16119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * so if initialValues is empty this row will explicitly be 16129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * assigned a NULL value 16139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialValues this map contains the initial column values for 16149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the row. The key 16159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLException 16169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the row ID of the newly inserted row, or -1 if an error occurred 16179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long replaceOrThrow(String table, String nullColumnHack, 16199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ContentValues initialValues) throws SQLException { 1620600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov return insertWithOnConflict(table, nullColumnHack, initialValues, 16218d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori CONFLICT_REPLACE); 16229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * General method for inserting a row into the database. 16269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to insert the row into 16289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param nullColumnHack SQL doesn't allow inserting a completely empty row, 16299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * so if initialValues is empty this column will explicitly be 16309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * assigned a NULL value 16319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param initialValues this map contains the initial column values for the 16329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * row. The keys should be the column names and the values the 16339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * column values 16348d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * @param conflictAlgorithm for insert conflict resolver 16356eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori * @return the row ID of the newly inserted row 16366eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori * OR the primary key of the existing row if the input param 'conflictAlgorithm' = 16378d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * {@link #CONFLICT_IGNORE} 16386eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori * OR -1 if any error 16399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long insertWithOnConflict(String table, String nullColumnHack, 16416eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori ContentValues initialValues, int conflictAlgorithm) { 16420732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori StringBuilder sql = new StringBuilder(); 16439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append("INSERT"); 16448d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori sql.append(CONFLICT_VALUES[conflictAlgorithm]); 16459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(" INTO "); 16469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(table); 16470732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append('('); 16480732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori 16490732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori Object[] bindArgs = null; 16500732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int size = (initialValues != null && initialValues.size() > 0) ? initialValues.size() : 0; 16510732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (size > 0) { 16520732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori bindArgs = new Object[size]; 16530732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int i = 0; 16540732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (String colName : initialValues.keySet()) { 16550732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append((i > 0) ? "," : ""); 16560732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append(colName); 16570732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori bindArgs[i++] = initialValues.get(colName); 16589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(')'); 16600732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append(" VALUES ("); 16610732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (i = 0; i < size; i++) { 16620732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append((i > 0) ? ",?" : "?"); 16630732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 16649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 16650732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append(nullColumnHack + ") VALUES (NULL"); 16669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16670732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append(')'); 16689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16690732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori SQLiteStatement statement = new SQLiteStatement(this, sql.toString(), bindArgs); 16709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1671fb16cbd9b2e86d6878d4bff820422bc09c8938deVasu Nori return statement.executeInsert(); 16729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 16739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onCorruption(); 16749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 16759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 16760732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori statement.close(); 16779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for deleting rows in the database. 16829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to delete from 16849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param whereClause the optional WHERE clause to apply when deleting. 16859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Passing null will delete all rows. 16869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the number of rows affected if a whereClause is passed in, 0 16879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * otherwise. To remove all rows and get a count pass "1" as the 16889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * whereClause. 16899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int delete(String table, String whereClause, String[] whereArgs) { 16910732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori SQLiteStatement statement = new SQLiteStatement(this, "DELETE FROM " + table + 16920732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori (!TextUtils.isEmpty(whereClause) ? " WHERE " + whereClause : ""), whereArgs); 16939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1694fb16cbd9b2e86d6878d4bff820422bc09c8938deVasu Nori return statement.executeUpdateDelete(); 16959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 16969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onCorruption(); 16979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 16989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 16990732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori statement.close(); 17009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for updating rows in the database. 17059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to update in 17079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param values a map from column names to new column values. null is a 17089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * valid value that will be translated to NULL. 17099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param whereClause the optional WHERE clause to apply when updating. 17109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Passing null will update all rows. 17119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the number of rows affected 17129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int update(String table, ContentValues values, String whereClause, String[] whereArgs) { 17148d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori return updateWithOnConflict(table, values, whereClause, whereArgs, CONFLICT_NONE); 17159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1716600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov 17179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Convenience method for updating rows in the database. 17199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param table the table to update in 17219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param values a map from column names to new column values. null is a 17229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * valid value that will be translated to NULL. 17239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param whereClause the optional WHERE clause to apply when updating. 17249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Passing null will update all rows. 17258d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori * @param conflictAlgorithm for update conflict resolver 17269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the number of rows affected 17279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1728600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov public int updateWithOnConflict(String table, ContentValues values, 17296eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori String whereClause, String[] whereArgs, int conflictAlgorithm) { 17300732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int setValuesSize = values.size(); 17310732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (values == null || setValuesSize == 0) { 17329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("Empty values"); 17339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder sql = new StringBuilder(120); 17369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append("UPDATE "); 17378d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori sql.append(CONFLICT_VALUES[conflictAlgorithm]); 17389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(table); 17399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(" SET "); 17409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17410732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // move all bind args to one array 17420732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int bindArgsSize = (whereArgs == null) ? setValuesSize : (setValuesSize + whereArgs.length); 17430732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori Object[] bindArgs = new Object[bindArgsSize]; 17440732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int i = 0; 17450732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (String colName : values.keySet()) { 17460732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append((i > 0) ? "," : ""); 17470732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori sql.append(colName); 17480732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori bindArgs[i++] = values.get(colName); 17499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append("=?"); 17500732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 17510732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (whereArgs != null) { 17520732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (i = setValuesSize; i < bindArgsSize; i++) { 17530732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori bindArgs[i] = whereArgs[i - setValuesSize]; 17549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!TextUtils.isEmpty(whereClause)) { 17579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(" WHERE "); 17589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sql.append(whereClause); 17599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17610732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori SQLiteStatement statement = new SQLiteStatement(this, sql.toString(), bindArgs); 17629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1763fb16cbd9b2e86d6878d4bff820422bc09c8938deVasu Nori return statement.executeUpdateDelete(); 17649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 17659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onCorruption(); 17669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 17679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 17680732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori statement.close(); 17699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1773ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Execute a single SQL statement that is NOT a SELECT 1774ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * or any other SQL statement that returns data. 1775ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 1776ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori * It has no means to return any data (such as the number of affected rows). 1777ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Instead, you're encouraged to use {@link #insert(String, String, ContentValues)}, 1778ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * {@link #update(String, ContentValues, String, String[])}, et al, when possible. 1779ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </p> 17809bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * <p> 17819bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * When using {@link #enableWriteAheadLogging()}, journal_mode is 17829bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * automatically managed by this class. So, do not set journal_mode 17839bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * using "PRAGMA journal_mode'<value>" statement if your app is using 17849bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * {@link #enableWriteAheadLogging()} 17859bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * </p> 17869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1787ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * @param sql the SQL statement to be executed. Multiple statements separated by semicolons are 1788ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * not supported. 17899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLException If the SQL string is invalid for some reason 17909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void execSQL(String sql) throws SQLException { 1792ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori int stmtType = DatabaseUtils.getSqlStatementType(sql); 1793ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (stmtType == DatabaseUtils.STATEMENT_ATTACH) { 17948d1110383d4437eeebae337026cd91449e4e55a5Vasu Nori disableWriteAheadLogging(); 17958d1110383d4437eeebae337026cd91449e4e55a5Vasu Nori } 1796c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori long timeStart = SystemClock.uptimeMillis(); 1797722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick logTimeStat(mLastSqlStatement, timeStart, GET_LOCK_LOG_PREFIX); 1798ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori executeSql(sql, null); 1799b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick 1800b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // Log commit statements along with the most recently executed 1801ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori // SQL statement for disambiguation. 1802ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (stmtType == DatabaseUtils.STATEMENT_COMMIT) { 1803722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick logTimeStat(mLastSqlStatement, timeStart, COMMIT_SQL); 1804b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick } else { 1805722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick logTimeStat(sql, timeStart, null); 1806b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick } 18079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 18089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 18099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1810ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Execute a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE. 1811ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 1812ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * For INSERT statements, use any of the following instead. 1813ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <ul> 1814ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #insert(String, String, ContentValues)}</li> 1815ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #insertOrThrow(String, String, ContentValues)}</li> 1816ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #insertWithOnConflict(String, String, ContentValues, int)}</li> 1817ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </ul> 1818ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 1819ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * For UPDATE statements, use any of the following instead. 1820ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <ul> 1821ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #update(String, ContentValues, String, String[])}</li> 1822ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #updateWithOnConflict(String, ContentValues, String, String[], int)}</li> 1823ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </ul> 1824ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 1825ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * For DELETE statements, use any of the following instead. 1826ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <ul> 1827ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>{@link #delete(String, String, String[])}</li> 1828ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </ul> 1829ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 1830ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * For example, the following are good candidates for using this method: 1831ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <ul> 1832ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>ALTER TABLE</li> 1833ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>CREATE or DROP table / trigger / view / index / virtual table</li> 1834ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>REINDEX</li> 1835ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>RELEASE</li> 1836ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>SAVEPOINT</li> 1837ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <li>PRAGMA that returns no data</li> 1838ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </ul> 1839ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * </p> 18409bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * <p> 18419bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * When using {@link #enableWriteAheadLogging()}, journal_mode is 18429bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * automatically managed by this class. So, do not set journal_mode 18439bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * using "PRAGMA journal_mode'<value>" statement if your app is using 18449bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * {@link #enableWriteAheadLogging()} 18459bf225ef7b82b5eacee1907155a8a8bbb6aa7f42Vasu Nori * </p> 18469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1847ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * @param sql the SQL statement to be executed. Multiple statements separated by semicolons are 1848ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * not supported. 18499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param bindArgs only byte[], String, Long and Double are supported in bindArgs. 18509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLException If the SQL string is invalid for some reason 18519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 18529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void execSQL(String sql, Object[] bindArgs) throws SQLException { 18539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (bindArgs == null) { 18549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("Empty bindArgs"); 18559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1856ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori executeSql(sql, bindArgs); 1857ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 1858ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori 1859ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori private void executeSql(String sql, Object[] bindArgs) throws SQLException { 1860d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick long timeStart = SystemClock.uptimeMillis(); 18610732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori SQLiteStatement statement = new SQLiteStatement(this, sql, bindArgs); 18629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 18630732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori statement.executeUpdateDelete(); 18649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (SQLiteDatabaseCorruptException e) { 18659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onCorruption(); 18669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw e; 18679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } finally { 18680732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori statement.close(); 18699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 187012311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor logTimeStat(sql, timeStart); 18719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 18729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 18739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 18749d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood protected void finalize() throws Throwable { 18759d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood try { 18769d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood if (isOpen()) { 18779d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood Log.e(TAG, "close() was never explicitly called on database '" + 18789d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood mPath + "' ", mStackTrace); 18799d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood closeClosable(); 18809d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood onAllReferencesReleased(); 18819d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood releaseCustomFunctions(); 18829d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } 18839d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood } finally { 18849d9c1be296db26c6ad36b8593fb77ca263422665Mike Lockwood super.finalize(); 18859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 18869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 18879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 18889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 18892134369e803e944af84e73dcaf9356609a5481c6Vasu Nori * Private constructor. 18909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 18919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param path The full path to the database 18929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param factory The factory to use when creating cursors, may be NULL. 18939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags 0 or {@link #NO_LOCALIZED_COLLATORS}. If the database file already 18949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * exists, mFlags will be updated appropriately. 18952134369e803e944af84e73dcaf9356609a5481c6Vasu Nori * @param errorHandler The {@link DatabaseErrorHandler} to be used when sqlite reports database 18962134369e803e944af84e73dcaf9356609a5481c6Vasu Nori * corruption. may be NULL. 18976c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * @param connectionNum 0 for main database connection handle. 1..N for pooled database 18986c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * connection handles. 18999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 19002134369e803e944af84e73dcaf9356609a5481c6Vasu Nori private SQLiteDatabase(String path, CursorFactory factory, int flags, 19016c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori DatabaseErrorHandler errorHandler, short connectionNum) { 19029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (path == null) { 19039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("path should not be null"); 19049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mFlags = flags; 19069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPath = path; 190790142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov mSlowQueryThreshold = SystemProperties.getInt(LOG_SLOW_QUERIES_PROPERTY, -1); 190808b448ea39e9fabfc5212ae6f7226eba4385d189Vasu Nori mStackTrace = new DatabaseObjectNotClosedException().fillInStackTrace(); 19099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mFactory = factory; 19109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPrograms = new WeakHashMap<SQLiteClosable,Object>(); 19112134369e803e944af84e73dcaf9356609a5481c6Vasu Nori // Set the DatabaseErrorHandler to be used when SQLite reports corruption. 19122134369e803e944af84e73dcaf9356609a5481c6Vasu Nori // If the caller sets errorHandler = null, then use default errorhandler. 19132134369e803e944af84e73dcaf9356609a5481c6Vasu Nori mErrorHandler = (errorHandler == null) ? new DefaultDatabaseErrorHandler() : errorHandler; 19146c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori mConnectionNum = connectionNum; 19159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 19179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 19189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return whether the DB is opened as read only. 19199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if DB is opened as read only 19209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 19219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isReadOnly() { 19229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return (mFlags & OPEN_READ_MASK) == OPEN_READONLY; 19239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 19259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 19269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if the DB is currently open (has not been closed) 19279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 19289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isOpen() { 19299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mNativeHandle != 0; 19309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 19329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean needUpgrade(int newVersion) { 19339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return newVersion > getVersion(); 19349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 19369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 19379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Getter for the path to the database file. 19389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 19399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the path to our database file. 19409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 19419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final String getPath() { 19429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPath; 19439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 19449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1945d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick /* package */ void logTimeStat(String sql, long beginMillis) { 1946722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick logTimeStat(sql, beginMillis, null); 1947722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick } 1948722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick 1949722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick /* package */ void logTimeStat(String sql, long beginMillis, String prefix) { 1950b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // Keep track of the last statement executed here, as this is 1951b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // the common funnel through which all methods of hitting 1952b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick // libsqlite eventually flow. 1953b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick mLastSqlStatement = sql; 1954b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick 1955e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // Sample fast queries in proportion to the time taken. 1956e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // Quantize the % first, so the logged sampling probability 1957e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // exactly equals the actual sampling rate for this query. 1958e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 1959e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori int samplePercent; 1960d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick long durationMillis = SystemClock.uptimeMillis() - beginMillis; 1961722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick if (durationMillis == 0 && prefix == GET_LOCK_LOG_PREFIX) { 1962722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // The common case is locks being uncontended. Don't log those, 1963722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // even at 1%, which is our default below. 1964722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick return; 1965722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick } 1966722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick if (sQueryLogTimeInMillis == 0) { 1967722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick sQueryLogTimeInMillis = SystemProperties.getInt("db.db_operation.threshold_ms", 500); 1968722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick } 1969722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick if (durationMillis >= sQueryLogTimeInMillis) { 1970e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori samplePercent = 100; 1971fb16cbd9b2e86d6878d4bff820422bc09c8938deVasu Nori } else { 1972722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick samplePercent = (int) (100 * durationMillis / sQueryLogTimeInMillis) + 1; 1973e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori if (mRandom.nextInt(100) >= samplePercent) return; 19745a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 1975e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 1976722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // Note: the prefix will be "COMMIT;" or "GETLOCK:" when non-null. We wait to do 1977722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick // it here so we avoid allocating in the common case. 1978722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick if (prefix != null) { 1979722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick sql = prefix + sql; 1980722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick } 1981722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick 1982e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori if (sql.length() > QUERY_LOG_SQL_LENGTH) sql = sql.substring(0, QUERY_LOG_SQL_LENGTH); 1983e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 1984e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // ActivityThread.currentPackageName() only returns non-null if the 1985e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // current thread is an application main thread. This parameter tells 1986e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // us whether an event loop is blocked, and if so, which app it is. 1987e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // 1988e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // Sadly, there's no fast way to determine app name if this is *not* a 1989e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // main thread, or when we are invoked via Binder (e.g. ContentProvider). 1990e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori // Hopefully the full path to the database will be informative enough. 1991e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 199201e4cfc47d0a2c7e7ab383d2fb23224ec52c0301Dianne Hackborn String blockingPackage = AppGlobals.getInitialPackage(); 1993e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori if (blockingPackage == null) blockingPackage = ""; 1994e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 1995d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick EventLog.writeEvent( 1996d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick EVENT_DB_OPERATION, 1997d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick getPathForLogs(), 1998d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick sql, 1999d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick durationMillis, 2000d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick blockingPackage, 2001d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick samplePercent); 2002d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick } 2003d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick 2004d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick /** 2005d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick * Removes email addresses from database filenames before they're 2006d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick * logged to the EventLog where otherwise apps could potentially 2007d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick * read them. 2008d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick */ 2009d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick private String getPathForLogs() { 2010d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick if (mPathForLogs != null) { 2011d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick return mPathForLogs; 2012d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick } 2013d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick if (mPath == null) { 2014d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick return null; 2015d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick } 2016d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick if (mPath.indexOf('@') == -1) { 2017d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick mPathForLogs = mPath; 2018d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick } else { 2019d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick mPathForLogs = EMAIL_IN_DB_PATTERN.matcher(mPath).replaceAll("XX@YY"); 2020d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick } 2021d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick return mPathForLogs; 20225a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 20235a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 20245a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /** 2025e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * Sets the locale for this database. Does nothing if this database has 2026e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * the NO_LOCALIZED_COLLATORS flag set or was opened read only. 2027e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * @throws SQLException if the locale could not be set. The most common reason 2028e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * for this is that there is no collator available for the locale you requested. 2029e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * In this case the database remains unchanged. 20305a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori */ 2031e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori public void setLocale(Locale locale) { 2032e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori lock(); 2033e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori try { 2034e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori native_setLocale(locale.toString(), mFlags); 2035e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori } finally { 2036e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori unlock(); 20375a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 20385a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 20395a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 2040ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori /* package */ void verifyDbIsOpen() { 20419463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori if (!isOpen()) { 20427501010b71d57264a06f82937f5fb29cb9f4b509Vasu Nori throw new IllegalStateException("database " + getPath() + " (conn# " + 20437501010b71d57264a06f82937f5fb29cb9f4b509Vasu Nori mConnectionNum + ") already closed"); 20449463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori } 2045ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori } 2046ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori 2047ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori /* package */ void verifyLockOwner() { 2048ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 2049ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori if (mLockingEnabled && !isDbLockedByCurrentThread()) { 20509463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori throw new IllegalStateException("Don't have database lock!"); 20519463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori } 20529463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori } 20539463f297ef51bd056626d0fb0708c83509f7ebd9Vasu Nori 2054e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori /* 2055e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * ============================================================================ 2056e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * 2057e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * The following methods deal with compiled-sql cache 2058e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * ============================================================================ 2059e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori */ 20605a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /** 2061ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Adds the given SQL and its compiled-statement-id-returned-by-sqlite to the 20625a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * cache of compiledQueries attached to 'this'. 2063ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * <p> 2064ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * If there is already a {@link SQLiteCompiledSql} in compiledQueries for the given SQL, 20655a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * the new {@link SQLiteCompiledSql} object is NOT inserted into the cache (i.e.,the current 20665a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori * mapping is NOT replaced with the new mapping). 20675a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori */ 2068e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori /* package */ void addToCompiledQueries(String sql, SQLiteCompiledSql compiledStatement) { 20695a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori SQLiteCompiledSql compiledSql = null; 20705a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori synchronized(mCompiledQueries) { 20715a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori // don't insert the new mapping if a mapping already exists 20725a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori compiledSql = mCompiledQueries.get(sql); 20735a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori if (compiledSql != null) { 2074e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori return; 20755a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 207620f549fd2f40db524242c9038d7d63356adf95fcVasu Nori 20775a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori if (mCompiledQueries.size() == mMaxSqlCacheSize) { 207849d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori /* 207949d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori * cache size of {@link #mMaxSqlCacheSize} is not enough for this app. 208020f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * log a warning. 208120f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * chances are it is NOT using ? for bindargs - or cachesize is too small. 20825a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori */ 208349d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori if (++mCacheFullWarnings == MAX_WARNINGS_ON_CACHESIZE_CONDITION) { 208449d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori Log.w(TAG, "Reached MAX size for compiled-sql statement cache for database " + 208520f549fd2f40db524242c9038d7d63356adf95fcVasu Nori getPath() + ". Consider increasing cachesize."); 20865a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 208720f549fd2f40db524242c9038d7d63356adf95fcVasu Nori } 208820f549fd2f40db524242c9038d7d63356adf95fcVasu Nori /* add the given SQLiteCompiledSql compiledStatement to cache. 208920f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * no need to worry about the cache size - because {@link #mCompiledQueries} 209020f549fd2f40db524242c9038d7d63356adf95fcVasu Nori * self-limits its size to {@link #mMaxSqlCacheSize}. 209120f549fd2f40db524242c9038d7d63356adf95fcVasu Nori */ 209220f549fd2f40db524242c9038d7d63356adf95fcVasu Nori mCompiledQueries.put(sql, compiledStatement); 209320f549fd2f40db524242c9038d7d63356adf95fcVasu Nori if (SQLiteDebug.DEBUG_SQL_CACHE) { 209420f549fd2f40db524242c9038d7d63356adf95fcVasu Nori Log.v(TAG, "|adding_sql_to_cache|" + getPath() + "|" + 209520f549fd2f40db524242c9038d7d63356adf95fcVasu Nori mCompiledQueries.size() + "|" + sql); 20965a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 20975a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 2098e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori } 2099e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori 2100ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /** package-level access for testing purposes */ 2101ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ void deallocCachedSqlStatements() { 2102e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori synchronized (mCompiledQueries) { 2103e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori for (SQLiteCompiledSql compiledSql : mCompiledQueries.values()) { 2104e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori compiledSql.releaseSqlStatement(); 2105e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori } 2106e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori mCompiledQueries.clear(); 2107e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori } 21085a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 21095a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 21105a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /** 2111ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * From the compiledQueries cache, returns the compiled-statement-id for the given SQL. 2112ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Returns null, if not found in the cache. 21135a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori */ 21145a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori /* package */ SQLiteCompiledSql getCompiledStatementForSql(String sql) { 21155a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori SQLiteCompiledSql compiledStatement = null; 21165a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori boolean cacheHit; 21175a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori synchronized(mCompiledQueries) { 21185a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori cacheHit = (compiledStatement = mCompiledQueries.get(sql)) != null; 21195a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 21205a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori if (cacheHit) { 21215a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori mNumCacheHits++; 21225a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } else { 21235a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori mNumCacheMisses++; 21245a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 21255a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 21265a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori if (SQLiteDebug.DEBUG_SQL_CACHE) { 21275a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori Log.v(TAG, "|cache_stats|" + 21285a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori getPath() + "|" + mCompiledQueries.size() + 21295a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori "|" + mNumCacheHits + "|" + mNumCacheMisses + 213020f549fd2f40db524242c9038d7d63356adf95fcVasu Nori "|" + cacheHit + "|" + sql); 21315a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 21325a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori return compiledStatement; 21335a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori } 21345a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori 2135e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori /** 2136ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Sets the maximum size of the prepared-statement cache for this database. 2137e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * (size of the cache = number of compiled-sql-statements stored in the cache). 2138ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori *<p> 2139ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Maximum cache size can ONLY be increased from its current size (default = 10). 2140ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * If this method is called with smaller size than the current maximum value, 2141ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * then IllegalStateException is thrown. 2142ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori *<p> 2143ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * This method is thread-safe. 2144e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori * 214590a36726b7553a1e7efd2f4ecbe01d7e1b3e7a67Vasu Nori * @param cacheSize the size of the cache. can be (0 to {@link #MAX_SQL_CACHE_SIZE}) 214690a36726b7553a1e7efd2f4ecbe01d7e1b3e7a67Vasu Nori * @throws IllegalStateException if input cacheSize > {@link #MAX_SQL_CACHE_SIZE} or 214790a36726b7553a1e7efd2f4ecbe01d7e1b3e7a67Vasu Nori * > the value set with previous setMaxSqlCacheSize() call. 21489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2149e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori public synchronized void setMaxSqlCacheSize(int cacheSize) { 2150e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori if (cacheSize > MAX_SQL_CACHE_SIZE || cacheSize < 0) { 2151e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori throw new IllegalStateException("expected value between 0 and " + MAX_SQL_CACHE_SIZE); 2152e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori } else if (cacheSize < mMaxSqlCacheSize) { 2153e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori throw new IllegalStateException("cannot set cacheSize to a value less than the value " + 2154e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori "set with previous setMaxSqlCacheSize() call."); 21559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2156e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori mMaxSqlCacheSize = cacheSize; 21579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 21589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 21596c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /* package */ boolean isSqlInStatementCache(String sql) { 21606c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori synchronized (mCompiledQueries) { 21616c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori return mCompiledQueries.containsKey(sql); 21626c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 21636c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 21646c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 21656f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /* package */ void finalizeStatementLater(int id) { 21666f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori if (!isOpen()) { 21676f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori // database already closed. this statement will already have been finalized. 21686f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori return; 21696f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21706f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori synchronized(mClosedStatementIds) { 21716f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori if (mClosedStatementIds.contains(id)) { 21726f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori // this statement id is already queued up for finalization. 21736f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori return; 21746f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21756f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori mClosedStatementIds.add(id); 21766f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21776f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21786f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori 2179ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ void closePendingStatements() { 21806f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori if (!isOpen()) { 21816f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori // since this database is already closed, no need to finalize anything. 21826f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori mClosedStatementIds.clear(); 21836f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori return; 21846f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21856f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori verifyLockOwner(); 21866f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /* to minimize synchronization on mClosedStatementIds, make a copy of the list */ 21876f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori ArrayList<Integer> list = new ArrayList<Integer>(mClosedStatementIds.size()); 21886f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori synchronized(mClosedStatementIds) { 21896f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori list.addAll(mClosedStatementIds); 21906f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori mClosedStatementIds.clear(); 21916f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21926f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori // finalize all the statements from the copied list 21936f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori int size = list.size(); 21946f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori for (int i = 0; i < size; i++) { 21956f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori native_finalize(list.get(i)); 21966f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21976f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 21986f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori 21996f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /** 22006f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori * for testing only 22016f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori */ 2202ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori /* package */ ArrayList<Integer> getQueuedUpStmtList() { 22036f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori return mClosedStatementIds; 22046f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori } 22056f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori 22066c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** 22076c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * This method enables parallel execution of queries from multiple threads on the same database. 22086c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * It does this by opening multiple handles to the database and using a different 22096c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * database handle for each query. 22106c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22116c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * If a transaction is in progress on one connection handle and say, a table is updated in the 22126c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * transaction, then query on the same table on another connection handle will block for the 22136c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * transaction to complete. But this method enables such queries to execute by having them 22146c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * return old version of the data from the table. Most often it is the data that existed in the 22156c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * table prior to the above transaction updates on that table. 22166c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22176c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Maximum number of simultaneous handles used to execute queries in parallel is 22186c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * dependent upon the device memory and possibly other properties. 22196c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22206c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * After calling this method, execution of queries in parallel is enabled as long as this 22216c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * database handle is open. To disable execution of queries in parallel, database should 22226c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * be closed and reopened. 22236c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22246c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * If a query is part of a transaction, then it is executed on the same database handle the 22256c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * transaction was begun. 22266c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22276c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * If the database has any attached databases, then execution of queries in paralel is NOT 2228a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori * possible. In such cases, a message is printed to logcat and false is returned. 2229a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori * <p> 2230a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori * This feature is not available for :memory: databases. In such cases, 2231a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori * a message is printed to logcat and false is returned. 22326c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22336c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * A typical way to use this method is the following: 22346c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <pre> 22356c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * SQLiteDatabase db = SQLiteDatabase.openDatabase("db_filename", cursorFactory, 22366c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * CREATE_IF_NECESSARY, myDatabaseErrorHandler); 22376c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * db.enableWriteAheadLogging(); 22386c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * </pre> 22396c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 22406c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Writers should use {@link #beginTransactionNonExclusive()} or 22416c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * {@link #beginTransactionWithListenerNonExclusive(SQLiteTransactionListener)} 22426c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * to start a trsnsaction. 22436c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Non-exclusive mode allows database file to be in readable by threads executing queries. 22446c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * </p> 22456c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * 2246a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori * @return true if write-ahead-logging is set. false otherwise 22476c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 2248a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori public synchronized boolean enableWriteAheadLogging() { 2249a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori if (mPath.equalsIgnoreCase(MEMORY_DB_PATH)) { 2250a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori Log.i(TAG, "can't enable WAL for memory databases."); 2251a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori return false; 22526c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 22536c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 22546c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // make sure this database has NO attached databases because sqlite's write-ahead-logging 22556c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // doesn't work for databases with attached databases 22566c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (getAttachedDbs().size() > 1) { 2257ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 2258ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.d(TAG, 2259ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori "this database: " + mPath + " has attached databases. can't enable WAL."); 2260ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori } 2261a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori return false; 22626c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 2263a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori if (mConnectionPool == null) { 2264a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori mConnectionPool = new DatabaseConnectionPool(this); 2265a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori setJournalMode(mPath, "WAL"); 22666c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 2267a98cb2632dcf07ebd8d036f61c1438f795e262ccVasu Nori return true; 22686c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 22696c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 22702827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori /** 22717b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori * This method disables the features enabled by {@link #enableWriteAheadLogging()}. 22727b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori * @hide 22732827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori */ 22747b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori public void disableWriteAheadLogging() { 22757b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori synchronized (this) { 22767b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori if (mConnectionPool == null) { 22777b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori return; 22787b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori } 22797b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori mConnectionPool.close(); 22807b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori mConnectionPool = null; 22817b04c4176d9cb2f96487ad891f4cf769bccb4f1bVasu Nori setJournalMode(mPath, "TRUNCATE"); 22828d1110383d4437eeebae337026cd91449e4e55a5Vasu Nori } 22838d1110383d4437eeebae337026cd91449e4e55a5Vasu Nori } 22848d1110383d4437eeebae337026cd91449e4e55a5Vasu Nori 228565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori /* package */ SQLiteDatabase getDatabaseHandle(String sql) { 228665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori if (isPooledConnection()) { 228765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // this is a pooled database connection 2288ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori // use it if it is open AND if I am not currently part of a transaction 2289ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (isOpen() && !amIInTransaction()) { 229065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // TODO: use another connection from the pool 229165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // if this connection is currently in use by some other thread 229265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // AND if there are free connections in the pool 229365a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return this; 229465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } else { 229565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // the pooled connection is not open! could have been closed either due 229665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // to corruption on this or some other connection to the database 229765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // OR, maybe the connection pool is disabled after this connection has been 229865a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // allocated to me. try to get some other pooled or main database connection 229965a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return getParentDbConnObj().getDbConnection(sql); 230065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 230165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } else { 230265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // this is NOT a pooled connection. can we get one? 230365a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return getDbConnection(sql); 230465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 230565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 230665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori 23076c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /** 23086c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Sets the database connection handle pool size to the given value. 23096c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * Database connection handle pool is enabled when the app calls 23106c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * {@link #enableWriteAheadLogging()}. 23116c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * <p> 23126c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * The default connection handle pool is set by the system by taking into account various 23136c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * aspects of the device, such as memory, number of cores etc. It is recommended that 23146c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * applications use the default pool size set by the system. 23156c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * 23166c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * @param size the value the connection handle pool size should be set to. 23176c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori */ 23186c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori public synchronized void setConnectionPoolSize(int size) { 23196c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (mConnectionPool == null) { 23206c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori throw new IllegalStateException("connection pool not enabled"); 23216c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23226c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori int i = mConnectionPool.getMaxPoolSize(); 23236c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (size < i) { 2324daa4e4faffd025c11b2a8618409b8496a6829664Vasu Nori throw new IllegalArgumentException( 23256c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori "cannot set max pool size to a value less than the current max value(=" + 23266c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori i + ")"); 23276c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23286c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori mConnectionPool.setMaxPoolSize(size); 23296c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23306c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 23316c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori /* package */ SQLiteDatabase createPoolConnection(short connectionNum) { 233265a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori SQLiteDatabase db = openDatabase(mPath, mFactory, mFlags, mErrorHandler, connectionNum); 233365a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori db.mParentConnObj = this; 233465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return db; 233565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 233665a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori 233765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori private synchronized SQLiteDatabase getParentDbConnObj() { 233865a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return mParentConnObj; 23396c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23406c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 23416c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private boolean isPooledConnection() { 23426c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori return this.mConnectionNum > 0; 23436c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23446c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 23452827d6d974beabb12344040a002dcb52dd7106b5Vasu Nori /* package */ SQLiteDatabase getDbConnection(String sql) { 23466c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori verifyDbIsOpen(); 234765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // this method should always be called with main database connection handle 234865a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // NEVER with pooled database connection handle 234965a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori if (isPooledConnection()) { 235065a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori throw new IllegalStateException("incorrect database connection handle"); 235165a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori } 23526c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 23536c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // use the current connection handle if 2354ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori // 1. if the caller is part of the ongoing transaction, if any 235565a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori // 2. OR, if there is NO connection handle pool setup 2356ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori if (amIInTransaction() || mConnectionPool == null) { 235765a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return this; 23586c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } else { 23596c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // get a connection handle from the pool 23606c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 23616c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori assert mConnectionPool != null; 2362ce38b98feb1e7c9c1799eb270c40798d833aa9aeVasu Nori Log.i(TAG, mConnectionPool.toString()); 23636c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 236465a8883f0e605bb8a73a692987b47ce5da632e72Vasu Nori return mConnectionPool.get(sql); 23656c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23666c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23676c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 23686c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private void releaseDbConnection(SQLiteDatabase db) { 23696c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // ignore this release call if 23706c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // 1. the database is closed 23716c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // 2. OR, if db is NOT a pooled connection handle 23726c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // 3. OR, if the database being released is same as 'this' (this condition means 23736c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // that we should always be releasing a pooled connection handle by calling this method 23746c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori // from the 'main' connection handle 23756c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (!isOpen() || !db.isPooledConnection() || (db == this)) { 23766c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori return; 23776c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23786c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori if (Log.isLoggable(TAG, Log.DEBUG)) { 23796c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori assert isPooledConnection(); 23806c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori assert mConnectionPool != null; 23816c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori Log.d(TAG, "releaseDbConnection threadid = " + Thread.currentThread().getId() + 23826c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori ", releasing # " + db.mConnectionNum + ", " + getPath()); 23836c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23846c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori mConnectionPool.release(db); 23856c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 23866c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori 2387f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori /** 2388f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori * this method is used to collect data about ALL open databases in the current process. 23890732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori * bugreport is a user of this data. 2390f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori */ 2391c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori /* package */ static ArrayList<DbStats> getDbStats() { 2392c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori ArrayList<DbStats> dbStatsList = new ArrayList<DbStats>(); 23930732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // make a local copy of mActiveDatabases - so that this method is not competing 23940732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // for synchronization lock on mActiveDatabases 23950732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori ArrayList<WeakReference<SQLiteDatabase>> tempList = 23960732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori new ArrayList<WeakReference<SQLiteDatabase>>(); 23970732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori synchronized(mActiveDatabases) { 23980732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori Collections.copy(tempList, mActiveDatabases); 23990732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 24000732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (WeakReference<SQLiteDatabase> w : tempList) { 2401c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori SQLiteDatabase db = w.get(); 2402c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori if (db == null || !db.isOpen()) { 2403c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori continue; 2404c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2405c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori 24060732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori synchronized (db) { 24070732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori try { 24080732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // get SQLITE_DBSTATUS_LOOKASIDE_USED for the db 24090732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int lookasideUsed = db.native_getDbLookaside(); 24100732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori 24110732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // get the lastnode of the dbname 24120732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori String path = db.getPath(); 24130732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int indx = path.lastIndexOf("/"); 24140732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori String lastnode = path.substring((indx != -1) ? ++indx : 0); 24150732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori 24160732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // get list of attached dbs and for each db, get its size and pagesize 24170732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori ArrayList<Pair<String, String>> attachedDbs = db.getAttachedDbs(); 24180732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (attachedDbs == null) { 24190732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori continue; 2420ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori } 24210732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (int i = 0; i < attachedDbs.size(); i++) { 24220732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori Pair<String, String> p = attachedDbs.get(i); 24230732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori long pageCount = DatabaseUtils.longForQuery(db, "PRAGMA " + p.first 24240732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori + ".page_count;", null); 24250732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori 24260732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // first entry in the attached db list is always the main database 24270732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // don't worry about prefixing the dbname with "main" 24280732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori String dbName; 24290732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (i == 0) { 24300732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori dbName = lastnode; 24310732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } else { 24320732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // lookaside is only relevant for the main db 24330732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori lookasideUsed = 0; 24340732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori dbName = " (attached) " + p.first; 24350732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // if the attached db has a path, attach the lastnode from the path to above 24360732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (p.second.trim().length() > 0) { 24370732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori int idx = p.second.lastIndexOf("/"); 24380732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori dbName += " : " + p.second.substring((idx != -1) ? ++idx : 0); 24390732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 24400732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 24410732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (pageCount > 0) { 24420732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori dbStatsList.add(new DbStats(dbName, pageCount, db.getPageSize(), 24430732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori lookasideUsed, db.mNumCacheHits, db.mNumCacheMisses, 24440732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori db.mCompiledQueries.size())); 24450732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 2446ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori } 24470732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // if there are pooled connections, return the cache stats for them also. 24480732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori if (db.mConnectionPool != null) { 24490732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori for (SQLiteDatabase pDb : db.mConnectionPool.getConnectionList()) { 24500732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori dbStatsList.add(new DbStats("(pooled # " + pDb.mConnectionNum + ") " 24510732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori + lastnode, 0, 0, 0, pDb.mNumCacheHits, pDb.mNumCacheMisses, 24520732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori pDb.mCompiledQueries.size())); 24530732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } 24546c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 24550732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori } catch (SQLiteException e) { 24560732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // ignore. we don't care about exceptions when we are taking adb 24570732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori // bugreport! 24586c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori } 2459c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2460c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2461c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori return dbStatsList; 2462c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2463c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori 2464c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori /** 2465ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Returns list of full pathnames of all attached databases including the main database 2466ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * by executing 'pragma database_list' on the database. 2467ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * 2468062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * @return ArrayList of pairs of (database name, database file path) or null if the database 2469062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * is not open. 2470c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori */ 2471062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori public ArrayList<Pair<String, String>> getAttachedDbs() { 2472062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori if (!isOpen()) { 2473f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori return null; 2474f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori } 2475c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori ArrayList<Pair<String, String>> attachedDbs = new ArrayList<Pair<String, String>>(); 2476062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori Cursor c = null; 2477062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori try { 2478062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori c = rawQuery("pragma database_list;", null); 2479062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori while (c.moveToNext()) { 2480062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // sqlite returns a row for each database in the returned list of databases. 2481062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // in each row, 2482062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // 1st column is the database name such as main, or the database 2483062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // name specified on the "ATTACH" command 2484062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // 2nd column is the database file path. 2485062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori attachedDbs.add(new Pair<String, String>(c.getString(1), c.getString(2))); 2486062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2487062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } finally { 2488062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori if (c != null) { 2489062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori c.close(); 2490062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2491c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2492c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori return attachedDbs; 2493c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori } 2494c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori 24959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2496ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Runs 'pragma integrity_check' on the given database (and all the attached databases) 2497ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * and returns true if the given database (and all its attached databases) pass integrity_check, 2498062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * false otherwise. 2499ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori *<p> 2500ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * If the result is false, then this method logs the errors reported by the integrity_check 2501062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * command execution. 2502ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori *<p> 2503ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Note that 'pragma integrity_check' on a database can take a long time. 2504062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * 2505062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori * @return true if the given database (and all its attached databases) pass integrity_check, 2506ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * false otherwise. 2507062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori */ 2508062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori public boolean isDatabaseIntegrityOk() { 2509ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori verifyDbIsOpen(); 2510062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori ArrayList<Pair<String, String>> attachedDbs = getAttachedDbs(); 2511062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori if (attachedDbs == null) { 2512062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori throw new IllegalStateException("databaselist for: " + getPath() + " couldn't " + 2513062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori "be retrieved. probably because the database is closed"); 2514062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2515062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori boolean isDatabaseCorrupt = false; 2516062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori for (int i = 0; i < attachedDbs.size(); i++) { 2517062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori Pair<String, String> p = attachedDbs.get(i); 2518062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori SQLiteStatement prog = null; 2519062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori try { 2520062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori prog = compileStatement("PRAGMA " + p.first + ".integrity_check(1);"); 2521062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori String rslt = prog.simpleQueryForString(); 2522062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori if (!rslt.equalsIgnoreCase("ok")) { 2523062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori // integrity_checker failed on main or attached databases 2524062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori isDatabaseCorrupt = true; 2525062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori Log.e(TAG, "PRAGMA integrity_check on " + p.second + " returned: " + rslt); 2526062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2527062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } finally { 2528062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori if (prog != null) prog.close(); 2529062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2530062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2531062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori return isDatabaseCorrupt; 2532062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori } 2533062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori 2534062fc7ce369758d5a26f83f12b50b11cd88e5defVasu Nori /** 25359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Native call to open the database. 25369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 25379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param path The full path to the database 25389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 25399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private native void dbopen(String path, int flags); 25409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 25419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2542ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Native call to setup tracing of all SQL statements 25433ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * 25443ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * @param path the full path to the database 25456c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * @param connectionNum connection number: 0 - N, where the main database 25466c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * connection handle is numbered 0 and the connection handles in the connection 25476c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * pool are numbered 1..N. 25483ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori */ 25496c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private native void enableSqlTracing(String path, short connectionNum); 25503ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori 25513ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori /** 2552ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * Native call to setup profiling of all SQL statements. 25533ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * currently, sqlite's profiling = printing of execution-time 2554ccd954480c32e9f35357b66023ae912e7f3fa76bVasu Nori * (wall-clock time) of each of the SQL statements, as they 25553ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * are executed. 25563ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * 25573ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori * @param path the full path to the database 25586c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * @param connectionNum connection number: 0 - N, where the main database 25596c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * connection handle is numbered 0 and the connection handles in the connection 25606c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori * pool are numbered 1..N. 25613ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori */ 25626c354da9436e946708fc3f3a1c0d18b18bbfdf43Vasu Nori private native void enableSqlProfiling(String path, short connectionNum); 25633ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori 25643ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori /** 25659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Native call to set the locale. {@link #lock} must be held when calling 25669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this method. 25679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws SQLException 25689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 25690732f7912ccec9a1cc379b535ac0b56ae50972b3Vasu Nori private native void native_setLocale(String loc, int flags); 25709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 25719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2572c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori * return the SQLITE_DBSTATUS_LOOKASIDE_USED documented here 2573c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori * http://www.sqlite.org/c3ref/c_dbstatus_lookaside_used.html 2574c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori * @return int value of SQLITE_DBSTATUS_LOOKASIDE_USED 2575c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori */ 2576c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori private native int native_getDbLookaside(); 25776f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori 25786f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori /** 25796f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori * finalizes the given statement id. 25806f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori * 25816f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori * @param statementId statement to be finzlied by sqlite 25826f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori */ 25836f37f83a4802a0d411395f3abc5f24a2cfec025dVasu Nori private final native void native_finalize(int statementId); 25849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 2585