You are on page 1of 5

9,561,225 memb ers (45,401 o n lin e)

Sign in

home

articles

quick answers

discussions

features

community

help
Next

Search fo r articles, qu estio n s, tip s

Articles Mobile Development Android General

Article Browse Code Stats Revisions (7) Alternatives

Using SQLite Database with Android


By Mina Samy, 9 Oct 2012
4.64 (44 votes)

About Article
A tutorial on using SQLite on Android Type Article CPOL 19 Oct 2010 366,371 0

Download a sample application on using database in Android from here.


Comments & Discussions (47)

Licence First Posted

Introduction
Android default Database engine is Lite. SQLite is a lightweight transactional database engine that occupies a small amount of disk storage and memory, so it's a perfect choice for creating databases on many mobile operating systems such as Android, iOS. Things to consider when dealing with SQLite: 1. Data type integrity is not maintained in SQLite, you can put a value of a certain data type in a column of another datatype (put string in an integer and vice versa). 2. Referential integrity is not maintained in SQLite, there is no FOREIGN KEY constraints or JOIN statements. 3. SQLite Full Unicode support is optional and not installed by default. In this tutorial, we will create a simple database application to store employees data. the DB has:

Views Downloads

Bookmarked 141 times Java Android Sqlite

Tables
1. Employees 2. Dept

Views
1. ViewEmps: to display employees and their relative departments.

Creating SQLite Database


By default, SQLite on Android does not have a management interface or an application to create and manage databases from, so we're going to create the database ourselves by code. First, we will create a class that handles all the operations required to deal with the database such as creating the database, creating tables, inserting and deleting records and so on. The first step is to create a class that inherits from SQLiteOpenHelper class. This class provides two methods to override to deal with the database: 1. onCreate(SQLiteDatabase db): invoked when the database is created, this is where we can create tables and columns to them, create views or triggers. 2. onUpgrade(SQLiteDatabse db, int oldVersion, int newVersion): invoked when we make a modification to the database such as altering, dropping , creating new tables. Our class will have the following members:
Co llap se | Co p y Co de

Top News
Meet Microsoft, the world's best kept R&D secret
Get the Insider News free each morning.

public class DatabaseHelper extends SQLiteOpenHelper { static static static static static static final final final final final final String String String String String String dbName="demoDB"; employeeTable="Employees"; colID="EmployeeID"; colName="EmployeeName"; colAge="Age"; colDept="Dept";

Related Articles
Using SQLite Embedded Database with Entity Framework and Linq-to-SQL Simple Text Indexer Using SQLite Database WPF and SQLite Database Upgrade framework for SQLite databases Using SQLite in your C# Application Android - Stock Market Watch (COINS) in C# using Visual Studio 2010 Updating an SQLite database CppSQLite - C++ Wrapper for SQLite Using Alerts in Android CPForAndroid and an Android Project Template SQLite Compare Utility SQLite GUI Decoding OpenGL Textures in Targa Format from an SQLite Database C# & SQLite 1007000

static final String deptTable="Dept"; static final String colDeptID="DeptID"; static final String colDeptName="DeptName"; static final String viewEmps="ViewEmps";

The Constructor
Co llap se | Co p y Co de

public DatabaseHelper(Context context) { super(context, dbName, null,33); }

The constructor of the super class has the following parameters:


Context con: The context attached to the database dataBaseName: The name of the database CursorFactory: Sometimes, we may use a class that extends the Cursor class to implement

some extra validations or operations on the queries run on the database. In this case, we pass an instance of CursorFactory to return a reference to our derived class to be used instead of the default cursor. In this example, we are going to use the standard Cursor Interface to retrieve results, so the CursorFactory parameter is going to be null.

converted by Web2PDFConvert.com

Version: the version of the schema of the database. The constructor creates a new blank

database with the specified name and version.

Creating the Database


The first superclass method to override is onCreate(SQLiteDatabase db):
Co llap se | Co p y Co de

public void onCreate(SQLiteDatabase db) { // TODO Auto-generated method stub db.execSQL("CREATE TABLE "+deptTable+" ("+colDeptID+ " INTEGER PRIMARY KEY , "+ colDeptName+ " TEXT)"); db.execSQL("CREATE TABLE "+employeeTable+" ("+colID+" INTEGER PRIMARY KEY AUTOINCREMENT, "+ colName+" TEXT, "+colAge+" Integer, "+colDept+" INTEGER NOT NULL ,FOREIGN KEY ("+colDept+") REFERENCES "+deptTable+" ("+colDeptID+"));"); db.execSQL("CREATE TRIGGER fk_empdept_deptid " + " BEFORE INSERT "+ " ON "+employeeTable+ " FOR EACH ROW BEGIN"+ " SELECT CASE WHEN ((SELECT "+colDeptID+" FROM "+deptTable+" WHERE "+colDeptID+"=new."+colDept+" ) IS NULL)"+ " THEN RAISE (ABORT,'Foreign Key Violation') END;"+ " END;"); db.execSQL("CREATE VIEW "+viewEmps+ " AS SELECT "+employeeTable+"."+colID+" AS _id,"+ " "+employeeTable+"."+colName+","+ " "+employeeTable+"."+colAge+","+ " "+deptTable+"."+colDeptName+""+ " FROM "+employeeTable+" JOIN "+deptTable+ " ON "+employeeTable+"."+colDept+" ="+deptTable+"."+colDeptID ); //Inserts pre-defined departments InsertDepts(db); }

C# & SQLite 1007000 Convert SQL Server DB to SQLite DB Porting of SQLite to BREW LinqToSQL: Comprehensive Support for SQLite, Microsoft Access, SQServer2000/2005 Android push notification implementation using ASP.NET and C# Write a Console App on Android using Java A SQLite Server/Client Implementation

The method creates tables with columns, a view and a trigger. The method is invoked when the database is created. So we create our table and specify the columns. This method is invoked when the database does not exist on the disk, its executed only once on the same device the first time the application is run on the device.

Upgrading the Database


Sometimes, we want to upgrade the database by changing the schema, add new tables or change column data types. This is done by overriding the onUpdate(SQLiteDatabase db,int old Version,int newVerison) method:
Co llap se | Co p y Co de

public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { // TODO Auto-generated method stub db.execSQL("DROP TABLE IF EXISTS "+employeeTable); db.execSQL("DROP TABLE IF EXISTS "+deptTable); db.execSQL("DROP db.execSQL("DROP db.execSQL("DROP db.execSQL("DROP onCreate(db); } TRIGGER TRIGGER TRIGGER VIEW IF IF EXISTS dept_id_trigger"); IF EXISTS dept_id_trigger22"); IF EXISTS fk_empdept_deptid"); EXISTS "+viewEmps);

This method is invoked when the version number specified in the constructor of the class changes. When you want to append a change to your database, you must change the version number in the constructor of the class. So when you pass the constructor a version number of 2:
Co llap se | Co p y Co de

public DatabaseHelper(Context context) { super(context, dbName, null,2); // TODO Auto-generated constructor stub }

instead of 1:
Co llap se | Co p y Co de

super(context, dbName, null,2);

the application understands that you want to upgrade the database and onUpgrade method will be invoked. A typical implementation of this method is to drop the tables and create them again with the additional modifications.

Managing Foreign-Key Constraints


We mentioned before that SQLite 3 by default does not support foreign key constraint, however we can force such a constraint using TRIGGERS: we will create a trigger that ensures that when a new Employee is inserted, his/her Dept value is present in the original Dept table. The SQL statement to create such a trigger would be like this:
Co llap se | Co p y Co de

CREATE TRIGGER fk_empdept_deptid Before INSERT ON Employees FOR EACH ROW BEGIN SELECT CASE WHEN ((SELECT DeptID FROM Dept WHERE DeptID =new.Dept ) IS NULL) THEN RAISE (ABORT,'Foreign Key Violation') END; END

In onCreate method, we created this trigger like this:


Co llap se | Co p y Co de

db.execSQL("CREATE TRIGGER fk_empdept_deptid " + " BEFORE INSERT "+ " ON "+employeeTable+ " FOR EACH ROW BEGIN"+ " SELECT CASE WHEN ((SELECT "+colDeptID+" FROM "+deptTable+" _ WHERE "+colDeptID+"=new."+colDept+" ) IS NULL)"+ " THEN RAISE (ABORT,'Foreign Key Violation') END;"+ " END;");

UPDATE: you can force referential integrity by enabling foreign keys in your database by overriding onOpen

converted by Web2PDFConvert.com

method like this:


Co llap se | Co p y Co de

@Override public void onOpen(SQLiteDatabase db) { super.onOpen(db); if (!db.isReadOnly()) { // Enable foreign key constraints db.execSQL("PRAGMA foreign_keys=ON;"); } }

Executing SQL Statements


Now let's begin executing basic SQL statements. You can execute any SQL statement that is not a query whether it is insert, delete, update or anything using db.execSQL(String statement) method like when we did when creating the database tables:
Co llap se | Co p y Co de

db.execSQL("CREATE TABLE "+deptTable+" ("+colDeptID+ " INTEGER PRIMARY KEY , "+ colDeptName+ " TEXT)");

Inserting Records
We insert records to the database using the following code for example to insert records in the Dept table:
Co llap se | Co p y Co de

SQLiteDatabase db=this.getWritableDatabase(); ContentValues cv=new ContentValues(); cv.put(colDeptID, 1); cv.put(colDeptName, "Sales"); db.insert(deptTable, colDeptID, cv); cv.put(colDeptID, 2); cv.put(colDeptName, "IT"); db.insert(deptTable, colDeptID, cv); db.close();

Notice that we need to call this.getWritableDatabase() to open the connection with the database for reading/writing. The ContentValues.put has two parameters: Column Name and the value to be inserted. Also, it is a good practice to close the database after executing statements.

Updating Values
To execute an update statement, we have two ways: 1. To execute db.execSQL 2. To execute db.update method:
Co llap se | Co p y Co de

public int UpdateEmp(Employee emp) { SQLiteDatabase db=this.getWritableDatabase(); ContentValues cv=new ContentValues(); cv.put(colName, emp.getName()); cv.put(colAge, emp.getAge()); cv.put(colDept, emp.getDept()); return db.update(employeeTable, cv, colID+"=?", new String []{String.valueOf(emp.getID())}); }

The update method has the following parameters: 1. 2. 3. 4.


String Table: The table to update a value in ContentValues cv: The content values object that has the new values String where clause: The WHERE clause to specify which record to update String[] args: The arguments of the WHERE clause

Deleting Rows
As in update to execute a delete statement, we have two ways: 1. To execute db.execSQL 2. To execute db.delete method:
Co llap se | Co p y Co de

public void DeleteEmp(Employee emp) { SQLiteDatabase db=this.getWritableDatabase(); db.delete(employeeTable,colID+"=?", new String [] {String.valueOf(emp.getID())}); db.close(); }

The delete method has the same parameters as the update method.

Executing Queries
To execute queries, there are two methods: 1. Execute db.rawQuery method 2. Execute db.query method To execute a raw query to retrieve all departments:
Co llap se | Co p y Co de

Cursor getAllDepts() { SQLiteDatabase db=this.getReadableDatabase(); Cursor cur=db.rawQuery("SELECT "+colDeptID+" as _id, "+colDeptName+" from "+deptTable,new String [] {}); return cur; }

The rawQuery method has two parameters: 1. String query: The select statement 2. String[] selection args: The arguments if a WHERE clause is included in the select statement Notes 1. The result of a query is returned in Cursor object. 2. In a select statement if the primary key column (the id column) of the table has a name other than _id, then you have to use an alias in the form SELECT [Column Name] as _id cause the

converted by Web2PDFConvert.com

Cursor object always expects that the primary key column has the name _id or it will throw an

exception . Another way to perform a query is to use a db.query method. A query to select all employees in a certain department from a view would be like this:
Co llap se | Co p y Co de

public Cursor getEmpByDept(String Dept) { SQLiteDatabase db=this.getReadableDatabase(); String [] columns=new String[]{"_id",colName,colAge,colDeptName}; Cursor c=db.query(viewEmps, columns, colDeptName+"=?", new String[]{Dept}, null, null, null); return c; }

The db.query has the following parameters: 1. 2. 3. 4. 5. 6. 7.


String String String String String String String Table Name: The name of the table to run the query against [ ] columns: The projection of the query, i.e., the columns to retrieve WHERE clause: where clause, if none pass null [ ] selection args: The parameters of the WHERE clause Group by: A string specifying group by clause Having: A string specifying HAVING clause Order By by: A string Order By by clause

Managing Cursors
Result sets of queries are returned in Cursor objects. There are some common methods that you will use with cursors: 1. boolean moveToNext(): moves the cursor by one record in the result set, returns false if moved past the last row in the result set. 2. boolean moveToFirst(): moves the cursor to the first row in the result set, returns false if the result set is empty. 3. boolean moveToPosition(int position): moves the cursor to a certain row index within the boolean result set, returns false if the position is un-reachable 4. boolean moveToPrevious(): moves the cursor to the previous row in the result set, returns false if the cursor is past the first row. 5. boolean moveToLast(): moves the cursor to the lase row in the result set, returns false if the result set is empty. There are also some useful methods to check the position of a cursor: boolean isAfterLast(), isBeforeFirst, isFirst, isLast and isNull(columnIndex). Also if you have a result set of only one row and you need to retrieve values of certain columns, you can do it like this:
Co llap se | Co p y Co de

public int GetDeptID(String Dept) { SQLiteDatabase db=this.getReadableDatabase(); Cursor c=db.query(deptTable, new String[]{colDeptID+" as _id",colDeptName}, colDeptName+"=?", new String[]{Dept}, null, null, null); //Cursor c=db.rawQuery("SELECT "+colDeptID+" as _id FROM "+deptTable+" //WHERE "+colDeptName+"=?", new String []{Dept}); c.moveToFirst(); return c.getInt(c.getColumnIndex("_id")); }

We have Cursor.getColumnIndex(String ColumnName) to get the index of a column. Then to get the value of a certain column, we have Cursor.getInt(int ColumnIndex) method. Also there are getShort, getString, getDouble, getBlob to return the value as a byte array. It's a good practice to close() the cursor after using it. Download a sample application on using database in Android from here. More tutorials can be found on my blog at http://android-pro.blogspot.com.

License
This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Mina Samy
Software Developer Symbyo Technologies Egypt Member No Biography provided

Article Top

Like

31

Sign Up to vote Poor


Tweet 21

Excellent Vote

20

Comments and Discussions


Hint: For improved responsiveness ensure Javascript is enabled and choose 'Normal' from the Layout dropdown and hit 'Update'. You must Sign In to use this message board. Search this forum Profile popups Spacing Relaxed Noise Ver y High Layout No rmal
10

Go Per page Update First Prev Next

converted by Web2PDFConvert.com

My vote of 4 [My vote of 1] Download [My vote of 2] 5 for the article and 1 for the download Re: [My vote of 2] 5 for the article and 1 for the download My vote of 5 My vote of 3 ?? My vote of 1 Re: My vote of 1 Good One
Last Visit: 18:00 31 Dec '99 Last Update: 13:39 7 Jan '13 General
Permalin k | Advertise | Privacy | Mo b ile W eb 03 | 2.6.130102.4 | Last U p dated 10 O ct 2012

AymHenr y Earl Allen snoopy001

7:16 15 Nov '12 22:25 15 Oct '12 0:41 11 Oct '12

Mina Samy

1:47 11 Oct '12

URVISH_SUTHAR azhar41 hikarushi gauravchandigarh1 Harr y Neethling hariharasudhan chandramurthy Refresh Bug Answer Joke

20:16 10 Oct '12 0:30 4 Oct '12 9:15 12 Sep '12 23:42 25 Aug '12 2:14 17 Sep '12 5:50 21 Aug '12

1 2 3 4 5 Next Rant Admin


Article Co p yrigh t 2010 b y Min a Samy Ever yth in g else Co p yrigh t Co dePro ject, 1999-2013 Terms o f U se

News

Suggestion

Question

Layo u t: fixed | flu id

converted by Web2PDFConvert.com