Lesson 13 Persistence: SQL Databases Victor Matos Cleveland State - - PDF document

Lesson 13

Lesson 13 Persistence: SQL Databases

Victor Matos Cleveland State University

Portions of this page are reproduced from work created and shared by Google and used according to terms described in the Creative Commons 3.0 Attribution License.

Included into the core Android architecture there is an standalone Database Management System (DBMS) called SQLite which can be used to: Create a database

SQL Databases

Using SQL databases in Andorid

Create a database, Define SQL tables, indices, queries, views, triggers I t

13 ‐2

Insert rows, Delete rows, Change rows, Run queries and Administer a SQLite database file.

Lesson 13

• Transactional SQL database engine.
• Small footprint (less than 400KBytes)
• Typeless

S l

SQL Databases

Characteristics of SQLite

• Serverless
• Zero‐configuration
• The source code for SQLite is in the public domain.
• According to their website, SQLite is the most widely deployed SQL

database engine in the world .

Reference: http://sqlite.org/index.html

13 ‐3

1. SQLite implements most of the SQL‐92 standard for SQL. 2. It has partial support for triggers and allows complex queries (exceptions include: right/full outer joins, grant/revoke, updatable views).

SQL Databases

Characteristics of SQLite

3. SQLITE does not implement referential integrity constraints through the foreign key constraint model. 4. SQLite uses a relaxed data typing model. 5. Instead of assigning a type to an entire column, types are assigned to individual values (this is similar to the Variant type in Visual Basic). 6. There is no data type checking, therefore it is possible to insert a string 6. There is no data type checking, therefore it is possible to insert a string into numeric column and so on.

Documentation on SQLITE available at http://www.sqlite.org/sqlite.html GUI tools for SQLITE: SQL Administrator http://sqliteadmin.orbmu2k.de/ SQL Expert http://www.sqliteexpert.com/download.html

13 ‐4

Lesson 13

SQL Databases

Creating a SQLite database ‐ Method 1

SQLiteDatabase.openDatabase( myDbPath, null, SQLiteDatabase.CREATE_IF_NECESSARY);

If the database does not exist then create a new one. Otherwise, open the existing database according to the flags: OPEN_READWRITE, OPEN_READONLY, CREATE_IF_NECESSARY . Parameters path to database file to open and/or create factory an optional factory class that is called to instantiate a cursor when factory an optional factory class that is called to instantiate a cursor when query is called, or null for default flags to control database access mode Returns the newly opened database Throws SQLiteException if the database cannot be opened

13 ‐5 package cis470.matos.sqldatabases; public class MainActivity extends Activity { SQLiteDatabase db; @Override public void onCreate(Bundle savedInstanceState) {

Example1: Creating a SQLite database ‐ Method 1

SQL Databases

super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); TextView txtMsg = (TextView) findViewById(R.id.txtMsg); // path to the external SD card (something like: /storage/sdcard/...) // String storagePath = Environment.getExternalStorageDirectory().getPath(); // path to internal memory file system (data/data/cis470.matos.databases) File storagePath = getApplication().getFilesDir(); String myDbPath = storagePath + "/" + "myfriends"; txtMsg.setText("DB Path: " + myDbPath); try { try { db = SQLiteDatabase.openDatabase(myDbPath, null, SQLiteDatabase.CREATE_IF_NECESSARY); // here you do something with your database ... db.close(); txtMsg.append("\nAll done!"); } catch (SQLiteException e) { txtMsg.append("\nERROR " + e.getMessage()); } }// onCreate }// class 13 ‐6

Lesson 13

SQLite Database is stored using Internal Memory Example1: Creating a SQLite database ‐ Using Memory

SQL Databases

Path: /data/data/cis470.matos.sqldatabases/ Where: cis470.matos.sqldatabases is the package’s name

13 ‐7

Using:

SQLiteDatabase db; String SDcardPath = Environment

Example1: Creating a SQLite database on the SD card

SQL Databases

.getExternalStorageDirectory() .getPath() + "/myfriends"; db = SQLiteDatabase.openDatabase(

SDcardPath,

null, SQLiteDatabase.CREATE_IF_NECESSARY );

Manifest must include:

<uses‐permission android:name= "android.permission.WRITE_EXTERNAL_STORAGE" /> <uses‐permission android:name= "android.permission.READ_EXTERNAL_STORAGE" />

13 ‐8

Lesson 13

Warning

• Databases created in the internal /data/data/package space

Sharing Limitations

SQL Databases

are private to that package.

• You cannot access internal databases belonging to other people

(instead use Content Providers or external SD resident DBs).

• SD stored databases are public.
• Access to an SD resident database requires the Manifest to include

permissions:

<uses‐permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> <uses‐permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

NOTE: SQLITE (as well as most DBMSs) is not case sensitive.

13 ‐9

An alternative way of opening/creating a SQLITE database in your local Android’s internal data space is given below

SQLit D t b db thi O C t D t b (

An Alternative Method: openOrCreateDatabase

SQL Databases

SQLiteDatabase db = this.openOrCreateDatabase( "myfriendsDB", MODE_PRIVATE, null);

Assume this app is made in a namespace called cis470.matos.sqldatabases, then the full name of the newly created database file will be: /data/data/cis470.matos.sqldatabases/myfriendsDB

Internal Memory Package name DB name

• The file can be accessed by all components of the same application.
• Other MODE values: MODE_WORLD_READABLE, and

MODE_WORLD_WRITEABLE were deprecated on API Level 17.

• null refers to optional factory class parameter (skip for now)

13 ‐10

Lesson 13

Once created, the SQLite database is ready for normal operations such as: creating, altering, dropping resources (tables, indices, triggers, views, queries ) d i i i d b ( i )

Type of SQL Commands

SQL Databases

etc.) or administrating database resources (containers, users, …). Action queries and Retrieval queries represent the most common operations against the database.

• A retrieval query is typically a SQL‐Select command in which a table

holding a number of fields and rows is produced as an answer to a data request. request.

• An action query usually performs maintenance and administrative tasks

such as manipulating tables, users, environment, etc.

13 ‐11

Transactions are desirable because they help maintaining consistent data and prevent unwanted data losses due to abnormal termination of execution.

Transaction Processing

SQL Databases

In general it is convenient to process action queries inside the protective frame of a database transaction in which the policy of “complete success or total failure” is transparently enforced. This notion is called: atomicity to reflect that all parts of a method are fused in an indivisible ‘statement’.

13 ‐12

Lesson 13

The typical Android’s way of running transactions on a SQLiteDatabase is illustrated by the following code fragment (Assume db is a SQLiteDatabase)

db.beginTransaction();

Transaction Processing

SQL Databases

try { //perform your database operations here ... db.setTransactionSuccessful(); //commit your changes } catch (SQLiteException e) { //report problem } finally { db.endTransaction(); }

The transaction is defined between the methods: beginTransaction and

• endTransaction. You need to issue the setTransactionSuccessful()call to

commit any changes. The absence of it provokes an implicit rollback

• peration; consequently the database is reset to the state previous to the

beginning of the transaction

13 ‐13

The SQL syntax used for creating and populating a table is illustrated in the following examples

Create and Populate a SQL Table

SQL Databases

create table tblAMIGO ( recID integer PRIMARY KEY autoincrement, name text, phone text ); insert into tblAMIGO(name, phone) values ('AAA', '555‐1111' ); The autoincrement value for recID is NOT supplied in the insert statement as it is internally assigned by the DBMS.

13 ‐14

Lesson 13

• Our Android app will use the execSQL(…) method to manipulate SQL

action queries. The example below creates a new table called tblAmigo.

• The table has three fields: a numeric unique identifier called recID, and

t t i fi ld ti f i d’ d h

Example 2. Create and Populate a SQL Table

SQL Databases

two string fields representing our friend’s name and phone.

• If a table with such a name exists it is first dropped and then created

again.

• Finally three rows are inserted in the table.

Note: For presentation economy we do not show the entire code which should include a transaction frame.

db.execSQL("create table tblAMIGO (" + " recID integer PRIMARY KEY autoincrement " + recID integer PRIMARY KEY autoincrement, + " name text, " + " phone text ); " ); db.execSQL( "insert into tblAMIGO(name, phone) values ('AAA', '555‐1111');" ); db.execSQL( "insert into tblAMIGO(name, phone) values ('BBB', '555‐2222');" ); db.execSQL( "insert into tblAMIGO(name, phone) values ('CCC', '555‐3333');" );

13 ‐15

• After executing the previous code snippet, we transfered the database to

the developer’s file system and used the SQL‐ADMINISTRATION tool.

• There we submitted the SQL‐Query: select * from tblAmigo.

R lt h b l

Example 2. Create and Populate a SQL Table

SQL Databases

• Results are shown below.

13 ‐16

Lesson 13

Comments 1. The field recID is defined as the table’s PRIMARY KEY. 2 Th “ t i t” f t t th t h d ill b

Example 2. Create and Populate a SQL Table

SQL Databases

2. The “autoincrement” feature guarantees that each new record will be given a unique serial number (0,1,2,…). 3. On par with other SQL systems, SQLite offers the data types: text, varchar, integer, float, numeric, date, time, timestamp, blob, boolean. 3. In general any well‐formed DML SQL action command (insert, delete, update, create, drop, alter, etc.) could be framed , p , , p, , ) inside an execSQL( . . . ) method call. Caution: You should call the execSQL method inside of a try‐catch‐finally block. Be aware of potential SQLiteException conflicts thrown by the method.

13 ‐17

User defined fields

NOTE

Example 2. Create and Populate a SQL Table

SQL Databases

RowID 1 2 3 4

NOTE:

SQLITE uses an invisible field called ROWID to uniquely identify each row in each table. Consequently in our example the field recID and the database ROWID are functionally similar. 5

13 ‐18

Lesson 13

Asking Questions ‐ SQL Queries

SQL Databases

1. Retrieval queries are known as SQL‐select statements. 2. Answers produced by retrieval queries are always held in a table. Android‐SQLite offers two strategies for phrasing select statements: rawQueries and simple queries. Both return a database cursor. 3. In order to process the resulting table rows, the user should provide a cursor device. Cursors allow a row‐at‐ the‐time access mechanism on SQL tables. 1. Raw queries take for input any (syntactically correct) SQL‐select

• statement. The select query could be as complex as needed and involve

any number of tables (only a few exceptions such as outer‐joins) 2. Simple queries are compact parametized lookup functions that operate

• n a single table (for developers who prefer not to use SQL).

13 ‐19

select field1, field2, … , fieldn from table1, table2, … , tablen

SQL Select Statement – Syntax

http://www.sqlite.org/lang.html

SQL Databases

where ( restriction‐join‐conditions )

• rder by

fieldn1, …, fieldnm group by fieldm1, … , fieldmk having (group‐condition) The first two lines are mandatory, the rest is optional.

1. The select clause indicates the fields to be included in the answer 2. The from clause lists the tables used in obtaining the answer 3. The where component states the conditions that records must satisfy in order to be included in the output. 4. Order by tells the sorted sequence on which output rows will be presented 5. Group by is used to partition the tables and create sub‐groups 6. Having formulates a condition that sub‐groups made by partitioning need to satisfy.

13 ‐20

Lesson 13

SELECT LastName, cellPhone

Two Examples of SQL‐Select Statements

SQL Databases

Example A. FROM ClientTable WHERE state = ‘Ohio’ ORDER BY LastName Example B. SELECT city, count(*) as TotalClients FROM ClientTable GROUP BY city

13 ‐21

• Example3. Using a Parameterless RawQuery

(version 1)

SQL Databases

Consider the following code fragment

Cursor c1 = db.rawQuery("select * from tblAMIGO", null);

1. The previous rawQuery contains a select‐statement that retrieves all the rows (and all the columns) stored in the table tblAMIGO. The resulting table is wrapped by a Cursor object c1. 2. The ‘select *’ clause instructs SQL to grab all‐columns held in a row. 3. Cursor c1 will be used to traverse the rows of the resulting table. 4. Fetching a row using cursor c1 requires advancing to the next record in the answer set (cursors are explained a little later in this section). 5. Fields provided by SQL must be bound to local Java variables (soon we will see to that).

13 ‐22

Lesson 13

Passing arguments.

Assume we want to count how many friends are there whose name is ‘BBB’ and their recID > 1. We could use the following solution:

• Example3. Using a Parametized RawQuery

(version 2)

SQL Databases

String mySQL = "select count(*) as Total " + " from tblAmigo " + " where recID > ? " + " and name = ? "; String[] args = {"1", "BBB"}; Cursor c1 = db rawQuery(mySQL args); Cursor c1 = db.rawQuery(mySQL, args);

The various symbols ‘?’ in the SQL statement represent positional

• placeholders. When .rawQuery() is called, the system binds each empty

placeholder ‘?’ with the supplied args‐value. Here the first ‘?’ will be replaced by “1” and the second by “BBB”.

13 ‐23

As in the previous example, assume we want to count how many friends are there whose name is ‘BBB’ and their recID > 1. We could use the following solution:

• Example3. Using a Stitched RawQuery

(version 3)

SQL Databases

String[] args = {"1", "BBB"}; String mySQL = " select count(*) as Total " + " from tblAmigo " + " where recID > " + args[0] + " and name = '" + args[1] + "'"; Cursor c1 = db rawQuery(mySQL null); Cursor c1 db.rawQuery(mySQL, null);

Instead of the symbols ‘?’ acting as placeholder, we conveniently concatenate the necessary data fragments during the assembling of our SQL statement.

13 ‐24

Lesson 13

Cursors are used to gain sequential & random access to tables produced by SQL select statements. C t t th ti ti t bl

SQL Cursors

SQL Databases

Cursors support one row‐at‐the‐time operations on a table. Although in some DBMS systems cursors can be used to update the underlying dataset, the SQLite version of cursors is read‐only. Cursors include several types of operators, among them: 1. Positional awareness: isFirst(), isLast(), isBeforeFirst(), isAfterLast(). 2 R d i i T Fi () T L () T N () 2. Record navigation: moveToFirst(), moveToLast(), moveToNext(), moveToPrevious(), move(n). 3. Field extraction: getInt, getString, getFloat, getBlob, getDouble, etc. 4. Schema inspection: getColumnName(), getColumnNames(), getColumnIndex(), getColumnCount(), getCount().

13 ‐25

String sql = "select * from tblAmigo"; Cursor c1 = db.rawQuery(sql, null); c1.moveToPosition(‐1);

SQL Databases

1 2

Example 4A. Traversing a Cursor – Simple Case

1 of 1

while ( c1.moveToNext() ){ int recId = c1.getInt(0); String name = c1.getString(1); String phone = c1.getString(c1.getColumnIndex("phone")); // do something with the record here... }

• 1. Prepare a rawQuery passing a simple sql statement with no arguments, catch the

resulting tuples in cursor c1.

• 2. Move the fetch marker to the absolute position prior to the first row in the file.

The valid range of values is ‐1 <= position <= count.

• 3. Use moveToNext() to visit each row in the result set

13 ‐26

Lesson 13

private String showCursor( Cursor cursor) { // reset cursor's top (before first row) cursor.moveToPosition(‐1); String cursorData = "\nCursor: [";

SQL Databases

1

Example 4B. Traversing a Cursor – Enhanced Navigation

1 of 2

try { // get SCHEMA (column names & types) String[] colName = cursor.getColumnNames(); for(int i=0; i<colName.length; i++){ String dataType = getColumnType(cursor, i); cursorData += colName[i] + dataType; if (i<colName.length‐1){ cursorData+= ", "; } } 2 } } catch (Exception e) { Log.e( "<<SCHEMA>>" , e.getMessage() ); } cursorData += "]"; // now get the rows cursor.moveToPosition(‐1); //reset cursor's top

13 ‐27

while (cursor.moveToNext()) { String cursorRow = "\n["; for (int i = 0; i < cursor.getColumnCount(); i++) { cursorRow += cursor.getString(i); if (i<cursor.getColumnCount()‐1)

SQL Databases

3 4

Example 4B. Traversing a Cursor – Enhanced Navigation

2 of 2

( <cu so .getCo u Cou t() ) cursorRow += ", "; } cursorData += cursorRow + "]"; } return cursorData + "\n"; } private String getColumnType(Cursor cursor, int i) { try { //peek at a row holding valid data cursor moveToFirst(); 5 cursor.moveToFirst(); int result = cursor.getType(i); String[] types = {":NULL", ":INT", ":FLOAT", ":STR", ":BLOB", ":UNK" }; //backtrack ‐ reset cursor's top cursor.moveToPosition(‐1); return types[result]; } catch (Exception e) { return " "; } }

13 ‐28

Lesson 13

1. The method: showCursor( Cursor cursor ) implements the process of visiting individual rows retrieved by a SQL statement. The argument cursor, is a wrapper around the SQL resultset. For example, you may t d i t t t h

Comments Example 4B – Enhanced Navigation

SQL Databases

assume cursor was created using a statement such as:

Cursor cursor = db.rawQuery("select * from tblAMIGO", null);

2. The database schema for tblAmigo consists of the attributes: recID, name, and phone. The method getColumnNames() provides the schema. 3. The method moveToNext forces the cursor to travel from its current position to the next available row. p 4. The accessor .getString is used as a convenient way of extracting SQL fields without paying much attention to the actual data type of the fields. 5. The function .getColumnType() provides the data type of the current field (0:null, 1:int, 2:float, 3:string, 4:blob)

13 ‐29

Simple SQLite queries use a template oriented schema whose goal is to ‘help’ non‐SQL developers in their process of querying a database. Thi t l t ll th t f b i SQL l t t t t

SQLite Simple Queries ‐ Template Based Queries

SQL Databases

This template exposes all the components of a basic SQL‐select statement. Simple queries can only retrieve data from a single table. The method’s signature has a fixed sequence of seven arguments representing: 1. the table name, , 2. the columns to be retrieved, 3. the search condition (where‐clause), 4. arguments for the where‐clause, 5. the group‐by clause, 6. having‐clause, and 7. the order‐by clause.

13 ‐30

Lesson 13

The signature of the SQLite simple .query method is:

SQLite Simple Queries ‐ Template Based Queries

SQL Databases

db query ( String table db.query ( String table, String[] columns, String selection, String[] selectionArgs, String groupBy, String having, String

• rderBy )

13 ‐31

Assume we need to consult an EmployeeTable (see next Figure) and find the average salary of female employees supervised by emp. 123456789. Each

• utput row consists of Dept. No, and ladies‐average‐salary value. Our output

h ld li t th hi h t fi t th th d d D t i l d

• Example5. SQLite Simple Queries

SQL Databases

should list the highest average first, then the second, and so on. Do not include

• depts. having less than two employees.

String[] columns = {"Dno", "Avg(Salary) as AVG"}; String[] conditionArgs = {"F", "123456789"}; Cursor c = db.query ("EmployeeTable", columns ← table name ← ouput columns columns, "sex = ? And superSsn = ? ", conditionArgs, "Dno", "Count(*) > 2", "AVG Desc " ); ← ouput columns ← condition ← condition‐args ← group by ← having ← order by

13 ‐32

Lesson 13

This is a representation of the EmployeeTable used in the

• Example5. SQLite Simple Queries

SQL Databases

p y previous example. It contains: first name, initial, last name, SSN, birthdate, address, sex, salary, supervisor’s SSN, and department number.

13 ‐33

In this example we use the tblAmigo table. We are interested in selecting the columns: recID, name, and phone. The condition to be met is that RecID must be greater than 2, and names must begin with ‘B’ and have three or more l tt

• Example6. SQLite Simple Queries

SQL Databases

letters.

String [] columns = {"recID", "name", "phone"}; Cursor c1 = db.query ( "tblAMIGO", columns, "recID > 2 and length(name) >= 3 and name like 'B%' ", null, null, null, , , , "recID" ); int recRetrieved = c1.getCount();

We enter null in each component not supplied to the method. For instance, in this example select‐args, having, and group‐by are not used.

13 ‐34

Lesson 13

In this example we will construct a more complex SQL select statement. We are interested in tallying how many groups of friends whose recID > 3 h th I dditi t t ‘ ’ h i

• Example7. SQLite Simple Queries

SQL Databases

have the same name. In addition, we want to see ‘name’ groups having no more than four people each. A possible SQL‐select statement for this query would be something like:

select name, count(*) as TotalSubGroup from tblAMIGO where recID > 3 group by name group by name having count(*) <= 4;

13 ‐35

An equivalent Android‐SQLite solution using a simple template query follows.

• Example7. SQLite Simple Queries

SQL Databases

String [] selectColumns = {"name", "count(*) as TotalSubGroup"}; String whereCondition = "recID > ? ";

1 2

String [] whereConditionArgs = {"3"}; String groupBy = "name"; String having = "count(*) <= 4"; String orderBy = "name"; Cursor cursor = db.query ( "tblAMIGO", selectColumns, whereCondition, hereConditionArgs

3

whereConditionArgs, groupBy, having,

• rederBy );

13 ‐36

Lesson 13

Observations 1. The selectColumns string array contains the output fields. One of them (name) is already part of the table, while TotalSubGroup is an alias for the t d t f h b

• Example7. SQLite Simple Queries

SQL Databases

computed count of each name sub‐group. 2. The symbol ? in the whereCondition is a place‐marker for a substitution. The value “3” taken from the whereConditionArgs is to be injected there. 3. The groupBy clause uses ‘name’ as a key to create sub‐groups of rows with the same name value. The having clause makes sure we only choose subgroups no larger than four people. g p g p p

13 ‐37

Action queries are the SQL way of performing maintenance operations on tables and database resources. Example of action‐queries include: insert, delete, update, create table, drop, etc.

SQL Action Queries

SQL Databases

insert into tblAmigos values ( ‘Macarena’, ‘555‐1234’ ); update tblAmigos set name = ‘Maria Macarena’ where phone = ‘555‐1234’;

Examples:

delete from tblAmigos where phone = ‘555‐1234’; create table Temp ( column1 int, column2 text, column3 date ); drop table Temp;

13 ‐38

Lesson 13

Perhaps the simplest Android way to phrase a SQL action query is to ‘stitch’ together the pieces of the SQL statement and give it to the easy to use –but rather limited‐ execSQL(…) method.

SQLite Action Queries Using: ExecSQL

SQL Databases

Unfortunately SQLite execSQL does NOT return any data. Therefore knowing how many records were affected by the action is not possible with this

• perator. Instead you should use the Android versions describe in the next

section.

db.execSQL( "update tblAMIGO set name = (name || 'XXX') where phone >= '555‐1111' ");

This statement appends ‘XXX’ to the name of those whose phone number is equal or greater than ‘555‐1111’. Note The symbol || is the SQL concatenate operator

13 ‐39

Alternatively, the SQL action‐statement used in ExecSQL could be ‘pasted’ from pieces as follows:

SQLite Action Queries Using: ExecSQL

• cont. 1

SQL Databases

String theValue = " "; The same strategy could be applied to other SQL action‐statements such as: String theValue = … ; db.execSQL( "update tblAMIGO set name = (name || 'XXX') " + " where phone >= '" + theValue + "' " ); “delete from … where…”, “insert into ….values…”, etc.

13 ‐40

Lesson 13

• Android provides a number of additional methods to perform insert,

delete, update operations.

• They all return some feedback data such as the record ID of a recently

i t d b f d ff t d b th ti Thi f t i

Android’s INSERT, DELETE, UPDATE Operators

SQL Databases

public long insert(String table, String nullColumnHack, ContentValues values ) public int update(String table, ContentValues values,

inserted row, or number of records affected by the action. This format is recommended as a better alternative than execSQL.

, String whereClause, String[] whereArgs ) public int delete(String table, String whereClause, String[] whereArgs)

13 ‐41

• This class is used to store a set of [name, value] pairs (functionally

equivalent to Bundles). Wh d i bi ti ith SQLit C t tV l bj t i j t

ContentValues Class

SQL Databases

• When used in combination with SQLite, a ContentValues object is just a

convenient way of passing a variable number of parameters to the SQLite action functions.

• Like bundles, this class supports a group of put/get methods to move

data in/out of the container. myArgs

ContentValues myArgs= new ContentValues(); myArgs.put("name", "ABC"); myArgs.put("phone", "555‐7777"); Key Value name ABC phone 555‐7777

13 ‐42

Lesson 13

The method tries to insert a row in a table The row’s column‐values are

Android’s INSERT Operation

SQL Databases

public long insert(String table, String nullColumnHack, ContentValues values)

table the table on which data is to be inserted nullColumnHack Empty and Null are different things. For instance, values could be defined but empty. If the row to be inserted is empty (as in our

The method tries to insert a row in a table. The row s column‐values are supplied in the map called values. If successful, the method returns the rowID given to the new record, otherwise ‐1 is sent back.

Parameters

next example) this column will explicitly be assigned a NULL value (which is OK for the insertion to proceed). values Similar to a bundle (name, value) containing the column values for the row that is to be inserted.

13 ‐43

ContentValues rowValues= new ContentValues(); rowValues.put("name", "ABC");

Android’s INSERT Operation

1

SQL Databases

p ( , ); rowValues.put("phone", "555‐1010"); long rowPosition = db.insert("tblAMIGO", null, rowValues); rowValues.put("name", "DEF"); rowValues.put("phone", "555‐2020"); rowPosition = db.insert("tblAMIGO", null, rowValues); rowValues.clear(); iti db i t("tbl GO" ll l )

2 3 4

rowPosition = db.insert("tblAMIGO", null, rowValues); rowPosition = db.insert("tblAMIGO", "name", rowValues);

5 6

13 ‐44

Lesson 13

Comments

1. A set of <key, values> called rowValues is creted and supplied to the insert() method to be added to tblAmigo. Each tblAmigo row consists of

Android’s INSERT Operation

SQL Databases

the columns: recID, name, phone. Remember that recID is an auto‐ incremented field, its actual value is to be determined later by the database when the record is accepted. 2. The newly inserted record returns its rowID (4 in this example) 3. A second records is assembled and sent to the insert() method for insertion in tblAmigo. After it is collocated, it returns its rowID (5 in this example). 4 The rowValues map is reset therefore rowValues which is not null 4. The rowValues map is reset, therefore rowValues which is not null becomes empty. 5. SQLite rejects attempts to insert an empty record returning rowID ‐1. 6. The second argument identifies a column in the database that allows NULL values (NAME in this case). Now SQL purposely inserts a NULL value on that column (as well as in other fields, except the key RecId) and the insertion successfully completes.

13 ‐45

The method tries to update row(s) in a table The SQL set column=newvalue

Android’s UPDATE Operation

SQL Databases

public int update ( String table, ContentValues values, String whereClause, String[] whereArgs )

table the table on which data is to be updated l Similar to a bundle (name, value) containing the columnName

The method tries to update row(s) in a table. The SQL set column=newvalue clause is supplied in the values map in the form of [key,value] pairs. The method returns the number of records affected by the action.

Parameters

values ( , ) g and NewValue for the fields in a row that need to be updated. whereClause This is the condition identifying the rows to be updated. For instance “name = ? “ where ? Is a placeholder. Passing null updates the entire table. whereArgs Data to replace ? placeholders defined in the whereClause.

13 ‐46

Lesson 13

Example

We want to use the .update() method to express the following SQL statement:

Android’s UPDATE Operation

SQL Databases

Update tblAmigo set name = ‘maria’ where (recID > 2 and recID < 7)

String [] whereArgs = {"2", "7"}; ContentValues updValues = new ContentValues(); updValues.put("name", "Maria");

Here are the steps to make the call using Android’s equivalent Update Method p g ( )

1 2

p p ( , ) int recAffected = db.update( "tblAMIGO", updValues, "recID > ? and recID < ?", whereArgs );

3

13 ‐47

Comments

1. Our whereArgs is an array of arguments. Those actual values will replace the placeholders ‘?’ set in the whereClause.

Android’s UPDATE Operation

SQL Databases

2. The map updValues is defined and populated. In our case, once a record is selected for modifications, its “name” field will changed to the new value “maria”. 3. The db.update() method attempts to update all records in the given table that satisfy the filtering condition set by the whereClause. After completion it returns the number of records affected by the update (0 If completion it returns the number of records affected by the update (0 If it fails). 4. The update filter verifies that "recID > ? and recID < ? ". After the args substitutions are made the new filter becomes: "recID > 2 and recID < 7".

13 ‐48

Lesson 13

The method is called to delete rows in a table. A filtering condition and its

Android’s DELETE Operation

SQL Databases

public int delete ( String table, String whereClause, String[] whereArgs )

table the table on which data is to be deleted This is the condition identifying the records to be deleted. For

g arguments are supplied in the call. The condition identifies the rows to be

• deleted. The method returns the number of records affected by the action.

Parameters

whereClause instance “name = ? “ where ? Is a placeholder. Passing null deletes all the rows in the table. whereArgs Data to replace ‘?’ placeholders defined in the whereClause.

13 ‐49

Example

Consider the following SQL statement:

Android’s DELETE Operation

SQL Databases

Delete from tblAmigo wehere recID > 2 and recID < 7 An equivalent implementation using the Androi’d delete method follows:

String [] whereArgs = {"2", "7"}; int recAffected = db.delete("tblAMIGO", "recID > ? and recID < ?",

Delete from tblAmigo wehere recID > 2 and recID < 7 A record should be deleted if its recID is in between the values 2, and 7. The actual values are taken from the whereArgs array. The method returns the number of rows removed after executing the command (or 0 if none).

whereArgs);

13 ‐50

Lesson 13

1. Any Application can access a database externally stored in the device’s SD. All it’s needed is k l d f th th h

Database Visibility

SQL Databases

App‐1 App‐3

knowledge of the path where the database file is located (arguable, this is an opened door to security problems). 2. Databases created privately inside the application’s process space cannot be shared (however they consume

SD card Database1 Database2 App‐4

( y precious memory resources) 3. Other ways of sharing data will be explored later (ContentProvider).

App‐2 Private Memory Database3

13 ‐51

Emulator’s File Explorer showing the location of a private database

Database Visibility

SQL Databases

The path to the private memory database is: data/data/cis470.matos.databases/myfriendsDB

13 ‐52

Lesson 13

In order to move a copy of the database in and out of the Emulator’s storage space and either receive or send the file into/from the local computer’s file system you may use the commands: adb pull <full path to database> and

Using GUI Tools for SQLite

SQL Databases

adb pull <full_path_to_database> and adb push <full_path_to_database>. You may also use the Eclipse’s DDMS Perspective to push/pull files in/out the emulator’s file system. Once the database is in your computer’s disk you may manipulate the database using a ‘user‐ friendly’ tool such as:

• SQLite Administrator

(http://sqliteadmin.orbmu2k.de)

• SQLite Manager (Firefox adds‐on)

13 ‐53 <?xml version="1.0" encoding="utf‐8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="match_parent" android:padding="4dp" android:orientation="vertical" >

Complete Code for Examples 2‐7 XML Layout

SQL Databases

android:orientation= vertical > <TextView android:id="@+id/txtCaption" android:layout_width="match_parent" android:layout_height="wrap_content" android:background="#ff0000ff" android:text="SQLDemo2. Android Databases" android:textColor="#ffffffff" android:textSize="20dp" android:textStyle="bold" /> <ScrollView android:id="@+id/ScrollView01" android:layout width="match parent" android:layout_width= match_parent android:layout_height="match_parent" android:padding="10dp" > <TextView android:id="@+id/txtMsg" android:layout_width="match_parent" android:layout_height="wrap_content" android:text="" /> </ScrollView> </LinearLayout> 13 ‐54

Lesson 13

public class SQLDemo2 extends Activity { SQLiteDatabase db; TextView txtMsg; @Override bli id C t (B dl dI t St t ) {

Complete Code for Examples 2‐7 SQLDemo2.java

SQL Databases

public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); txtMsg = (TextView) findViewById(R.id.txtMsg); try {

• penDatabase();

// open (create if needed) database dropTable(); // if needed drop table tblAmigos insertSomeDbData(); // create‐populate tblAmigos useRawQueryShowAll(); // display all records useRawQuery1(); // fixed SQL with no arguments useRawQuery2(); // parameter substitution Q y (); // p useRawQuery3(); //manual string concatenation useSimpleQuery1(); //simple (parametric) query useSimpleQuery2(); //nontrivial 'simple query' showTable("tblAmigo"); //retrieve all rows from a table updateDB(); //use execSQL to update useInsertMethod(); //use insert method useUpdateMethod(); //use update method useDeleteMethod(); //use delete method db.close(); // make sure to release the DB txtMsg.append("\nAll Done!"); 13 ‐55 } catch (Exception e) { txtMsg.append("\nError onCreate: " + e.getMessage()); finish(); } }// onCreate

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 1

SQL Databases

// ///////////////////////////////////////////////////////////////////////////// private void openDatabase() { try { // path to the external SD card (something like: /storage/sdcard/...) // String storagePath = Environment.getExternalStorageDirectory().getPath(); // path to internal memory file system (data/data/cis470.matos.databases) File storagePath = getApplication().getFilesDir(); String myDbPath = storagePath + "/" + "myfriends"; txtMsg.setText("DB Path: " + myDbPath); db = SQLiteDatabase.openDatabase(myDbPath, null, SQLiteDatabase.CREATE_IF_NECESSARY); txtMsg.append("\n‐openDatabase ‐ DB was opened"); } catch (SQLiteException e) { txtMsg.append("\nError openDatabase: " + e.getMessage()); finish(); } }// openDatabase 13 ‐56

Lesson 13

private void insertSomeDbData() { // create table: tblAmigo db.beginTransaction(); try { // create table db SQL(" t t bl tblAMIGO ("

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 2

SQL Databases

db.execSQL("create table tblAMIGO (" + " recID integer PRIMARY KEY autoincrement, " + " name text, " + " phone text ); "); // commit your changes db.setTransactionSuccessful(); txtMsg.append("\n‐insertSomeDbData ‐ Table was created"); } catch (SQLException e1) { txtMsg.append("\nError insertSomeDbData: " + e1.getMessage()); finish(); } finally { } y { db.endTransaction(); } // populate table: tblAmigo db.beginTransaction(); try { // insert rows db.execSQL("insert into tblAMIGO(name, phone) " + " values ('AAA', '555‐1111' );"); 13 ‐57 db.execSQL("insert into tblAMIGO(name, phone) " + " values ('BBB', '555‐2222' );"); db.execSQL("insert into tblAMIGO(name, phone) " + " values ('CCC', '555‐3333' );"); // it h

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 3

SQL Databases

// commit your changes db.setTransactionSuccessful(); txtMsg.append("\n‐insertSomeDbData ‐ 3 rec. were inserted"); } catch (SQLiteException e2) { txtMsg.append("\nError insertSomeDbData: " + e2.getMessage()); } finally { db.endTransaction(); } }// insertSomeData }// // /////////////////////////////////////////////////////////////// private void useRawQueryShowAll() { try { // hard‐coded SQL select with no arguments String mySQL = "select * from tblAMIGO"; Cursor c1 = db.rawQuery(mySQL, null); txtMsg.append("\n‐useRawQueryShowAll" + showCursor(c1) ); 13 ‐58

Lesson 13

} catch (Exception e) { txtMsg.append("\nError useRawQuery1: " + e.getMessage()); } }// useRawQuery1

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 4

SQL Databases

// /////////////////////////////////////////////////////////// private String showCursor( Cursor cursor) { // show SCHEMA (column names & types) cursor.moveToPosition(‐1); //reset cursor's top String cursorData = "\nCursor: ["; try { // get column names String[] colName = cursor.getColumnNames(); for(int i=0; i<colName.length; i++){ String dataType = getColumnType(cursor, i); g yp g yp ( , ); cursorData += colName[i] + dataType; if (i<colName.length‐1){ cursorData+= ", "; } } } catch (Exception e) { Log.e( "<<SCHEMA>>" , e.getMessage() ); } cursorData += "]“; 13 ‐59 // now get the rows cursor.moveToPosition(‐1); //reset cursor's top while (cursor.moveToNext()) { String cursorRow = "\n["; for (int i = 0; i < cursor.getColumnCount(); i++) { R tSt i (i)

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 5

SQL Databases

cursorRow += cursor.getString(i); if (i<cursor.getColumnCount()‐1) cursorRow += ", "; } cursorData += cursorRow + "]"; } return cursorData + "\n"; } // /////////////////////////////////////////////////////////////////////////// private String getColumnType(Cursor cursor, int i) { try { //peek at a row holding valid data //p g cursor.moveToFirst(); int result = cursor.getType(i); String[] types = {":NULL", ":INT", ":FLOAT", ":STR", ":BLOB", ":UNK" }; //backtrack ‐ reset cursor's top cursor.moveToPosition(‐1); return types[result]; } catch (Exception e) { return " "; } } 13 ‐60

Lesson 13

private void useRawQuery1() { try { // hard‐coded SQL select with no arguments String mySQL = "select * from tblAMIGO"; Cursor c1 = db.rawQuery(mySQL, null);

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 6

SQL Databases

// get the first recID c1.moveToFirst(); int index = c1.getColumnIndex("recID"); int theRecID = c1.getInt(index); txtMsg.append("\n‐useRawQuery1 ‐ first recID " + theRecID); txtMsg.append("\n‐useRawQuery1" + showCursor(c1) ); } catch (Exception e) { txtMsg.append("\nError useRawQuery1: " + e.getMessage()); } }// useRawQuery1 // /////////////////////////////////////////////////////////////// private void useRawQuery2() { try { // use: ? as argument's placeholder String mySQL = " select recID, name, phone " + " from tblAmigo " + " where recID > ? " + " and name = ? "; String[] args = { "1", "BBB" }; 13 ‐61 Cursor c1 = db.rawQuery(mySQL, args); // pick NAME from first returned row c1.moveToFirst(); int index = c1.getColumnIndex("name"); St i th N 1 tSt i (i d )

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 7

SQL Databases

String theName = c1.getString(index); txtMsg.append("\n‐useRawQuery2 Retrieved name: " + theName); txtMsg.append("\n‐useRawQuery2 " + showCursor(c1) ); } catch (Exception e) { txtMsg.append("\nError useRawQuery2: " + e.getMessage()); } }// useRawQuery2 // /////////////////////////////////////////////////////////////// private void useRawQuery3() { p Q y () { try { // arguments injected by manual string concatenation String[] args = { "1", "BBB" }; String mySQL = " select recID, name, phone" + " from tblAmigo " + " where recID > " + args[0] + " and name = '" + args[1] + "'"; Cursor c1 = db.rawQuery(mySQL, null); 13 ‐62

Lesson 13

// pick PHONE from first returned row int index = c1.getColumnIndex("phone"); //case sensitive c1.moveToNext(); String thePhone = c1.getString(index); t tM d("\ R Q 3 Ph " th Ph )

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 8

SQL Databases

txtMsg.append("\n‐useRawQuery3 ‐ Phone: " + thePhone); txtMsg.append("\n‐useRawQuery3 " + showCursor(c1) ); } catch (Exception e) { txtMsg.append("\nError useRawQuery3: " + e.getMessage()); } }// useRawQuery3 // /////////////////////////////////////////////////////////////// private void useSimpleQuery1() { try { y { // simple‐parametric query on one table. // arguments: tableName, columns, condition, cond‐args, // groupByCol, havingCond, orderBy // the next parametric query is equivalent to SQL stmt: // select recID, name, phone from tblAmigo // where recID > 1 and length(name) >= 3 //

• rder by recID

13 ‐63 Cursor c1 = db.query( "tblAMIGO", new String[] { "recID", "name", "phone" }, "recID > 1 and length(name) >= 3 ", ll

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 9

SQL Databases

null, null, null, "recID"); // get NAME from first data row int index = c1.getColumnIndex("phone"); c1.moveToFirst(); String theName = c1.getString(index); txtMsg.append("\n‐useSimpleQuery1 ‐ Total rec " + theName); txtMsg.append("\n‐useSimpleQuery1 " + showCursor(c1) ); g pp ( \ p Q y ( ) ); } catch (Exception e) { txtMsg.append("\nError useSimpleQuery1: " + e.getMessage()); } }// useSimpleQuery1 13 ‐64

Lesson 13

private void useSimpleQuery2() { try { // nontrivial 'simple query' on one table String[] selectColumns = { "name", "count(*) as TotalSubGroup" }; St i h C diti " ID ?"

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 10

SQL Databases

String whereCondition = "recID >= ?"; String[] whereConditionArgs = { "1" }; String groupBy = "name"; String having = "count(*) <= 4"; String orderBy = "name"; Cursor c1 = db.query("tblAMIGO", selectColumns, whereCondition, whereConditionArgs, groupBy, having, orderBy); int theTotalRows = c1.getCount(); txtMsg.append("\n‐useSimpleQuery2 ‐ Total rec: " + theTotalRows); txtMsg.append("\n‐useSimpleQuery2 " + showCursor(c1) ); g pp ( \ p Q y ( ) ); } catch (Exception e) { txtMsg.append("\nError useSimpleQuery2: " + e.getMessage()); } }// useSimpleQuery2 13 ‐65 private void showTable(String tableName) { try { String sql = "select * from " + tableName ; Cursor c = db.rawQuery(sql, null); txtMsg.append("\n‐showTable: " + tableName + showCursor(c) );

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 11

SQL Databases

} catch (Exception e) { txtMsg.append("\nError showTable: " + e.getMessage()); } }// useCursor1 // /////////////////////////////////////////////////////////////// private void useCursor1() { try { // this is similar to showCursor(...) // obtain a list of records[recId, name, phone] from DB // [ , , p ] String[] columns = { "recID", "name", "phone" }; // using simple parametric cursor Cursor c = db.query("tblAMIGO", columns, null, null, null, null, "recID"); int theTotal = c.getCount(); txtMsg.append("\n‐useCursor1 ‐ Total rec " + theTotal); txtMsg.append("\n"); int idCol = c.getColumnIndex("recID"); int nameCol = c.getColumnIndex("name"); int phoneCol = c.getColumnIndex("phone"); 13 ‐66

Lesson 13

c.moveToPosition(‐1); while (c.moveToNext()) { columns[0] = Integer.toString((c.getInt(idCol))); columns[1] = c.getString(nameCol); columns[2] = c.getString(phoneCol);

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 12

SQL Databases

txtMsg.append(columns[0] + " " + columns[1] + " " + columns[2] + "\n"); } } catch (Exception e) { txtMsg.append("\nError useCursor1: " + e.getMessage()); finish(); } }// useCursor1 // /////////////////////////////////////////////////////////////////// // /////////////////////////////////////////////////////////////////// private void updateDB() { // action query performed using execSQL // add 'XXX' to the name of person whose phone is 555‐1111 txtMsg.append("\n‐updateDB"); try { String thePhoneNo = "555‐1111"; db.execSQL(" update tblAMIGO set name = (name || 'XXX') " + " where phone = '" + thePhoneNo + "' "); showTable("tblAmigo"); 13 ‐67 } catch (Exception e) { txtMsg.append("\nError updateDB: " + e.getMessage()); } useCursor1(); }

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 13

SQL Databases

// /////////////////////////////////////////////////////////////////// private void dropTable() { // (clean start) action query to drop table try { db.execSQL(" drop table tblAmigo; "); // >>Toast.makeText(this, "Table dropped", 1).show(); txtMsg.append("\n‐dropTable ‐ dropped!!"); } catch (Exception e) { txtMsg.append("\nError dropTable: " + e.getMessage()); finish(); } } // ////////////////////////////////////////////////////////////////// public void useInsertMethod() { // an alternative to SQL "insert into table values(...)" // ContentValues is an Android dynamic row‐like container try { ContentValues initialValues = new ContentValues(); initialValues.put("name", "ABC"); initialValues.put("phone", "555‐4444"); int rowPosition = (int) db.insert("tblAMIGO", null, initialValues); 13 ‐68

Lesson 13

txtMsg.append("\n‐useInsertMethod rec added at: " + rowPosition); showTable("tblAmigo"); } catch (Exception e) { txtMsg.append("\n‐useInsertMethod ‐ Error: " + e.getMessage()); }

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 14

SQL Databases

} }// useInsertMethod // /////////////////////////////////////////////////////////////////// private void useUpdateMethod() { try { // using the 'update' method to change name of selected friend String[] whereArgs = { "1" }; ContentValues updValues = new ContentValues(); updValues.put("name", "Maria"); int recAffected = db.update("tblAMIGO", updValues, "recID = ? ", whereArgs); txtMsg.append("\n‐useUpdateMethod ‐ Rec Affected " + recAffected); showTable("tblAmigo"); } catch (Exception e) { txtMsg.append("\n‐useUpdateMethod ‐ Error: " + e.getMessage() ); } } 13 ‐69 private void useDeleteMethod() { // using the 'delete' method to remove a group of friends // whose id# is between 2 and 7 t {

Complete Code for Examples 2‐7 SQLDemo2.java

• cont. 15

SQL Databases

try { String[] whereArgs = { "2" }; int recAffected = db.delete("tblAMIGO", "recID = ?", whereArgs); txtMsg.append("\n‐useDeleteMethod ‐ Rec affected " + recAffected); showTable("tblAmigo"); } catch (Exception e) { txtMsg.append("\n‐useDeleteMethod ‐ Error: " + e.getMessage()); } } }// class 13 ‐70

Lesson 13

SQL Databases

Questions

13 ‐71

You may query the SQLITE master table (named: sqlite_master) looking for a table, index, or other database object.

Appendix 1: Database Dictionary ‐ SQLITE Master Table

SQL Databases

Example select * from sqlite_master; Examination of this field provides the table schema

13 ‐72

Lesson 13

In Java code you may formulate the test for existence of a database object using something similar to the following fragment

Appendix 1: Database Dictionary ‐ SQLITE Master Table

SQL Databases

public boolean tableExists(SQLiteDatabase db, String tableName) { //true if table exists, false otherwise String mySql = " SELECT name FROM sqlite_master " + " WHERE type='table' " + " AND name='" + tableName + "'"; int resultSize = db.rawQuery(mySql, null).getCount(); if (resultSize ==0) { if (resultSize ==0) { return true; } else return false; }

13 ‐73

Appendix 2: Convenient SQL Database Command In Java code you may state the request for “CREATE or REPLACE” a table using the following safe construct:

Appendix 1: Database Dictionary ‐ SQLITE Master Table

SQL Databases

following safe construct: db.execSQL(" DROP TABLE IF EXISTS tblAmigo; ");

13 ‐74