SQLiteDatabase.java revision cfda9f3a4756c71b3aadd1387419cb3b513dd400
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
195a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Noriimport com.google.android.collect.Maps;
205a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
2112311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnorimport android.app.ActivityThread;
229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.ContentValues;
239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.Cursor;
249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.DatabaseUtils;
259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.database.SQLException;
26c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport android.database.sqlite.SQLiteDebug.DbStats;
279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Debug;
289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.SystemClock;
2990142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikovimport android.os.SystemProperties;
309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.text.TextUtils;
319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Config;
329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.EventLog;
3390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikovimport android.util.Log;
34c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport android.util.Pair;
359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
36cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrickimport dalvik.system.BlockGuard;
37cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick
389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.File;
39c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport java.lang.ref.WeakReference;
405a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Noriimport java.text.SimpleDateFormat;
41c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport java.util.ArrayList;
429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.HashMap;
43c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Noriimport java.util.HashSet;
449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Iterator;
459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Locale;
469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Map;
4712311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnorimport java.util.Random;
489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Set;
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 {
699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final String TAG = "Database";
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
1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** Synchronize on this when accessing the database */
1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private final ReentrantLock mLock = new ReentrantLock(true);
1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private long mLockAcquiredWallTime = 0L;
1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private long mLockAcquiredThreadTime = 0L;
199600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    // limit the frequency of complaints about each database to one within 20 sec
201600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov    // unless run command adb shell setprop log.tag.Database VERBOSE
2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final int LOCK_WARNING_WINDOW_IN_MS = 20000;
2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** If the lock is held this long then a warning will be printed when it is released. */
2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final int LOCK_ACQUIRED_WARNING_TIME_IN_MS = 300;
2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final int LOCK_ACQUIRED_WARNING_THREAD_TIME_IN_MS = 100;
2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final int LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT = 2000;
2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
208b43b58d3494426eda6117101635de25bb43efc20Dmitri Plotnikov    private static final int SLEEP_AFTER_YIELD_QUANTUM = 1000;
209600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
210d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    // The pattern we remove from database filenames before
211d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    // potentially logging them.
212d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    private static final Pattern EMAIL_IN_DB_PATTERN = Pattern.compile("[\\w\\.\\-]+@[\\w\\.\\-]+");
213d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick
2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private long mLastLockMessageTime = 0L;
215600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
216b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick    // Things related to query logging/sampling for debugging
217b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick    // slow/frequent queries during development.  Always log queries
218722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // which take (by default) 500ms+; shorter queries are sampled
219722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // accordingly.  Commit statements, which are typically slow, are
220722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // logged together with the most recently executed SQL statement,
221722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // for disambiguation.  The 500ms value is configurable via a
222722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // SystemProperty, but developers actively debugging database I/O
223722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // should probably use the regular log tunable,
224722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // LOG_SLOW_QUERIES_PROPERTY, defined below.
225722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    private static int sQueryLogTimeInMillis = 0;  // lazily initialized
22612311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor    private static final int QUERY_LOG_SQL_LENGTH = 64;
227b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick    private static final String COMMIT_SQL = "COMMIT;";
22812311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor    private final Random mRandom = new Random();
229b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick    private String mLastSqlStatement = null;
23012311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor
231722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // String prefix for slow database query EventLog records that show
232722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    // lock acquistions of the database.
233722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    /* package */ static final String GET_LOCK_LOG_PREFIX = "GETLOCK:";
234722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick
2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** Used by native code, do not rename */
2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ int mNativeHandle = 0;
2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** Used to make temp table names unique */
2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ int mTempTableSequence = 0;
2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** The path for the database file */
2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private String mPath;
2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
244d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    /** The anonymized path for the database file for logging purposes */
245d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    private String mPathForLogs = null;  // lazily populated
246d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick
2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** The flags passed to open/create */
2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private int mFlags;
2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** The optional factory to use when creating new Cursors */
2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private CursorFactory mFactory;
252600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private WeakHashMap<SQLiteClosable, Object> mPrograms;
254600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
2555a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /**
2565a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * for each instance of this class, a cache is maintained to store
2575a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * the compiled query statement ids returned by sqlite database.
2585a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     *     key = sql statement with "?" for bind args
2595a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     *     value = {@link SQLiteCompiledSql}
2605a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * If an application opens the database and keeps it open during its entire life, then
2615a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * there will not be an overhead of compilation of sql statements by sqlite.
2625a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     *
2635a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * why is this cache NOT static? because sqlite attaches compiledsql statements to the
2645a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * struct created when {@link SQLiteDatabase#openDatabase(String, CursorFactory, int)} is
2655a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * invoked.
2665a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     *
2675a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * this cache has an upper limit of mMaxSqlCacheSize (settable by calling the method
2685a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * (@link setMaxCacheSize(int)}). its default is 0 - i.e., no caching by default because
2695a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * most of the apps don't use "?" syntax in their sql, caching is not useful for them.
2705a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     */
271e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /* package */ Map<String, SQLiteCompiledSql> mCompiledQueries = Maps.newHashMap();
272e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /**
273e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
274e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
275e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public static final int MAX_SQL_CACHE_SIZE = 250;
276e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    private int mMaxSqlCacheSize = MAX_SQL_CACHE_SIZE; // max cache size per Database instance
277e9d9210205b280b4ea0402f78d7dd717068af650Vasu Nori    private int mCacheFullWarnings;
27849d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori    private static final int MAX_WARNINGS_ON_CACHESIZE_CONDITION = 1;
2795a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
2805a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /** maintain stats about number of cache hits and misses */
2815a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    private int mNumCacheHits;
2825a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    private int mNumCacheMisses;
2835a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
2845a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /** the following 2 members maintain the time when a database is opened and closed */
2855a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    private String mTimeOpened = null;
2865a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    private String mTimeClosed = null;
2875a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
288d606b4bf2c1a2308b40785860853cfb95a77bf58Vasu Nori    /** Used to find out where this object was created in case it never got closed. */
289d606b4bf2c1a2308b40785860853cfb95a77bf58Vasu Nori    private Throwable mStackTrace = null;
2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
29190142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov    // System property that enables logging of slow queries. Specify the threshold in ms.
29290142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov    private static final String LOG_SLOW_QUERIES_PROPERTY = "db.log.slow_query_threshold";
29390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov    private final int mSlowQueryThreshold;
29490142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov
2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param closable
2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    void addSQLiteClosable(SQLiteClosable closable) {
2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mPrograms.put(closable, null);
3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
306600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    void removeSQLiteClosable(SQLiteClosable closable) {
3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mPrograms.remove(closable);
3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
314600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov    }
315600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    @Override
3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    protected void onAllReferencesReleased() {
3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (isOpen()) {
3195a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (SQLiteDebug.DEBUG_SQL_CACHE) {
3205a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                mTimeClosed = getTime();
3215a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            dbclose();
3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Attempts to release memory that SQLite holds but does not require to
3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * operate properly. Typically this memory will come from the page cache.
329600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     *
3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the number of bytes actually released
3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
332600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov    static public native int releaseMemory();
3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Control whether or not the SQLiteDatabase is made thread-safe by using locks
3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * around critical sections. This is pretty expensive, so if you know that your
3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * DB will only be used by a single thread then you should set this to false.
3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The default is true.
3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param lockingEnabled set to true to enable locks, false otherwise
3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setLockingEnabled(boolean lockingEnabled) {
3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mLockingEnabled = lockingEnabled;
3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * If set then the SQLiteDatabase is made thread-safe by using locks
3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * around critical sections
3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private boolean mLockingEnabled = true;
3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ void onCorruption() {
352f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        Log.e(TAG, "Removing corrupt database: " + mPath);
353f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        EventLog.writeEvent(EVENT_DB_CORRUPT, mPath);
3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Close the database (if we can), which will cause subsequent operations to fail.
3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            close();
3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Delete the corrupt file.  Don't re-create it now -- that would just confuse people
3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // -- but the next time someone tries to open it, they can set it up from scratch.
360f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            if (!mPath.equalsIgnoreCase(":memory")) {
361f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                // delete is only for non-memory database files
362f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                new File(mPath).delete();
363f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            }
3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Locks the database for exclusive access. The database lock must be held when
3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * touch the native sqlite3* object since it is single threaded and uses
3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * a polling lock contention algorithm. The lock is recursive, and may be acquired
3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * multiple times by the same thread. This is a no-op if mLockingEnabled is false.
372600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     *
3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see #unlock()
3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ void lock() {
3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!mLockingEnabled) return;
3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mLock.lock();
3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) {
3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() == 1) {
3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                // Use elapsed real-time since the CPU may sleep when waiting for IO
3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mLockAcquiredWallTime = SystemClock.elapsedRealtime();
3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mLockAcquiredThreadTime = Debug.threadCpuTimeNanos();
3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Locks the database for exclusive access. The database lock must be held when
3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * touch the native sqlite3* object since it is single threaded and uses
3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * a polling lock contention algorithm. The lock is recursive, and may be acquired
3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * multiple times by the same thread.
3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see #unlockForced()
3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private void lockForced() {
3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mLock.lock();
3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) {
3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() == 1) {
3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                // Use elapsed real-time since the CPU may sleep when waiting for IO
4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mLockAcquiredWallTime = SystemClock.elapsedRealtime();
4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mLockAcquiredThreadTime = Debug.threadCpuTimeNanos();
4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Releases the database lock. This is a no-op if mLockingEnabled is false.
408600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     *
4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see #unlock()
4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ void unlock() {
4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!mLockingEnabled) return;
4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) {
4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() == 1) {
4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                checkLockHoldTime();
4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mLock.unlock();
4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Releases the database lock.
4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see #unlockForced()
4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private void unlockForced() {
4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING) {
4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() == 1) {
4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                checkLockHoldTime();
4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mLock.unlock();
4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private void checkLockHoldTime() {
4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // Use elapsed real-time since the CPU may sleep when waiting for IO
4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        long elapsedTime = SystemClock.elapsedRealtime();
438600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov        long lockedTime = elapsedTime - mLockAcquiredWallTime;
4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (lockedTime < LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT &&
4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                !Log.isLoggable(TAG, Log.VERBOSE) &&
4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                (elapsedTime - mLastLockMessageTime) < LOCK_WARNING_WINDOW_IN_MS) {
4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return;
4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (lockedTime > LOCK_ACQUIRED_WARNING_TIME_IN_MS) {
4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int threadTime = (int)
4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    ((Debug.threadCpuTimeNanos() - mLockAcquiredThreadTime) / 1000000);
4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (threadTime > LOCK_ACQUIRED_WARNING_THREAD_TIME_IN_MS ||
4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    lockedTime > LOCK_ACQUIRED_WARNING_TIME_IN_MS_ALWAYS_PRINT) {
4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mLastLockMessageTime = elapsedTime;
4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                String msg = "lock held on " + mPath + " for " + lockedTime + "ms. Thread time was "
4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        + threadTime + "ms";
4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                if (SQLiteDebug.DEBUG_LOCK_TIME_TRACKING_STACK_TRACE) {
4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Log.d(TAG, msg, new Exception());
4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                } else {
4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Log.d(TAG, msg);
4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Begins a transaction. Transactions can be nested. When the outer transaction is ended all of
4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * the work done in that transaction and all of the nested transactions will be committed or
4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * rolled back. The changes will be rolled back if any transaction is ended without being
4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.
4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p>Here is the standard idiom for transactions:
4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <pre>
4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   db.beginTransaction();
4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   try {
4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     ...
4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     db.setTransactionSuccessful();
4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   } finally {
4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     db.endTransaction();
4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   }
4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * </pre>
4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void beginTransaction() {
480c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana        beginTransactionWithListener(null /* transactionStatusCallback */);
481c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana    }
482c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana
483c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana    /**
484c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * Begins a transaction. Transactions can be nested. When the outer transaction is ended all of
485c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * the work done in that transaction and all of the nested transactions will be committed or
486c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * rolled back. The changes will be rolled back if any transaction is ended without being
487c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.
488c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *
489c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * <p>Here is the standard idiom for transactions:
490c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *
491c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * <pre>
492c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *   db.beginTransactionWithListener(listener);
493c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *   try {
494c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *     ...
495c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *     db.setTransactionSuccessful();
496c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *   } finally {
497c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *     db.endTransaction();
498c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     *   }
499c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * </pre>
500c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * @param transactionListener listener that should be notified when the transaction begins,
501c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * commits, or is rolled back, either explicitly or by a call to
502c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     * {@link #yieldIfContendedSafely}.
503c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana     */
504c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana    public void beginTransactionWithListener(SQLiteTransactionListener transactionListener) {
505c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lockForced();
506f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
507f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
508f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        boolean ok = false;
5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // If this thread already had the lock then get out
5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() > 1) {
5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                if (mInnerTransactionIsSuccessful) {
5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    String msg = "Cannot call beginTransaction between "
5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                            + "calling setTransactionSuccessful and endTransaction";
5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    IllegalStateException e = new IllegalStateException(msg);
5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Log.e(TAG, "beginTransaction() failed", e);
5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    throw e;
5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                ok = true;
5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                return;
5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // This thread didn't already have the lock, so begin a database
5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // transaction now.
5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            execSQL("BEGIN EXCLUSIVE;");
527c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            mTransactionListener = transactionListener;
5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mTransactionIsSuccessful = true;
5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mInnerTransactionIsSuccessful = false;
530c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            if (transactionListener != null) {
531c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                try {
532c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    transactionListener.onBegin();
533c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                } catch (RuntimeException e) {
534c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    execSQL("ROLLBACK;");
535c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    throw e;
536c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                }
537c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            }
5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            ok = true;
5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (!ok) {
5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                // beginTransaction is called before the try block so we must release the lock in
5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                // the case of failure.
5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                unlockForced();
5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * End a transaction. See beginTransaction for notes about how to use this and when transactions
5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * are committed and rolled back.
5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void endTransaction() {
553f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
554f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
555f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!mLock.isHeldByCurrentThread()) {
5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException("no transaction pending");
5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mInnerTransactionIsSuccessful) {
5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mInnerTransactionIsSuccessful = false;
5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            } else {
5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mTransactionIsSuccessful = false;
5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mLock.getHoldCount() != 1) {
5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                return;
5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
568c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            RuntimeException savedException = null;
569c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            if (mTransactionListener != null) {
570c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                try {
571c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    if (mTransactionIsSuccessful) {
572c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                        mTransactionListener.onCommit();
573c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    } else {
574c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                        mTransactionListener.onRollback();
575c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    }
576c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                } catch (RuntimeException e) {
577c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    savedException = e;
578c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    mTransactionIsSuccessful = false;
579c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                }
580c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            }
5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (mTransactionIsSuccessful) {
582b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick                execSQL(COMMIT_SQL);
5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            } else {
5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                try {
5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    execSQL("ROLLBACK;");
586c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    if (savedException != null) {
587c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                        throw savedException;
588c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana                    }
5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                } catch (SQLException e) {
5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    if (Config.LOGD) {
5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        Log.d(TAG, "exception during rollback, maybe the DB previously "
5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                                + "performed an auto-rollback");
5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    }
5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
5969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
597c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana            mTransactionListener = null;
5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlockForced();
5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (Config.LOGV) {
6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Log.v(TAG, "unlocked " + Thread.currentThread()
6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        + ", holdCount is " + mLock.getHoldCount());
6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Marks the current transaction as successful. Do not do any more database work between
6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * calling this and calling endTransaction. Do as little non-database work as possible in that
6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * situation too. If any errors are encountered between this and endTransaction the transaction
6109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * will still be committed.
6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalStateException if the current thread is not in a transaction or the
6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * transaction is already marked as successful.
6149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setTransactionSuccessful() {
616f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
617f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
618f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
6199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!mLock.isHeldByCurrentThread()) {
6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException("no transaction pending");
6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (mInnerTransactionIsSuccessful) {
6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException(
6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    "setTransactionSuccessful may only be called once per call to beginTransaction");
6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mInnerTransactionIsSuccessful = true;
6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * return true if there is a transaction pending
6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean inTransaction() {
6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return mLock.getHoldCount() > 0;
6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Checks if the database lock is held by this thread.
6389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
6399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true, if this thread is holding the database lock.
6409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean isDbLockedByCurrentThread() {
6429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return mLock.isHeldByCurrentThread();
6439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Checks if the database is locked by another thread. This is
6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * just an estimate, since this status can change at any time,
6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * including after the call is made but before the result has
6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * been acted upon.
6509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
6519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true, if the database is locked by another thread
6529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean isDbLockedByOtherThreads() {
6549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return !mLock.isHeldByCurrentThread() && mLock.isLocked();
6559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Temporarily end the transaction to let other threads run. The transaction is assumed to be
6599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * successful so far. Do not call setTransactionSuccessful before calling this. When this
6609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * returns a new transaction will have been created but not marked as successful.
6619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the transaction was yielded
6629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @deprecated if the db is locked more than once (becuase of nested transactions) then the lock
6639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   will not be yielded. Use yieldIfContendedSafely instead.
6649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6654a51c20ce607c74914f90fd897f04080121ac13bDianne Hackborn    @Deprecated
6669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean yieldIfContended() {
6675c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana        return yieldIfContendedHelper(false /* do not check yielding */,
6685c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana                -1 /* sleepAfterYieldDelay */);
6699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
6729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Temporarily end the transaction to let other threads run. The transaction is assumed to be
6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * successful so far. Do not call setTransactionSuccessful before calling this. When this
6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * returns a new transaction will have been created but not marked as successful. This assumes
6759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * that there are no nested transactions (beginTransaction has only been called once) and will
6765c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * throw an exception if that is not the case.
6779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the transaction was yielded
6789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
6799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean yieldIfContendedSafely() {
6805c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana        return yieldIfContendedHelper(true /* check yielding */, -1 /* sleepAfterYieldDelay*/);
6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
6835c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana    /**
6845c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * Temporarily end the transaction to let other threads run. The transaction is assumed to be
6855c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * successful so far. Do not call setTransactionSuccessful before calling this. When this
6865c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * returns a new transaction will have been created but not marked as successful. This assumes
6875c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * that there are no nested transactions (beginTransaction has only been called once) and will
6885c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * throw an exception if that is not the case.
6895c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * @param sleepAfterYieldDelay if > 0, sleep this long before starting a new transaction if
6905c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     *   the lock was actually yielded. This will allow other background threads to make some
6915c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     *   more progress than they would if we started the transaction immediately.
6925c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     * @return true if the transaction was yielded
6935c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana     */
6945c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana    public boolean yieldIfContendedSafely(long sleepAfterYieldDelay) {
6955c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana        return yieldIfContendedHelper(true /* check yielding */, sleepAfterYieldDelay);
6965c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana    }
6975c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana
6985c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana    private boolean yieldIfContendedHelper(boolean checkFullyYielded, long sleepAfterYieldDelay) {
6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (mLock.getQueueLength() == 0) {
7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Reset the lock acquire time since we know that the thread was willing to yield
7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // the lock at this time.
7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mLockAcquiredWallTime = SystemClock.elapsedRealtime();
7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mLockAcquiredThreadTime = Debug.threadCpuTimeNanos();
7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return false;
7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        setTransactionSuccessful();
707c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana        SQLiteTransactionListener transactionListener = mTransactionListener;
7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        endTransaction();
7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (checkFullyYielded) {
7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (this.isDbLockedByCurrentThread()) {
7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                throw new IllegalStateException(
7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        "Db locked more than once. yielfIfContended cannot yield");
7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
7155c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana        if (sleepAfterYieldDelay > 0) {
716600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            // Sleep for up to sleepAfterYieldDelay milliseconds, waking up periodically to
717600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            // check if anyone is using the database.  If the database is not contended,
718600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            // retake the lock and return.
719600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            long remainingDelay = sleepAfterYieldDelay;
720600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            while (remainingDelay > 0) {
721600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                try {
722600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                    Thread.sleep(remainingDelay < SLEEP_AFTER_YIELD_QUANTUM ?
723600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                            remainingDelay : SLEEP_AFTER_YIELD_QUANTUM);
724600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                } catch (InterruptedException e) {
725600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                    Thread.interrupted();
726600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                }
727600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                remainingDelay -= SLEEP_AFTER_YIELD_QUANTUM;
728600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                if (mLock.getQueueLength() == 0) {
729600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                    break;
730600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov                }
7315c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana            }
7325c7aede8d69f4f0ad617d39decd4453b029ba6afFred Quintana        }
733c4516a7b62de525e3d6d5e76851bdfaf12c11f05Fred Quintana        beginTransactionWithListener(transactionListener);
7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return true;
7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /** Maps table names to info about what to which _sync_time column to set
7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * to NULL on an update. This is used to support syncing. */
7399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private final Map<String, SyncUpdateInfo> mSyncUpdateInfo =
7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            new HashMap<String, SyncUpdateInfo>();
7419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Map<String, String> getSyncedTables() {
7439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        synchronized(mSyncUpdateInfo) {
7449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            HashMap<String, String> tables = new HashMap<String, String>();
7459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            for (String table : mSyncUpdateInfo.keySet()) {
7469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                SyncUpdateInfo info = mSyncUpdateInfo.get(table);
7479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                if (info.deletedTable != null) {
7489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    tables.put(table, info.deletedTable);
7499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
7509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
7519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return tables;
7529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
7539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
7549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
7569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Internal class used to keep track what needs to be marked as changed
7579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when an update occurs. This is used for syncing, so the sync engine
7589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * knows what data has been updated locally.
7599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
7609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    static private class SyncUpdateInfo {
7619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
7629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * Creates the SyncUpdateInfo class.
7639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *
7649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * @param masterTable The table to set _sync_time to NULL in
7659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * @param deletedTable The deleted table that corresponds to the
7669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         *          master table
7679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * @param foreignKey The key that refers to the primary key in table
7689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
7699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SyncUpdateInfo(String masterTable, String deletedTable,
7709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                String foreignKey) {
7719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            this.masterTable = masterTable;
7729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            this.deletedTable = deletedTable;
7739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            this.foreignKey = foreignKey;
7749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
7759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /** The table containing the _sync_time column */
7779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        String masterTable;
7789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /** The deleted table that corresponds to the master table */
7809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        String deletedTable;
7819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /** The key in the local table the row in table. It may be _id, if table
7839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * is the local table. */
7849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        String foreignKey;
7859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
7869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
7889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Used to allow returning sub-classes of {@link Cursor} when calling query.
7899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
7909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public interface CursorFactory {
7919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        /**
7929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * See
7939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * {@link SQLiteCursor#SQLiteCursor(SQLiteDatabase, SQLiteCursorDriver,
7949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         * String, SQLiteQuery)}.
7959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project         */
7969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public Cursor newCursor(SQLiteDatabase db,
7979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                SQLiteCursorDriver masterQuery, String editTable,
7989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                SQLiteQuery query);
7999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
8029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Open the database according to the flags {@link #OPEN_READWRITE}
8039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * {@link #OPEN_READONLY} {@link #CREATE_IF_NECESSARY} and/or {@link #NO_LOCALIZED_COLLATORS}.
8049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
8059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p>Sets the locale of the database to the  the system's current locale.
8069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Call {@link #setLocale} if you would like something else.</p>
8079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
8089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param path to database file to open and/or create
8099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param factory an optional factory class that is called to instantiate a
8109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            cursor when query is called, or null for default
8119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param flags to control database access mode
8129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the newly opened database
8139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLiteException if the database cannot be opened
8149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
8159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static SQLiteDatabase openDatabase(String path, CursorFactory factory, int flags) {
816c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        SQLiteDatabase sqliteDatabase = null;
8179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
8189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Open the database.
819c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            sqliteDatabase = new SQLiteDatabase(path, factory, flags);
8203ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori            if (SQLiteDebug.DEBUG_SQL_STATEMENTS) {
8213ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori                sqliteDatabase.enableSqlTracing(path);
8223ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori            }
8233ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori            if (SQLiteDebug.DEBUG_SQL_TIME) {
8243ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori                sqliteDatabase.enableSqlProfiling(path);
8253ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori            }
8269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
8279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Try to recover from this, if we can.
8289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // TODO: should we do this for other open failures?
8299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "Deleting and re-creating corrupt database " + path, e);
830082c2af6859dff103e781b372dfde927cc0f869fJeff Hamilton            EventLog.writeEvent(EVENT_DB_CORRUPT, path);
831f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            if (!path.equalsIgnoreCase(":memory")) {
832f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                // delete is only for non-memory database files
833f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                new File(path).delete();
834f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            }
835c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            sqliteDatabase = new SQLiteDatabase(path, factory, flags);
8369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
837c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        ActiveDatabases.getInstance().mActiveDatabases.add(
838c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                new WeakReference<SQLiteDatabase>(sqliteDatabase));
839c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        return sqliteDatabase;
8409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
8439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Equivalent to openDatabase(file.getPath(), factory, CREATE_IF_NECESSARY).
8449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
8459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static SQLiteDatabase openOrCreateDatabase(File file, CursorFactory factory) {
8469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return openOrCreateDatabase(file.getPath(), factory);
8479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
8509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Equivalent to openDatabase(path, factory, CREATE_IF_NECESSARY).
8519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
8529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static SQLiteDatabase openOrCreateDatabase(String path, CursorFactory factory) {
8539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return openDatabase(path, factory, CREATE_IF_NECESSARY);
8549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
8579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Create a memory backed SQLite database.  Its contents will be destroyed
8589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when the database is closed.
8599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
8609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p>Sets the locale of the database to the  the system's current locale.
8619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Call {@link #setLocale} if you would like something else.</p>
8629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
8639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param factory an optional factory class that is called to instantiate a
8649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            cursor when query is called
8659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return a SQLiteDatabase object, or null if the database can't be created
8669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
8679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static SQLiteDatabase create(CursorFactory factory) {
8689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // This is a magic string with special meaning for SQLite.
8699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return openDatabase(":memory:", factory, CREATE_IF_NECESSARY);
8709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
8739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Close the database.
8749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
8759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void close() {
876f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
877f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            return; // already closed
878f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
8799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
8809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
8819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            closeClosable();
882f6373e9513002f55bbe00180a5eb9f1051d53547Vasu Nori            // close this database instance - regardless of its reference count value
883f6373e9513002f55bbe00180a5eb9f1051d53547Vasu Nori            onAllReferencesReleased();
8849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
8859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
8869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
8879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
8889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
8899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private void closeClosable() {
890e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        /* deallocate all compiled sql statement objects from mCompiledQueries cache.
891e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         * this should be done before de-referencing all {@link SQLiteClosable} objects
892e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         * from this database object because calling
893e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         * {@link SQLiteClosable#onAllReferencesReleasedFromContainer()} could cause the database
894e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         * to be closed. sqlite doesn't let a database close if there are
895e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         * any unfinalized statements - such as the compiled-sql objects in mCompiledQueries.
896e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori         */
897e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        deallocCachedSqlStatements();
898e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
8999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Iterator<Map.Entry<SQLiteClosable, Object>> iter = mPrograms.entrySet().iterator();
9009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        while (iter.hasNext()) {
9019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Map.Entry<SQLiteClosable, Object> entry = iter.next();
9029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            SQLiteClosable program = entry.getKey();
9039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (program != null) {
9049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                program.onAllReferencesReleasedFromContainer();
9059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
906600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov        }
9079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
908600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
9099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Native call to close the database.
9119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private native void dbclose();
9139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Gets the database version.
9169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the database version
9189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public int getVersion() {
920c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        SQLiteStatement prog = null;
921c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
922f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
923f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
924f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
9259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
9269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            prog = new SQLiteStatement(this, "PRAGMA user_version;");
9279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long version = prog.simpleQueryForLong();
9289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return (int) version;
9299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
9309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (prog != null) prog.close();
9319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
9329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sets the database version.
9379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param version the new database version
9399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setVersion(int version) {
9419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        execSQL("PRAGMA user_version = " + version);
9429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the maximum size the database may grow to.
9469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the new maximum database size
9489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long getMaximumSize() {
950c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        SQLiteStatement prog = null;
951c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
952f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
953f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
954f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
9559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
9569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            prog = new SQLiteStatement(this,
9579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    "PRAGMA max_page_count;");
9589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long pageCount = prog.simpleQueryForLong();
9599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return pageCount * getPageSize();
9609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
9619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (prog != null) prog.close();
9629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
9639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sets the maximum size the database will grow to. The maximum size cannot
9689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * be set below the current size.
9699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param numBytes the maximum database size, in bytes
9719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the new maximum database size
9729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long setMaximumSize(long numBytes) {
974c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        SQLiteStatement prog = null;
975c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
976f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
977f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
978f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
9799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
9809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long pageSize = getPageSize();
9819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long numPages = numBytes / pageSize;
9829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // If numBytes isn't a multiple of pageSize, bump up a page
9839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if ((numBytes % pageSize) != 0) {
9849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                numPages++;
9859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
9869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            prog = new SQLiteStatement(this,
9879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    "PRAGMA max_page_count = " + numPages);
9889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long newPageCount = prog.simpleQueryForLong();
9899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return newPageCount * pageSize;
9909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
9919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (prog != null) prog.close();
9929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
9939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the current database page size, in bytes.
9989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the database page size, in bytes
10009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long getPageSize() {
1002c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        SQLiteStatement prog = null;
1003c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
1004f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
1005f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
1006f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
10079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
10089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            prog = new SQLiteStatement(this,
10099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    "PRAGMA page_size;");
10109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long size = prog.simpleQueryForLong();
10119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return size;
10129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
10139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (prog != null) prog.close();
10149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
10159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sets the database page size. The page size must be a power of two. This
10209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * method does not work if any data has been written to the database file,
10219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * and must be called right after the database has been created.
10229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param numBytes the database page size, in bytes
10249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setPageSize(long numBytes) {
10269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        execSQL("PRAGMA page_size = " + numBytes);
10279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Mark this table as syncable. When an update occurs in this table the
10319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * _sync_dirty field will be set to ensure proper syncing operation.
10329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to mark as syncable
10349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param deletedTable The deleted table that corresponds to the
10359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *          syncable table
10369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void markTableSyncable(String table, String deletedTable) {
10389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        markTableSyncable(table, "_id", table, deletedTable);
10399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Mark this table as syncable, with the _sync_dirty residing in another
10439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * table. When an update occurs in this table the _sync_dirty field of the
10449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * row in updateTable with the _id in foreignKey will be set to
10459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * ensure proper syncing operation.
10469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table an update on this table will trigger a sync time removal
10489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param foreignKey this is the column in table whose value is an _id in
10499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *          updateTable
10509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param updateTable this is the table that will have its _sync_dirty
10519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void markTableSyncable(String table, String foreignKey,
10539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String updateTable) {
10549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        markTableSyncable(table, foreignKey, updateTable, null);
10559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Mark this table as syncable, with the _sync_dirty residing in another
10599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * table. When an update occurs in this table the _sync_dirty field of the
10609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * row in updateTable with the _id in foreignKey will be set to
10619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * ensure proper syncing operation.
10629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table an update on this table will trigger a sync time removal
10649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param foreignKey this is the column in table whose value is an _id in
10659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *          updateTable
10669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param updateTable this is the table that will have its _sync_dirty
10679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param deletedTable The deleted table that corresponds to the
10689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *          updateTable
10699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private void markTableSyncable(String table, String foreignKey,
10719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String updateTable, String deletedTable) {
10729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
10739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
10749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            native_execSQL("SELECT _sync_dirty FROM " + updateTable
10759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    + " LIMIT 0");
10769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            native_execSQL("SELECT " + foreignKey + " FROM " + table
10779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    + " LIMIT 0");
10789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
10799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
10809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SyncUpdateInfo info = new SyncUpdateInfo(updateTable, deletedTable,
10839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                foreignKey);
10849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        synchronized (mSyncUpdateInfo) {
10859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mSyncUpdateInfo.put(table, info);
10869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Call for each row that is updated in a cursor.
10919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table the row is in
10939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param rowId the row ID of the updated row
10949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ void rowUpdated(String table, long rowId) {
10969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SyncUpdateInfo info;
10979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        synchronized (mSyncUpdateInfo) {
10989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            info = mSyncUpdateInfo.get(table);
10999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (info != null) {
11019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            execSQL("UPDATE " + info.masterTable
11029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    + " SET _sync_dirty=1 WHERE _id=(SELECT " + info.foreignKey
11039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    + " FROM " + table + " WHERE _id=" + rowId + ")");
11049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Finds the name of the first table, which is editable.
11099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param tables a list of tables
11119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the first table listed
11129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
11139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static String findEditTable(String tables) {
11149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!TextUtils.isEmpty(tables)) {
11159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // find the first word terminated by either a space or a comma
11169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int spacepos = tables.indexOf(' ');
11179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int commapos = tables.indexOf(',');
11189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (spacepos > 0 && (spacepos < commapos || commapos < 0)) {
11209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                return tables.substring(0, spacepos);
11219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            } else if (commapos > 0 && (commapos < spacepos || spacepos < 0) ) {
11229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                return tables.substring(0, commapos);
11239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
11249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return tables;
11259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } else {
11269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException("Invalid tables");
11279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Compiles an SQL statement into a reusable pre-compiled statement object.
11329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The parameters are identical to {@link #execSQL(String)}. You may put ?s in the
11339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * statement and fill in those values with {@link SQLiteProgram#bindString}
11349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * and {@link SQLiteProgram#bindLong} each time you want to run the
11359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * statement. Statements may not return result sets larger than 1x1.
11369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql The raw SQL statement, may contain ? for unknown values to be
11389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            bound later.
1139f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A pre-compiled {@link SQLiteStatement} object. Note that
1140f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link SQLiteStatement}s are not synchronized, see the documentation for more details.
11419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
11429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public SQLiteStatement compileStatement(String sql) throws SQLException {
1143c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
1144f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
1145f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
1146f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
11479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
11489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return new SQLiteStatement(this, sql);
11499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
11509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
11519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Query the given URL, returning a {@link Cursor} over the result set.
11569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param distinct true if you want each row to be unique, false otherwise.
11589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table The table name to compile the query against.
11599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param columns A list of which columns to return. Passing null will
11609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            return all columns, which is discouraged to prevent reading
11619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            data from storage that isn't going to be used.
11629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selection A filter declaring which rows to return, formatted as an
11639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            SQL WHERE clause (excluding the WHERE itself). Passing null
11649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will return all rows for the given table.
11659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in selection, which will be
11669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         replaced by the values from selectionArgs, in order that they
11679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         appear in the selection. The values will be bound as Strings.
11689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param groupBy A filter declaring how to group rows, formatted as an SQL
11699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            GROUP BY clause (excluding the GROUP BY itself). Passing null
11709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will cause the rows to not be grouped.
11719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param having A filter declare which row groups to include in the cursor,
11729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            if row grouping is being used, formatted as an SQL HAVING
11739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            clause (excluding the HAVING itself). Passing null will cause
11749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            all row groups to be included, and is required when row
11759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            grouping is not being used.
11769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause
11779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            (excluding the ORDER BY itself). Passing null will use the
11789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            default sort order, which may be unordered.
11799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param limit Limits the number of rows returned by the query,
11809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            formatted as LIMIT clause. Passing null denotes no LIMIT clause.
1181f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1182f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
11839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see Cursor
11849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
11859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor query(boolean distinct, String table, String[] columns,
11869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String selection, String[] selectionArgs, String groupBy,
11879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String having, String orderBy, String limit) {
11889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return queryWithFactory(null, distinct, table, columns, selection, selectionArgs,
11899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                groupBy, having, orderBy, limit);
11909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Query the given URL, returning a {@link Cursor} over the result set.
11949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param cursorFactory the cursor factory to use, or null for the default factory
11969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param distinct true if you want each row to be unique, false otherwise.
11979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table The table name to compile the query against.
11989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param columns A list of which columns to return. Passing null will
11999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            return all columns, which is discouraged to prevent reading
12009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            data from storage that isn't going to be used.
12019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selection A filter declaring which rows to return, formatted as an
12029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            SQL WHERE clause (excluding the WHERE itself). Passing null
12039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will return all rows for the given table.
12049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in selection, which will be
12059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         replaced by the values from selectionArgs, in order that they
12069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         appear in the selection. The values will be bound as Strings.
12079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param groupBy A filter declaring how to group rows, formatted as an SQL
12089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            GROUP BY clause (excluding the GROUP BY itself). Passing null
12099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will cause the rows to not be grouped.
12109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param having A filter declare which row groups to include in the cursor,
12119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            if row grouping is being used, formatted as an SQL HAVING
12129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            clause (excluding the HAVING itself). Passing null will cause
12139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            all row groups to be included, and is required when row
12149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            grouping is not being used.
12159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause
12169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            (excluding the ORDER BY itself). Passing null will use the
12179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            default sort order, which may be unordered.
12189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param limit Limits the number of rows returned by the query,
12199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            formatted as LIMIT clause. Passing null denotes no LIMIT clause.
1220f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1221f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
12229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see Cursor
12239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor queryWithFactory(CursorFactory cursorFactory,
12259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            boolean distinct, String table, String[] columns,
12269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String selection, String[] selectionArgs, String groupBy,
12279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String having, String orderBy, String limit) {
1228f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
1229f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
1230f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
12319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        String sql = SQLiteQueryBuilder.buildQueryString(
12329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                distinct, table, columns, selection, groupBy, having, orderBy, limit);
12339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return rawQueryWithFactory(
12359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                cursorFactory, sql, selectionArgs, findEditTable(table));
12369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
12379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
12399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Query the given table, returning a {@link Cursor} over the result set.
12409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table The table name to compile the query against.
12429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param columns A list of which columns to return. Passing null will
12439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            return all columns, which is discouraged to prevent reading
12449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            data from storage that isn't going to be used.
12459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selection A filter declaring which rows to return, formatted as an
12469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            SQL WHERE clause (excluding the WHERE itself). Passing null
12479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will return all rows for the given table.
12489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in selection, which will be
12499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         replaced by the values from selectionArgs, in order that they
12509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         appear in the selection. The values will be bound as Strings.
12519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param groupBy A filter declaring how to group rows, formatted as an SQL
12529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            GROUP BY clause (excluding the GROUP BY itself). Passing null
12539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will cause the rows to not be grouped.
12549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param having A filter declare which row groups to include in the cursor,
12559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            if row grouping is being used, formatted as an SQL HAVING
12569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            clause (excluding the HAVING itself). Passing null will cause
12579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            all row groups to be included, and is required when row
12589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            grouping is not being used.
12599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause
12609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            (excluding the ORDER BY itself). Passing null will use the
12619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            default sort order, which may be unordered.
1262f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1263f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
12649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see Cursor
12659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor query(String table, String[] columns, String selection,
12679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String[] selectionArgs, String groupBy, String having,
12689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String orderBy) {
12699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return query(false, table, columns, selection, selectionArgs, groupBy,
12719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                having, orderBy, null /* limit */);
12729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
12739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
12759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Query the given table, returning a {@link Cursor} over the result set.
12769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table The table name to compile the query against.
12789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param columns A list of which columns to return. Passing null will
12799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            return all columns, which is discouraged to prevent reading
12809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            data from storage that isn't going to be used.
12819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selection A filter declaring which rows to return, formatted as an
12829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            SQL WHERE clause (excluding the WHERE itself). Passing null
12839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will return all rows for the given table.
12849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in selection, which will be
12859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         replaced by the values from selectionArgs, in order that they
12869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         appear in the selection. The values will be bound as Strings.
12879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param groupBy A filter declaring how to group rows, formatted as an SQL
12889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            GROUP BY clause (excluding the GROUP BY itself). Passing null
12899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            will cause the rows to not be grouped.
12909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param having A filter declare which row groups to include in the cursor,
12919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            if row grouping is being used, formatted as an SQL HAVING
12929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            clause (excluding the HAVING itself). Passing null will cause
12939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            all row groups to be included, and is required when row
12949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            grouping is not being used.
12959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param orderBy How to order the rows, formatted as an SQL ORDER BY clause
12969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            (excluding the ORDER BY itself). Passing null will use the
12979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            default sort order, which may be unordered.
12989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param limit Limits the number of rows returned by the query,
12999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            formatted as LIMIT clause. Passing null denotes no LIMIT clause.
1300f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1301f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
13029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @see Cursor
13039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor query(String table, String[] columns, String selection,
13059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String[] selectionArgs, String groupBy, String having,
13069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String orderBy, String limit) {
13079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return query(false, table, columns, selection, selectionArgs, groupBy,
13099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                having, orderBy, limit);
13109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Runs the provided SQL and returns a {@link Cursor} over the result set.
13149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql the SQL query. The SQL string must not be ; terminated
13169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in where clause in the query,
13179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     which will be replaced by the values from selectionArgs. The
13189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     values will be bound as Strings.
1319f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1320f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
13219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor rawQuery(String sql, String[] selectionArgs) {
13239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return rawQueryWithFactory(null, sql, selectionArgs, null);
13249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Runs the provided SQL and returns a cursor over the result set.
13289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param cursorFactory the cursor factory to use, or null for the default factory
13309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql the SQL query. The SQL string must not be ; terminated
13319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in where clause in the query,
13329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     which will be replaced by the values from selectionArgs. The
13339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     values will be bound as Strings.
13349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param editTable the name of the first table, which is editable
1335f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1336f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
13379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Cursor rawQueryWithFactory(
13399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            CursorFactory cursorFactory, String sql, String[] selectionArgs,
13409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            String editTable) {
1341f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
1342f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
1343f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
1344cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onReadFromDisk();
13459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        long timeStart = 0;
13469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
134790142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov        if (Config.LOGV || mSlowQueryThreshold != -1) {
13489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            timeStart = System.currentTimeMillis();
13499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
13509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteCursorDriver driver = new SQLiteDirectCursorDriver(this, sql, editTable);
13529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
135390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov        Cursor cursor = null;
13549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
135590142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov            cursor = driver.query(
13569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    cursorFactory != null ? cursorFactory : mFactory,
13579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    selectionArgs);
13589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
135990142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov            if (Config.LOGV || mSlowQueryThreshold != -1) {
136090142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov
1361020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                // Force query execution
1362020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                int count = -1;
1363020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                if (cursor != null) {
1364020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                    count = cursor.getCount();
1365020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                }
1366020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori
13679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                long duration = System.currentTimeMillis() - timeStart;
13689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
136990142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                if (Config.LOGV || duration >= mSlowQueryThreshold) {
137090142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                    Log.v(SQLiteCursor.TAG,
137190142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                          "query (" + duration + " ms): " + driver.toString() + ", args are "
137290142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                                  + (selectionArgs != null
137390142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                                  ? TextUtils.join(",", selectionArgs)
1374020e5345795a157d7829ebbe4d7864595dafc576Vasu Nori                                  : "<null>")  + ", count is " + count);
137590142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov                }
13769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
13779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
137890142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov        return cursor;
13799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Runs the provided SQL and returns a cursor over the result set.
1383600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     * The cursor will read an initial set of rows and the return to the caller.
1384600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     * It will continue to read in batches and send data changed notifications
13859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when the later batches are ready.
13869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql the SQL query. The SQL string must not be ; terminated
13879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param selectionArgs You may include ?s in where clause in the query,
13889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     which will be replaced by the values from selectionArgs. The
13899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *     values will be bound as Strings.
13909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param initialRead set the initial count of items to read from the cursor
13919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param maxRead set the count of items to read on each iteration after the first
1392f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
1393f3ca9a5c7e87319c934b5815566054d2e5c2085fJeff Hamilton     * {@link Cursor}s are not synchronized, see the documentation for more details.
1394600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov     *
1395f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler     * This work is incomplete and not fully tested or reviewed, so currently
1396f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler     * hidden.
1397f8a7ceaef2e7d5cd530c9426bde91b6fa9a40b75Andy Stadler     * @hide
13989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1399600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov    public Cursor rawQuery(String sql, String[] selectionArgs,
14009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int initialRead, int maxRead) {
14019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteCursor c = (SQLiteCursor)rawQueryWithFactory(
14029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                null, sql, selectionArgs, null);
14039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        c.setLoadStyle(initialRead, maxRead);
14049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return c;
14059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
1406600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
14079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for inserting a row into the database.
14099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to insert the row into
14119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param nullColumnHack SQL doesn't allow inserting a completely empty row,
14129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            so if initialValues is empty this column will explicitly be
14139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            assigned a NULL value
14149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param values this map contains the initial column values for the
14159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            row. The keys should be the column names and the values the
14169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            column values
14179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the row ID of the newly inserted row, or -1 if an error occurred
14189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
14199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long insert(String table, String nullColumnHack, ContentValues values) {
14209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
14218d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori            return insertWithOnConflict(table, nullColumnHack, values, CONFLICT_NONE);
14229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLException e) {
14239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "Error inserting " + values, e);
14249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return -1;
14259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for inserting a row into the database.
14309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to insert the row into
14329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param nullColumnHack SQL doesn't allow inserting a completely empty row,
14339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            so if initialValues is empty this column will explicitly be
14349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            assigned a NULL value
14359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param values this map contains the initial column values for the
14369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            row. The keys should be the column names and the values the
14379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            column values
14389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException
14399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the row ID of the newly inserted row, or -1 if an error occurred
14409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
14419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long insertOrThrow(String table, String nullColumnHack, ContentValues values)
14429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throws SQLException {
14438d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori        return insertWithOnConflict(table, nullColumnHack, values, CONFLICT_NONE);
14449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for replacing a row in the database.
14489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table in which to replace the row
14509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param nullColumnHack SQL doesn't allow inserting a completely empty row,
14519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            so if initialValues is empty this row will explicitly be
14529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            assigned a NULL value
14539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param initialValues this map contains the initial column values for
14549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   the row. The key
14559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the row ID of the newly inserted row, or -1 if an error occurred
14569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
14579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long replace(String table, String nullColumnHack, ContentValues initialValues) {
14589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
1459600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov            return insertWithOnConflict(table, nullColumnHack, initialValues,
14608d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori                    CONFLICT_REPLACE);
14619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLException e) {
14629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "Error inserting " + initialValues, e);
14639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return -1;
14649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for replacing a row in the database.
14699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table in which to replace the row
14719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param nullColumnHack SQL doesn't allow inserting a completely empty row,
14729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            so if initialValues is empty this row will explicitly be
14739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            assigned a NULL value
14749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param initialValues this map contains the initial column values for
14759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *   the row. The key
14769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException
14779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the row ID of the newly inserted row, or -1 if an error occurred
14789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
14799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long replaceOrThrow(String table, String nullColumnHack,
14809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            ContentValues initialValues) throws SQLException {
1481600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov        return insertWithOnConflict(table, nullColumnHack, initialValues,
14828d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori                CONFLICT_REPLACE);
14839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * General method for inserting a row into the database.
14879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to insert the row into
14899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param nullColumnHack SQL doesn't allow inserting a completely empty row,
14909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            so if initialValues is empty this column will explicitly be
14919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            assigned a NULL value
14929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param initialValues this map contains the initial column values for the
14939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            row. The keys should be the column names and the values the
14949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            column values
14958d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori     * @param conflictAlgorithm for insert conflict resolver
14966eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori     * @return the row ID of the newly inserted row
14976eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori     * OR the primary key of the existing row if the input param 'conflictAlgorithm' =
14988d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori     * {@link #CONFLICT_IGNORE}
14996eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori     * OR -1 if any error
15009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
15019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public long insertWithOnConflict(String table, String nullColumnHack,
15026eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori            ContentValues initialValues, int conflictAlgorithm) {
1503cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onWriteToDisk();
15049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!isOpen()) {
15059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException("database not open");
15069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // Measurements show most sql lengths <= 152
15099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        StringBuilder sql = new StringBuilder(152);
15109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append("INSERT");
15118d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori        sql.append(CONFLICT_VALUES[conflictAlgorithm]);
15129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(" INTO ");
15139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(table);
15149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        // Measurements show most values lengths < 40
15159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        StringBuilder values = new StringBuilder(40);
15169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Set<Map.Entry<String, Object>> entrySet = null;
15189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (initialValues != null && initialValues.size() > 0) {
15199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            entrySet = initialValues.valueSet();
15209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Iterator<Map.Entry<String, Object>> entriesIter = entrySet.iterator();
15219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append('(');
15229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            boolean needSeparator = false;
15249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            while (entriesIter.hasNext()) {
15259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                if (needSeparator) {
15269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    sql.append(", ");
15279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    values.append(", ");
15289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
15299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                needSeparator = true;
15309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Map.Entry<String, Object> entry = entriesIter.next();
15319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                sql.append(entry.getKey());
15329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                values.append('?');
15339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append(')');
15369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } else {
15379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append("(" + nullColumnHack + ") ");
15389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            values.append("NULL");
15399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(" VALUES(");
15429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(values);
15439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(");");
15449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
15469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteStatement statement = null;
15479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
15489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement = compileStatement(sql.toString());
15499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Bind the values
15519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (entrySet != null) {
15529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                int size = entrySet.size();
15539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Iterator<Map.Entry<String, Object>> entriesIter = entrySet.iterator();
15549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                for (int i = 0; i < size; i++) {
15559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Map.Entry<String, Object> entry = entriesIter.next();
15569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    DatabaseUtils.bindObjectToProgram(statement, i + 1, entry.getValue());
15579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
15589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Run the program and then cleanup
15619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement.execute();
15629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            long insertedRowId = lastInsertRow();
15649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (insertedRowId == -1) {
15659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Log.e(TAG, "Error inserting " + initialValues + " using " + sql);
15669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            } else {
15679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                if (Config.LOGD && Log.isLoggable(TAG, Log.VERBOSE)) {
15689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Log.v(TAG, "Inserting row " + insertedRowId + " from "
15699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                            + initialValues + " using " + sql);
15709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
15719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return insertedRowId;
15739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
15749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onCorruption();
15759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
15769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
15779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (statement != null) {
15789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                statement.close();
15799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
15819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
15839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
15859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for deleting rows in the database.
15869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
15879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to delete from
15889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param whereClause the optional WHERE clause to apply when deleting.
15899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            Passing null will delete all rows.
15909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the number of rows affected if a whereClause is passed in, 0
15919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         otherwise. To remove all rows and get a count pass "1" as the
15929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *         whereClause.
15939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
15949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public int delete(String table, String whereClause, String[] whereArgs) {
1595cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onWriteToDisk();
1596c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
15979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!isOpen()) {
15989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalStateException("database not open");
15999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteStatement statement = null;
16019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
16029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement = compileStatement("DELETE FROM " + table
16039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    + (!TextUtils.isEmpty(whereClause)
16049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    ? " WHERE " + whereClause : ""));
16059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (whereArgs != null) {
16069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                int numArgs = whereArgs.length;
16079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                for (int i = 0; i < numArgs; i++) {
16089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    DatabaseUtils.bindObjectToProgram(statement, i + 1, whereArgs[i]);
16099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
16109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
16119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement.execute();
16129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return lastChangeCount();
16139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
16149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onCorruption();
16159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
16169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
16179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (statement != null) {
16189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                statement.close();
16199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
16209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
16219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
16239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
16259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for updating rows in the database.
16269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to update in
16289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param values a map from column names to new column values. null is a
16299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            valid value that will be translated to NULL.
16309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param whereClause the optional WHERE clause to apply when updating.
16319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            Passing null will update all rows.
16329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the number of rows affected
16339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
16349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public int update(String table, ContentValues values, String whereClause, String[] whereArgs) {
16358d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori        return updateWithOnConflict(table, values, whereClause, whereArgs, CONFLICT_NONE);
16369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
1637600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov
16389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
16399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Convenience method for updating rows in the database.
16409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param table the table to update in
16429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param values a map from column names to new column values. null is a
16439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            valid value that will be translated to NULL.
16449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param whereClause the optional WHERE clause to apply when updating.
16459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *            Passing null will update all rows.
16468d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori     * @param conflictAlgorithm for update conflict resolver
16479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the number of rows affected
16489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1649600bdd82f58c7338e68ce2c8f04b17db4cf4f910Dmitri Plotnikov    public int updateWithOnConflict(String table, ContentValues values,
16506eb7c45a8fdb774c4094b5012c8496f2a009c032Vasu Nori            String whereClause, String[] whereArgs, int conflictAlgorithm) {
1651cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onWriteToDisk();
16529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (values == null || values.size() == 0) {
16539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalArgumentException("Empty values");
16549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        StringBuilder sql = new StringBuilder(120);
16579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append("UPDATE ");
16588d45e4e4c6244cc3a508da3b56fec8cfd4cadd1dVasu Nori        sql.append(CONFLICT_VALUES[conflictAlgorithm]);
16599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(table);
16609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        sql.append(" SET ");
16619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Set<Map.Entry<String, Object>> entrySet = values.valueSet();
16639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        Iterator<Map.Entry<String, Object>> entriesIter = entrySet.iterator();
16649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        while (entriesIter.hasNext()) {
16669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Map.Entry<String, Object> entry = entriesIter.next();
16679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append(entry.getKey());
16689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append("=?");
16699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (entriesIter.hasNext()) {
16709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                sql.append(", ");
16719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
16729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (!TextUtils.isEmpty(whereClause)) {
16759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append(" WHERE ");
16769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            sql.append(whereClause);
16779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
1680c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        if (!isOpen()) {
1681c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori            throw new IllegalStateException("database not open");
1682c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        }
16839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteStatement statement = null;
16849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
16859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement = compileStatement(sql.toString());
16869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Bind the values
16889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int size = entrySet.size();
16899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            entriesIter = entrySet.iterator();
16909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int bindArg = 1;
16919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            for (int i = 0; i < size; i++) {
16929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Map.Entry<String, Object> entry = entriesIter.next();
16939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                DatabaseUtils.bindObjectToProgram(statement, bindArg, entry.getValue());
16949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                bindArg++;
16959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
16969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (whereArgs != null) {
16989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                size = whereArgs.length;
16999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                for (int i = 0; i < size; i++) {
17009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    statement.bindString(bindArg, whereArgs[i]);
17019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    bindArg++;
17029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
17039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
17049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
17059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // Run the program and then cleanup
17069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement.execute();
17079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            int numChangedRows = lastChangeCount();
17089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (Config.LOGD && Log.isLoggable(TAG, Log.VERBOSE)) {
17099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                Log.v(TAG, "Updated " + numChangedRows + " using " + values + " and " + sql);
17109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
17119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return numChangedRows;
17129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
17139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onCorruption();
17149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
17159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLException e) {
17169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "Error updating " + values + " using " + sql);
17179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
17189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
17199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (statement != null) {
17209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                statement.close();
17219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
17229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
17239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
17249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
17259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
17269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
17279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Execute a single SQL statement that is not a query. For example, CREATE
17289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * TABLE, DELETE, INSERT, etc. Multiple statements separated by ;s are not
17299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * supported. it takes a write lock
17309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
17319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException If the SQL string is invalid for some reason
17329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
17339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void execSQL(String sql) throws SQLException {
1734cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onWriteToDisk();
1735c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        long timeStart = SystemClock.uptimeMillis();
1736c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        lock();
1737f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!isOpen()) {
1738f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            throw new IllegalStateException("database not open");
1739f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
1740722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        logTimeStat(mLastSqlStatement, timeStart, GET_LOCK_LOG_PREFIX);
17419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
17429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            native_execSQL(sql);
17439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
17449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onCorruption();
17459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
17469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
17479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
17489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
1749b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick
1750b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // Log commit statements along with the most recently executed
1751b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // SQL statement for disambiguation.  Note that instance
1752b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // equality to COMMIT_SQL is safe here.
1753b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        if (sql == COMMIT_SQL) {
1754722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            logTimeStat(mLastSqlStatement, timeStart, COMMIT_SQL);
1755b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        } else {
1756722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            logTimeStat(sql, timeStart, null);
1757b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        }
17589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
17599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
17609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
17619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Execute a single SQL statement that is not a query. For example, CREATE
17629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * TABLE, DELETE, INSERT, etc. Multiple statements separated by ;s are not
17639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * supported. it takes a write lock,
17649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
17659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql
17669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param bindArgs only byte[], String, Long and Double are supported in bindArgs.
17679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException If the SQL string is invalid for some reason
17689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
17699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void execSQL(String sql, Object[] bindArgs) throws SQLException {
1770cfda9f3a4756c71b3aadd1387419cb3b513dd400Brad Fitzpatrick        BlockGuard.getThreadPolicy().onWriteToDisk();
17719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (bindArgs == null) {
17729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalArgumentException("Empty bindArgs");
17739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
1774d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick        long timeStart = SystemClock.uptimeMillis();
17759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        lock();
1776c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        if (!isOpen()) {
1777c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori            throw new IllegalStateException("database not open");
1778c8e1f23891cff31a9da2bab412631ff770a92f56Vasu Nori        }
17799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        SQLiteStatement statement = null;
17809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
17819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement = compileStatement(sql);
17829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (bindArgs != null) {
17839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                int numArgs = bindArgs.length;
17849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                for (int i = 0; i < numArgs; i++) {
17859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    DatabaseUtils.bindObjectToProgram(statement, i + 1, bindArgs[i]);
17869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
17879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
17889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            statement.execute();
17899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (SQLiteDatabaseCorruptException e) {
17909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onCorruption();
17919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
17929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } finally {
17939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (statement != null) {
17949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                statement.close();
17959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
17969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            unlock();
17979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
179812311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor        logTimeStat(sql, timeStart);
17999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    @Override
18029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    protected void finalize() {
18039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (isOpen()) {
1804d606b4bf2c1a2308b40785860853cfb95a77bf58Vasu Nori            Log.e(TAG, "close() was never explicitly called on database '" +
1805d606b4bf2c1a2308b40785860853cfb95a77bf58Vasu Nori                    mPath + "' ", mStackTrace);
18069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            closeClosable();
18079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            onAllReferencesReleased();
18089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
18099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
18129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Private constructor. See {@link #create} and {@link #openDatabase}.
18139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
18149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param path The full path to the database
18159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param factory The factory to use when creating cursors, may be NULL.
18169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param flags 0 or {@link #NO_LOCALIZED_COLLATORS}.  If the database file already
18179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *              exists, mFlags will be updated appropriately.
18189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
18199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private SQLiteDatabase(String path, CursorFactory factory, int flags) {
18209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (path == null) {
18219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw new IllegalArgumentException("path should not be null");
18229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
18239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mFlags = flags;
18249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mPath = path;
182590142c959e6de38eae1563cd8b3d2d448393e15fDmitri Plotnikov        mSlowQueryThreshold = SystemProperties.getInt(LOG_SLOW_QUERIES_PROPERTY, -1);
182608b448ea39e9fabfc5212ae6f7226eba4385d189Vasu Nori        mStackTrace = new DatabaseObjectNotClosedException().fillInStackTrace();
18279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mFactory = factory;
18289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        dbopen(mPath, mFlags);
18295a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        if (SQLiteDebug.DEBUG_SQL_CACHE) {
18305a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            mTimeOpened = getTime();
18315a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
18329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mPrograms = new WeakHashMap<SQLiteClosable,Object>();
18339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
18349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            setLocale(Locale.getDefault());
18359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (RuntimeException e) {
18369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "Failed to setLocale() when constructing, closing the database", e);
18379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            dbclose();
18385a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (SQLiteDebug.DEBUG_SQL_CACHE) {
18395a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                mTimeClosed = getTime();
18405a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
18419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            throw e;
18429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
18439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18455a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    private String getTime() {
18465a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS ").format(System.currentTimeMillis());
18475a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    }
18485a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
18499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
18509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * return whether the DB is opened as read only.
18519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if DB is opened as read only
18529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
18539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean isReadOnly() {
18549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return (mFlags & OPEN_READ_MASK) == OPEN_READONLY;
18559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
18589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the DB is currently open (has not been closed)
18599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
18609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean isOpen() {
18619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return mNativeHandle != 0;
18629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean needUpgrade(int newVersion) {
18659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return newVersion > getVersion();
18669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
18689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
18699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Getter for the path to the database file.
18709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
18719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the path to our database file.
18729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
18739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public final String getPath() {
18749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return mPath;
18759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
18769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1877d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick    /* package */ void logTimeStat(String sql, long beginMillis) {
1878722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        logTimeStat(sql, beginMillis, null);
1879722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    }
1880722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick
1881722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick    /* package */ void logTimeStat(String sql, long beginMillis, String prefix) {
1882b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // Keep track of the last statement executed here, as this is
1883b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // the common funnel through which all methods of hitting
1884b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        // libsqlite eventually flow.
1885b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick        mLastSqlStatement = sql;
1886b28c7972bd3e5e34138e2fd7a2e1433d65205bdfBrad Fitzpatrick
1887e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // Sample fast queries in proportion to the time taken.
1888e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // Quantize the % first, so the logged sampling probability
1889e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // exactly equals the actual sampling rate for this query.
1890e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
1891e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        int samplePercent;
1892d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick        long durationMillis = SystemClock.uptimeMillis() - beginMillis;
1893722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        if (durationMillis == 0 && prefix == GET_LOCK_LOG_PREFIX) {
1894722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            // The common case is locks being uncontended.  Don't log those,
1895722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            // even at 1%, which is our default below.
1896722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            return;
1897722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        }
1898722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        if (sQueryLogTimeInMillis == 0) {
1899722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            sQueryLogTimeInMillis = SystemProperties.getInt("db.db_operation.threshold_ms", 500);
1900722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        }
1901722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        if (durationMillis >= sQueryLogTimeInMillis) {
1902e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            samplePercent = 100;
1903722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        } else {;
1904722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            samplePercent = (int) (100 * durationMillis / sQueryLogTimeInMillis) + 1;
1905e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            if (mRandom.nextInt(100) >= samplePercent) return;
19065a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
1907e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
1908722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        // Note: the prefix will be "COMMIT;" or "GETLOCK:" when non-null.  We wait to do
1909722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        // it here so we avoid allocating in the common case.
1910722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        if (prefix != null) {
1911722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick            sql = prefix + sql;
1912722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick        }
1913722802e76b8805da523a612ad3482450fd327db0Brad Fitzpatrick
1914e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        if (sql.length() > QUERY_LOG_SQL_LENGTH) sql = sql.substring(0, QUERY_LOG_SQL_LENGTH);
1915e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
1916e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // ActivityThread.currentPackageName() only returns non-null if the
1917e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // current thread is an application main thread.  This parameter tells
1918e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // us whether an event loop is blocked, and if so, which app it is.
1919e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        //
1920e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // Sadly, there's no fast way to determine app name if this is *not* a
1921e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // main thread, or when we are invoked via Binder (e.g. ContentProvider).
1922e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        // Hopefully the full path to the database will be informative enough.
1923e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
1924e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        String blockingPackage = ActivityThread.currentPackageName();
1925e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        if (blockingPackage == null) blockingPackage = "";
1926e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
1927d72f718c9cc4bd5e4701f4c5cdab51b4d8cf6435Brad Fitzpatrick        EventLog.writeEvent(
1928d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            EVENT_DB_OPERATION,
1929d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            getPathForLogs(),
1930d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            sql,
1931d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            durationMillis,
1932d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            blockingPackage,
1933d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            samplePercent);
1934d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    }
1935d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick
1936d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    /**
1937d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick     * Removes email addresses from database filenames before they're
1938d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick     * logged to the EventLog where otherwise apps could potentially
1939d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick     * read them.
1940d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick     */
1941d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick    private String getPathForLogs() {
1942d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        if (mPathForLogs != null) {
1943d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            return mPathForLogs;
1944d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        }
1945d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        if (mPath == null) {
1946d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            return null;
1947d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        }
1948d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        if (mPath.indexOf('@') == -1) {
1949d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            mPathForLogs = mPath;
1950d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        } else {
1951d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick            mPathForLogs = EMAIL_IN_DB_PATTERN.matcher(mPath).replaceAll("XX@YY");
1952d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        }
1953d833023307494d5bfe3fdc1ce79761fb8c9f49a6Brad Fitzpatrick        return mPathForLogs;
19545a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    }
19555a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
19565a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /**
1957e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * Sets the locale for this database.  Does nothing if this database has
1958e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * the NO_LOCALIZED_COLLATORS flag set or was opened read only.
1959e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @throws SQLException if the locale could not be set.  The most common reason
1960e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * for this is that there is no collator available for the locale you requested.
1961e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * In this case the database remains unchanged.
19625a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     */
1963e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public void setLocale(Locale locale) {
1964e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        lock();
1965e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        try {
1966e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            native_setLocale(locale.toString(), mFlags);
1967e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        } finally {
1968e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            unlock();
19695a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
19705a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    }
19715a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
1972e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /*
1973e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * ============================================================================
1974e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     *
1975e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     *       The following methods deal with compiled-sql cache
1976e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * ============================================================================
1977e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
19785a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /**
19795a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * adds the given sql and its compiled-statement-id-returned-by-sqlite to the
19805a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * cache of compiledQueries attached to 'this'.
19815a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     *
19825a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * if there is already a {@link SQLiteCompiledSql} in compiledQueries for the given sql,
19835a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * the new {@link SQLiteCompiledSql} object is NOT inserted into the cache (i.e.,the current
19845a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * mapping is NOT replaced with the new mapping).
19855a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     */
1986e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /* package */ void addToCompiledQueries(String sql, SQLiteCompiledSql compiledStatement) {
19875a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        if (mMaxSqlCacheSize == 0) {
19885a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            // for this database, there is no cache of compiled sql.
19895a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (SQLiteDebug.DEBUG_SQL_CACHE) {
19905a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                Log.v(TAG, "|NOT adding_sql_to_cache|" + getPath() + "|" + sql);
19915a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
1992e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            return;
19935a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
19945a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
19955a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        SQLiteCompiledSql compiledSql = null;
19965a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        synchronized(mCompiledQueries) {
19975a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            // don't insert the new mapping if a mapping already exists
19985a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            compiledSql = mCompiledQueries.get(sql);
19995a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (compiledSql != null) {
2000e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori                return;
20015a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
20025a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            // add this <sql, compiledStatement> to the cache
20035a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (mCompiledQueries.size() == mMaxSqlCacheSize) {
200449d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                /*
200549d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                 * cache size of {@link #mMaxSqlCacheSize} is not enough for this app.
200649d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                 * log a warning MAX_WARNINGS_ON_CACHESIZE_CONDITION times
200749d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                 * chances are it is NOT using ? for bindargs - so caching is useless.
200849d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                 * TODO: either let the callers set max cchesize for their app, or intelligently
200949d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                 * figure out what should be cached for a given app.
20105a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                 */
201149d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                if (++mCacheFullWarnings == MAX_WARNINGS_ON_CACHESIZE_CONDITION) {
201249d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                    Log.w(TAG, "Reached MAX size for compiled-sql statement cache for database " +
201349d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                            getPath() + "; i.e., NO space for this sql statement in cache: " +
201449d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                            sql + ". Please change your sql statements to use '?' for " +
201549d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                            "bindargs, instead of using actual values");
201649d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                }
201749d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                // don't add this entry to cache
201849d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori            } else {
201949d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                // cache is NOT full. add this to cache.
202049d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                mCompiledQueries.put(sql, compiledStatement);
202149d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                if (SQLiteDebug.DEBUG_SQL_CACHE) {
202249d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                    Log.v(TAG, "|adding_sql_to_cache|" + getPath() + "|" +
202349d02acec84cc0382286fa233135bb5c74d5bdbfVasu Nori                            mCompiledQueries.size() + "|" + sql);
20245a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                }
20255a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
20265a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
2027e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        return;
2028e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    }
2029e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
2030e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori
2031e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    private void deallocCachedSqlStatements() {
2032e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        synchronized (mCompiledQueries) {
2033e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            for (SQLiteCompiledSql compiledSql : mCompiledQueries.values()) {
2034e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori                compiledSql.releaseSqlStatement();
2035e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            }
2036e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            mCompiledQueries.clear();
2037e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        }
20385a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    }
20395a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
20405a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /**
20415a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * from the compiledQueries cache, returns the compiled-statement-id for the given sql.
20425a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     * returns null, if not found in the cache.
20435a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori     */
20445a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    /* package */ SQLiteCompiledSql getCompiledStatementForSql(String sql) {
20455a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        SQLiteCompiledSql compiledStatement = null;
20465a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        boolean cacheHit;
20475a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        synchronized(mCompiledQueries) {
20485a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            if (mMaxSqlCacheSize == 0) {
20495a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                // for this database, there is no cache of compiled sql.
20505a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                if (SQLiteDebug.DEBUG_SQL_CACHE) {
20515a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                    Log.v(TAG, "|cache NOT found|" + getPath());
20525a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                }
20535a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                return null;
20545a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            }
20555a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            cacheHit = (compiledStatement = mCompiledQueries.get(sql)) != null;
20565a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
20575a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        if (cacheHit) {
20585a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            mNumCacheHits++;
20595a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        } else {
20605a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            mNumCacheMisses++;
20615a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
20625a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
20635a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        if (SQLiteDebug.DEBUG_SQL_CACHE) {
20645a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori            Log.v(TAG, "|cache_stats|" +
20655a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                    getPath() + "|" + mCompiledQueries.size() +
20665a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                    "|" + mNumCacheHits + "|" + mNumCacheMisses +
20675a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori                    "|" + cacheHit + "|" + mTimeOpened + "|" + mTimeClosed + "|" + sql);
20685a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        }
20695a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori        return compiledStatement;
20705a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori    }
20715a03f36ef845f73eb4473193dbb0f93dd12a51afVasu Nori
2072e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /**
2073e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * returns true if the given sql is cached in compiled-sql cache.
2074e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
2075e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
2076e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public boolean isInCompiledSqlCache(String sql) {
2077e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        synchronized(mCompiledQueries) {
2078e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            return mCompiledQueries.containsKey(sql);
207912311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor        }
2080e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    }
208112311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor
2082e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /**
2083e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * purges the given sql from the compiled-sql cache.
2084e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
2085e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
2086e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public void purgeFromCompiledSqlCache(String sql) {
2087e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        synchronized(mCompiledQueries) {
2088e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            mCompiledQueries.remove(sql);
2089e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        }
2090e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    }
209112311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor
2092e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /**
2093e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * remove everything from the compiled sql cache
2094e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
2095e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
2096e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public void resetCompiledSqlCache() {
2097e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        synchronized(mCompiledQueries) {
2098e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            mCompiledQueries.clear();
2099e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        }
2100e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    }
210112311959c6ec6898e3b40d4e8958b29ec0b72da9Dan Egnor
2102e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    /**
2103e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * return the current maxCacheSqlCacheSize
2104e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
2105e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     */
2106e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public synchronized int getMaxSqlCacheSize() {
2107e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        return mMaxSqlCacheSize;
21089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
21099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
21109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
2111e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * set the max size of the compiled sql cache for this database after purging the cache.
2112e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * (size of the cache = number of compiled-sql-statements stored in the cache).
2113e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     *
2114e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * max cache size can ONLY be increased from its current size (default = 0).
2115e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * if this method is called with smaller size than the current value of mMaxSqlCacheSize,
2116e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * then IllegalStateException is thrown
2117e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     *
2118e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * synchronized because we don't want t threads to change cache size at the same time.
2119e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @param cacheSize the size of the cache. can be (0 to MAX_SQL_CACHE_SIZE)
2120e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @throws IllegalStateException if input cacheSize > MAX_SQL_CACHE_SIZE or < 0 or
2121e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * < the value set with previous setMaxSqlCacheSize() call.
2122e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     *
2123e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori     * @hide
21249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
2125e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori    public synchronized void setMaxSqlCacheSize(int cacheSize) {
2126e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        if (cacheSize > MAX_SQL_CACHE_SIZE || cacheSize < 0) {
2127e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            throw new IllegalStateException("expected value between 0 and " + MAX_SQL_CACHE_SIZE);
2128e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        } else if (cacheSize < mMaxSqlCacheSize) {
2129e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori            throw new IllegalStateException("cannot set cacheSize to a value less than the value " +
2130e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori                    "set with previous setMaxSqlCacheSize() call.");
21319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
2132e495d1f74af13aec8d5d825e93e4cfe1e4fe7468Vasu Nori        mMaxSqlCacheSize = cacheSize;
21339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
21349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2135c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    static class ActiveDatabases {
2136c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        private static final ActiveDatabases activeDatabases = new ActiveDatabases();
2137c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        private HashSet<WeakReference<SQLiteDatabase>> mActiveDatabases =
2138c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            new HashSet<WeakReference<SQLiteDatabase>>();
2139c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        private ActiveDatabases() {} // disable instantiation of this class
2140c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        static ActiveDatabases getInstance() {return activeDatabases;}
2141c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    }
2142c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2143f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori    /**
2144f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori     * this method is used to collect data about ALL open databases in the current process.
2145f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori     * bugreport is a user of this data.
2146f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori     */
2147c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    /* package */ static ArrayList<DbStats> getDbStats() {
2148c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        ArrayList<DbStats> dbStatsList = new ArrayList<DbStats>();
2149c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        for (WeakReference<SQLiteDatabase> w : ActiveDatabases.getInstance().mActiveDatabases) {
2150c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            SQLiteDatabase db = w.get();
2151c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            if (db == null || !db.isOpen()) {
2152c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                continue;
2153c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            }
2154c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            // get SQLITE_DBSTATUS_LOOKASIDE_USED for the db
2155c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            int lookasideUsed = db.native_getDbLookaside();
2156c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2157c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            // get the lastnode of the dbname
2158c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            String path = db.getPath();
2159c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            int indx = path.lastIndexOf("/");
2160c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            String lastnode = path.substring((indx != -1) ? ++indx : 0);
2161c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2162c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            // get list of attached dbs and for each db, get its size and pagesize
2163c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            ArrayList<Pair<String, String>> attachedDbs = getAttachedDbs(db);
2164f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            if (attachedDbs == null) {
2165f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                continue;
2166f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            }
2167c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            for (int i = 0; i < attachedDbs.size(); i++) {
2168c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                Pair<String, String> p = attachedDbs.get(i);
2169c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                long pageCount = getPragmaVal(db, p.first + ".page_count;");
2170c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2171c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                // first entry in the attached db list is always the main database
2172c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                // don't worry about prefixing the dbname with "main"
2173c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                String dbName;
2174c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                if (i == 0) {
2175c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    dbName = lastnode;
2176c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                } else {
2177c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    // lookaside is only relevant for the main db
2178c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    lookasideUsed = 0;
2179c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    dbName = "  (attached) " + p.first;
2180c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    // if the attached db has a path, attach the lastnode from the path to above
2181c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    if (p.second.trim().length() > 0) {
2182c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                        int idx = p.second.lastIndexOf("/");
2183c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                        dbName += " : " + p.second.substring((idx != -1) ? ++idx : 0);
2184c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                    }
2185c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori                }
2186f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                if (pageCount > 0) {
2187f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                    dbStatsList.add(new DbStats(dbName, pageCount, db.getPageSize(),
2188f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                            lookasideUsed));
2189f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori                }
2190c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            }
2191c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        }
2192c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        return dbStatsList;
2193c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    }
2194c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2195c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    /**
2196c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * get the specified pragma value from sqlite for the specified database.
2197c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * only handles pragma's that return int/long.
2198c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * NO JAVA locks are held in this method.
2199c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * TODO: use this to do all pragma's in this class
2200c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     */
2201c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    private static long getPragmaVal(SQLiteDatabase db, String pragma) {
2202f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!db.isOpen()) {
2203f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            return 0;
2204f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
2205c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        SQLiteStatement prog = null;
2206c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        try {
2207c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            prog = new SQLiteStatement(db, "PRAGMA " + pragma);
2208c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            long val = prog.simpleQueryForLong();
2209c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            return val;
2210c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        } finally {
2211c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori            if (prog != null) prog.close();
2212c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        }
2213c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    }
2214c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2215c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    /**
2216c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * returns list of full pathnames of all attached databases
2217c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * including the main database
2218c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * TODO: move this to {@link DatabaseUtils}
2219c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     */
2220c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    private static ArrayList<Pair<String, String>> getAttachedDbs(SQLiteDatabase dbObj) {
2221f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        if (!dbObj.isOpen()) {
2222f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori            return null;
2223f3cf8a4da8ef28e62586cc07edce99879e2c3a56Vasu Nori        }
2224c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        ArrayList<Pair<String, String>> attachedDbs = new ArrayList<Pair<String, String>>();
2225c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        Cursor c = dbObj.rawQuery("pragma database_list;", null);
2226c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        while (c.moveToNext()) {
2227c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori             attachedDbs.add(new Pair<String, String>(c.getString(1), c.getString(2)));
2228c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        }
2229c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        c.close();
2230c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori        return attachedDbs;
2231c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    }
2232c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
22339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
22349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Native call to open the database.
22359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
22369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param path The full path to the database
22379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
22389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private native void dbopen(String path, int flags);
22399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
22409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
22413ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * Native call to setup tracing of all sql statements
22423ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     *
22433ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * @param path the full path to the database
22443ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     */
22453ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori    private native void enableSqlTracing(String path);
22463ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori
22473ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori    /**
22483ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * Native call to setup profiling of all sql statements.
22493ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * currently, sqlite's profiling = printing of execution-time
22503ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * (wall-clock time) of each of the sql statements, as they
22513ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * are executed.
22523ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     *
22533ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     * @param path the full path to the database
22543ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori     */
22553ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori    private native void enableSqlProfiling(String path);
22563ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori
22573ef94e25b4c896ecaa85aa2c12b8863ecdf98df0Vasu Nori    /**
22589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Native call to execute a raw SQL statement. {@link #lock} must be held
22599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when calling this method.
22609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
22619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param sql The raw SQL string
22629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException
22639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
22649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ native void native_execSQL(String sql) throws SQLException;
22659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
22669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
22679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Native call to set the locale.  {@link #lock} must be held when calling
22689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * this method.
22699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SQLException
22709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
22719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ native void native_setLocale(String loc, int flags);
22729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
22739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
22749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the row ID of the last row inserted into the database.
22759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
22769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the row ID of the last row inserted into the database.
22779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
22789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ native long lastInsertRow();
22799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
22809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
22819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the number of changes made in the last statement executed.
22829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
22839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the number of changes made in the last statement executed.
22849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
22859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /* package */ native int lastChangeCount();
2286c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori
2287c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    /**
2288c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * return the SQLITE_DBSTATUS_LOOKASIDE_USED documented here
2289c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * http://www.sqlite.org/c3ref/c_dbstatus_lookaside_used.html
2290c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     * @return int value of SQLITE_DBSTATUS_LOOKASIDE_USED
2291c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori     */
2292c3849200fa60b22ea583ba2a6f902d6a632a5e7eVasu Nori    private native int native_getDbLookaside();
22939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}
2294