Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yaa110/RestorableSQLiteDatabase
A wrapper around Android's SQLiteDatabase with restoring capability
https://github.com/yaa110/RestorableSQLiteDatabase
android android-library sqlite-android
Last synced: about 1 month ago
JSON representation
A wrapper around Android's SQLiteDatabase with restoring capability
- Host: GitHub
- URL: https://github.com/yaa110/RestorableSQLiteDatabase
- Owner: yaa110
- License: mit
- Created: 2015-03-29T17:04:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-02T16:35:00.000Z (over 8 years ago)
- Last Synced: 2024-04-25T22:34:39.330Z (5 months ago)
- Topics: android, android-library, sqlite-android
- Language: Java
- Homepage:
- Size: 95.7 KB
- Stars: 21
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android - RestorableSQLiteDatabase - A wrapper to replicate android's SQLiteDatabase with restoring capability. (Libraries / Database)
- awesome-android-libraries - RestorableSQLiteDatabase
- awesome-android - RestorableSQLiteDatabase - A wrapper to replicate android's SQLiteDatabase with restoring capability. (Libraries / Database)
- awesome-android-cn - 官网
README
Restorable SQLiteDatabase
=========================
[  ](https://bintray.com/yaa110/maven/restorablesqlitedatabase/view) [](https://github.com/yaa110/RestorableSQLiteDatabase/blob/master/LICENSE)
RestorableSQLiteDatabase is a wrapper to replicate android's [SQLiteDatabase](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html) class with restoring capability. This wrapper makes it possible to undo changes made after execution of SQL queries.
## How to use
**Use Gradle**
Reference library using this dependency in your module's `build.gradle` file:
```Gradle
dependencies {
compile 'github.yaa110.db:restorablesqlitedatabase:0.1.0'
}
```
**or Use Maven**
```xml
github.yaa110.db
restorablesqlitedatabase
0.1.0
aar
```
## Example: Undoing deleted rows
First, create a subclass of `SQLiteOpenHelper`:
```java
public class DbHelper extends SQLiteOpenHelper {
public DbHelper(Context context) {
super(context, DB_NAME, null, DB_VERSION);
}
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL(
"CREATE TABLE IF NOT EXISTS " + TABLE_NAME + " (" +
COLUMN_ROWID + " INTEGER PRIMARY KEY AUTOINCREMENT, " +
COLUMN_TITLE + " TEXT" +
");"
);
}
@Override
public void onUpgrade(SQLiteDatabase db, int old_version, int new_version) {
db.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME);
onCreate(db);
}
}
```
Then, use `RestorableSQLiteDatabase`:
```java
HashMap tableRowid = new HashMap<>();
tableRowid.put(TABLE_NAME, COLUMN_ROWID);
DbHelper helper = new DbHelper(this);
RestorableSQLiteDatabase db = new RestorableSQLiteDatabase(helper, tableRowid);
// Delete some rows
db.delete(
TABLE_NAME,
COLUMN_TITLE + " = ?",
new String[] {"demo"},
"DELETION_TAG"
);
// Undoing deletion
db.restore("DELETION_TAG");
```
## Documentation
```java
public static RestorableSQLiteDatabase getInstance(SQLiteDatabase mSQLiteDatabase, HashMap tableRowid)
```
Constructs a new instance of the `RestorableSQLiteDatabase` only if no instance is constructed.
**Parameters**
- *mSQLiteDatabase* the instance of the `SQLiteDatabase` to be wrapped.
- *tableRowid* maps the table name to its ROWID column name.
```java
public static RestorableSQLiteDatabase getInstance(T helper, HashMap tableRowid)
```
Constructs a new instance of the `RestorableSQLiteDatabase` only if no instance is constructed.
**Parameters**
- *helper* the instance of the `SQLiteOpenHelper` to open a database using its [getWritableDatabase](http://developer.android.com/reference/android/database/sqlite/SQLiteOpenHelper.html#getWritableDatabase()) method.
- *tableRowid* maps the table name to its ROWID column name.
```java
public static RestorableSQLiteDatabase getNewInstance(SQLiteDatabase mSQLiteDatabase, HashMap tableRowid)
```
Constructs a new instance of the `RestorableSQLiteDatabase`.
**Parameters**
- *mSQLiteDatabase* the instance of the `SQLiteDatabase` to be wrapped.
- *tableRowid* maps the table name to its ROWID column name.
```java
public static RestorableSQLiteDatabase getNewInstance(T helper, HashMap tableRowid)
```
Constructs a new instance of the `RestorableSQLiteDatabase`.
**Parameters**
- *helper* the instance of the `SQLiteOpenHelper` to open a database using its [getWritableDatabase](http://developer.android.com/reference/android/database/sqlite/SQLiteOpenHelper.html#getWritableDatabase()) method.
- *tableRowid* maps the table name to its ROWID column name.
```java
public void close()
```
Closes the SQLite database. Use the `reopen` methods to reopen the SQLite database.
```java
public boolean containsTag(String tag)
```
Checks if the hash table contains the tag.
**Parameters**
- *tag* possible tag of restoring query.
**Returns**
True if the hash table contains the tag; false otherwise.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public int delete(String table, String whereClause, String[] whereArgs, String tag)
```
Replicates the [delete](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#delete(java.lang.String, java.lang.String, java.lang.String[])) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public ArrayList getQueries(String tag)
```
Provides the query to which the tag is mapped.
**Parameters**
- *tag* possible tag of restoring query.
**Returns**
The queries to which the tag is mapped, or null if the hash table contains no mapping for the tag.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public SQLiteDatabase getSQLiteDatabase()
```
Provides the instance of wrapped `SQLiteDatabase`.
**Returns**
The instance of wrapped `SQLiteDatabase`.
```java
public Hashtable> getTagQueryParameters()
```
Provides the parameters hash table.
**Returns**
The parameters hash table.
```java
public Hashtable> getTagQueryTable()
```
Provides the hash table.
**Returns**
The hash table.
```java
public long insert(String table, String nullColumnHack, ContentValues values, String tag)
```
Replicates the [insert](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#insert(java.lang.String, java.lang.String, android.content.ContentValues)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public long insertOrThrow(String table, String nullColumnHack, ContentValues values, String tag) throws SQLException
```
Replicates the [insertOrThrow](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#insertOrThrow(java.lang.String, java.lang.String, android.content.ContentValues)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public long insertWithOnConflict(String table, String nullColumnHack, ContentValues initialValues, int conflictAlgorithm, String tag)
```
Replicates the [insertWithOnConflict](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#insertWithOnConflict(java.lang.String, java.lang.String, android.content.ContentValues, int)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public Cursor rawQuery(String sql, String[] selectionArgs, String tag) throws JSQLParserException, ClassCastException
```
Replicates the [rawQuery](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#rawQuery(java.lang.String, java.lang.String[])) method of the `SQLiteDatabase`.
Unlike the `rawQuery` of the `SQLiteDatabase`, there is no need to call the `moveToFirst` method of the returned `Cursor` to apply SQL query.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public Cursor rawQuery(String sql, String[] selectionArgs, CancellationSignal cancellationSignal, String tag) throws JSQLParserException, ClassCastException
```
Replicates the [rawQuery](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#rawQuery(java.lang.String, java.lang.String[], android.os.CancellationSignal)) method of the `SQLiteDatabase`.
Unlike the `rawQuery` of the `SQLiteDatabase`, there is no need to call the `moveToFirst` method of the returned `Cursor` to apply SQL query.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public void reopen(SQLiteDatabase mSqLiteDatabase)
```
Reopens the SQLite database.
**Parameters**
- *mSqLiteDatabase* the instance of the `SQLiteDatabase` to be wrapped.
```java
public void reopen(T helper)
```
Reopens the SQLite database.
**Parameters**
- *helper* the instance of the `SQLiteOpenHelper` to open a database using its [getWritableDatabase](http://developer.android.com/reference/android/database/sqlite/SQLiteOpenHelper.html#getWritableDatabase()) method.
```java
public long replace(String table, String nullColumnHack, ContentValues initialValues, String tag)
```
Replicates the [replace](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#replace(java.lang.String, java.lang.String, android.content.ContentValues)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public long replaceOrThrow(String table, String nullColumnHack, ContentValues initialValues, String tag) throws SQLException
```
Replicates the [replaceOrThrow](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#replaceOrThrow(java.lang.String, java.lang.String, android.content.ContentValues)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public int restore(String tag)
```
Restores the SQL queries to which the tag is mapped.
**Parameters**
- *tag* the tag mapped to restoring queries.
**Returns**
Possible number of restored queries to which tag is mapped.
```java
public int restore(String[] tags)
```
Restores the queries to which each tag is mapped.
**Parameters**
- *tags* an array of tags mapped to restoring SQL queries.
**Returns**
Possible number of restored queries to which tag is mapped.
```java
public int restore(Set tags)
```
Restores the queries to which each tag is mapped.
**Parameters**
- *tags* a set of tags mapped to restoring SQL queries.
**Returns**
Possible number of restored queries to which tag is mapped.
```java
public int restoreAll()
```
Restores all restoring SQL queries.
**Returns**
Possible number of restored queries to which tag is mapped.
```java
public void setTagQueryParameters(Hashtable> tagQueryParameters)
```
Changes the parameters hash table.
**Parameters**
- *tagQueryParameters* the substitute hash table.
```java
public void setTagQueryTable(Hashtable> tagQueryTable)
```
Changes the hash table.
**Parameters**
- *tagQueryTable* the substitute hash table.
```java
public Set tagSet()
```
Provides a `Set` view of the tags contained in the hash table.
**Returns**
a `Set` view of the tags contained in the hash table.
```java
public int update(String table, ContentValues values, String whereClause, String[] whereArgs, String tag)
```
Replicates the [update](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#update(java.lang.String, android.content.ContentValues, java.lang.String, java.lang.String[])) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
```java
public int updateWithOnConflict(String table, ContentValues values, String whereClause, String[] whereArgs, int conflictAlgorithm, String tag)
```
Replicates the [updateWithOnConflict](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#updateWithOnConflict(java.lang.String, android.content.ContentValues, java.lang.String, java.lang.String[], int)) method of the `SQLiteDatabase`.
**Parameters**
- *tag* the tag to be mapped to the restoring query.
**Throws**
- *IllegalArgumentException* if the tag is null.
## Dependencies
**[JSqlParser](https://github.com/JSQLParser/JSqlParser)** parses an SQL statement and translate it into a hierarchy of Java classes. JSqlParser is licensed under the LGPL V2.1.
## License
RestorableSQLiteDatabase is licensed under the MIT License.