com.couchbase.lite.internal.database.util

Class DatabaseUtils

java.lang.Object

com.couchbase.lite.internal.database.util.DatabaseUtils

public class DatabaseUtils
extends java.lang.Object

Static utility methods for dealing with databases and Cursors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseUtils.InsertHelper Deprecated. Use SQLiteStatement instead.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATEMENT_ABORT One of the values returned by getSqlStatementType(String).
static int	STATEMENT_ATTACH One of the values returned by getSqlStatementType(String).
static int	STATEMENT_BEGIN One of the values returned by getSqlStatementType(String).
static int	STATEMENT_COMMIT One of the values returned by getSqlStatementType(String).
static int	STATEMENT_DDL One of the values returned by getSqlStatementType(String).
static int	STATEMENT_OTHER One of the values returned by getSqlStatementType(String).
static int	STATEMENT_PRAGMA One of the values returned by getSqlStatementType(String).
static int	STATEMENT_SELECT One of the values returned by getSqlStatementType(String).
static int	STATEMENT_UNPREPARED One of the values returned by getSqlStatementType(String).
static int	STATEMENT_UPDATE One of the values returned by getSqlStatementType(String).

Constructor Summary

Constructors

Constructor and Description
DatabaseUtils()

Method Summary

Modifier and Type	Method and Description
static void	appendEscapedSQLString(java.lang.StringBuilder sb, java.lang.String sqlString) Appends an SQL string to the given StringBuilder, including the opening and closing single quotes.
static java.lang.String[]	appendSelectionArgs(java.lang.String[] originalValues, java.lang.String[] newValues) Appends one set of selection args to another.
static void	appendValueToSql(java.lang.StringBuilder sql, java.lang.Object value) Appends an Object to an SQL string with the proper escaping, etc.
static void	bindObjectToProgram(SQLiteProgram prog, int index, java.lang.Object value) Binds the given Object to the given SQLiteProgram using the proper typing.
static java.lang.String	concatenateWhere(java.lang.String a, java.lang.String b) Concatenates two SQL WHERE clauses, handling empty or null values.
static void	cursorDoubleToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a Double out of a column in a Cursor and writes it to a ContentValues.
static void	cursorFloatToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a Float out of a column in a Cursor and writes it to a ContentValues.
static void	cursorIntToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a Integer out of a column in a Cursor and writes it to a ContentValues.
static void	cursorLongToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a Long out of a column in a Cursor and writes it to a ContentValues.
static void	cursorShortToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a Short out of a column in a Cursor and writes it to a ContentValues.
static void	cursorStringToContentValuesIfPresent(Cursor cursor, ContentValues values, java.lang.String column) Reads a String out of a column in a Cursor and writes it to a ContentValues.
static int	findRowIdColumnIndex(java.lang.String[] columnNames) Returns column index of "_id" column, or -1 if not found.
static int	getSqlStatementType(java.lang.String sql) Returns one of the following which represent the type of the given SQL statement.
static int	getTypeOfObject(java.lang.Object obj) Returns data type of the given object's value.
static long	longForQuery(SQLiteDatabase db, java.lang.String query, java.lang.String[] selectionArgs) Utility method to run the query on the db and return the value in the first column of the first row.
static long	longForQuery(SQLiteStatement prog, java.lang.String[] selectionArgs) Utility method to run the pre-compiled query and return the value in the first column of the first row.
static boolean	queryIsEmpty(SQLiteDatabase db, java.lang.String table) Query the table to check whether a table is empty or not
static long	queryNumEntries(SQLiteDatabase db, java.lang.String table) Query the table for the number of rows in the table.
static long	queryNumEntries(SQLiteDatabase db, java.lang.String table, java.lang.String selection) Query the table for the number of rows in the table.
static long	queryNumEntries(SQLiteDatabase db, java.lang.String table, java.lang.String selection, java.lang.String[] selectionArgs) Query the table for the number of rows in the table.
static java.lang.String	sqlEscapeString(java.lang.String value) SQL-escape a string.
static java.lang.String	stringForQuery(SQLiteDatabase db, java.lang.String query, java.lang.String[] selectionArgs) Utility method to run the query on the db and return the value in the first column of the first row.
static java.lang.String	stringForQuery(SQLiteStatement prog, java.lang.String[] selectionArgs) Utility method to run the pre-compiled query and return the value in the first column of the first row.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATEMENT_SELECT

public static final int STATEMENT_SELECT

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_UPDATE

public static final int STATEMENT_UPDATE

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_ATTACH

public static final int STATEMENT_ATTACH

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_BEGIN

public static final int STATEMENT_BEGIN

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_COMMIT

public static final int STATEMENT_COMMIT

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_ABORT

public static final int STATEMENT_ABORT

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_PRAGMA

public static final int STATEMENT_PRAGMA

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_DDL

public static final int STATEMENT_DDL

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_UNPREPARED

public static final int STATEMENT_UNPREPARED

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

STATEMENT_OTHER

public static final int STATEMENT_OTHER

One of the values returned by getSqlStatementType(String).

See Also:

Constant Field Values

Constructor Detail

DatabaseUtils

public DatabaseUtils()

Method Detail

bindObjectToProgram

public static void bindObjectToProgram(SQLiteProgram prog,
                                       int index,
                                       java.lang.Object value)

Binds the given Object to the given SQLiteProgram using the proper typing. For example, bind numbers as longs/doubles, and everything else as a string by call toString() on it.

Parameters:

prog - the program to bind the object to

index - the 1-based index to bind at

value - the value to bind

getTypeOfObject

public static int getTypeOfObject(java.lang.Object obj)

Returns data type of the given object's value.

Returned values are

• Cursor.FIELD_TYPE_NULL
• Cursor.FIELD_TYPE_INTEGER
• Cursor.FIELD_TYPE_FLOAT
• Cursor.FIELD_TYPE_STRING
• Cursor.FIELD_TYPE_BLOB

Parameters:

obj - the object whose value type is to be returned

Returns:

object value type

appendEscapedSQLString

public static void appendEscapedSQLString(java.lang.StringBuilder sb,
                                          java.lang.String sqlString)

Appends an SQL string to the given StringBuilder, including the opening and closing single quotes. Any single quotes internal to sqlString will be escaped. This method is deprecated because we want to encourage everyone to use the "?" binding form. However, when implementing a ContentProvider, one may want to add WHERE clauses that were not provided by the caller. Since "?" is a positional form, using it in this case could break the caller because the indexes would be shifted to accomodate the ContentProvider's internal bindings. In that case, it may be necessary to construct a WHERE clause manually. This method is useful for those cases.

Parameters:

sb - the StringBuilder that the SQL string will be appended to

sqlString - the raw string to be appended, which may contain single quotes

sqlEscapeString

public static java.lang.String sqlEscapeString(java.lang.String value)

SQL-escape a string.

appendValueToSql

public static final void appendValueToSql(java.lang.StringBuilder sql,
                                          java.lang.Object value)

Appends an Object to an SQL string with the proper escaping, etc.

concatenateWhere

public static java.lang.String concatenateWhere(java.lang.String a,
                                                java.lang.String b)

Concatenates two SQL WHERE clauses, handling empty or null values.

queryNumEntries

public static long queryNumEntries(SQLiteDatabase db,
                                   java.lang.String table)

Query the table for the number of rows in the table.

Parameters:

db - the database the table is in

table - the name of the table to query

Returns:

the number of rows in the table

queryNumEntries

public static long queryNumEntries(SQLiteDatabase db,
                                   java.lang.String table,
                                   java.lang.String selection)

Query the table for the number of rows in the table.

Parameters:

db - the database the table is in

table - the name of the table to query

selection - A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will count all rows for the given table

Returns:

the number of rows in the table filtered by the selection

queryNumEntries

public static long queryNumEntries(SQLiteDatabase db,
                                   java.lang.String table,
                                   java.lang.String selection,
                                   java.lang.String[] selectionArgs)

Query the table for the number of rows in the table.

Parameters:

db - the database the table is in

table - the name of the table to query

selection - A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will count all rows for the given table

selectionArgs - You may include ?s in selection, which will be replaced by the values from selectionArgs, in order that they appear in the selection. The values will be bound as Strings.

Returns:

the number of rows in the table filtered by the selection

queryIsEmpty

public static boolean queryIsEmpty(SQLiteDatabase db,
                                   java.lang.String table)

Query the table to check whether a table is empty or not

Parameters:

db - the database the table is in

table - the name of the table to query

Returns:

True if the table is empty

longForQuery

public static long longForQuery(SQLiteDatabase db,
                                java.lang.String query,
                                java.lang.String[] selectionArgs)

Utility method to run the query on the db and return the value in the first column of the first row.

longForQuery

public static long longForQuery(SQLiteStatement prog,
                                java.lang.String[] selectionArgs)

Utility method to run the pre-compiled query and return the value in the first column of the first row.

stringForQuery

public static java.lang.String stringForQuery(SQLiteDatabase db,
                                              java.lang.String query,
                                              java.lang.String[] selectionArgs)

Utility method to run the query on the db and return the value in the first column of the first row.

stringForQuery

public static java.lang.String stringForQuery(SQLiteStatement prog,
                                              java.lang.String[] selectionArgs)

Utility method to run the pre-compiled query and return the value in the first column of the first row.

cursorStringToContentValuesIfPresent

public static void cursorStringToContentValuesIfPresent(Cursor cursor,
                                                        ContentValues values,
                                                        java.lang.String column)

Reads a String out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

cursorLongToContentValuesIfPresent

public static void cursorLongToContentValuesIfPresent(Cursor cursor,
                                                      ContentValues values,
                                                      java.lang.String column)

Reads a Long out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

cursorShortToContentValuesIfPresent

public static void cursorShortToContentValuesIfPresent(Cursor cursor,
                                                       ContentValues values,
                                                       java.lang.String column)

Reads a Short out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

cursorIntToContentValuesIfPresent

public static void cursorIntToContentValuesIfPresent(Cursor cursor,
                                                     ContentValues values,
                                                     java.lang.String column)

Reads a Integer out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

cursorFloatToContentValuesIfPresent

public static void cursorFloatToContentValuesIfPresent(Cursor cursor,
                                                       ContentValues values,
                                                       java.lang.String column)

Reads a Float out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

cursorDoubleToContentValuesIfPresent

public static void cursorDoubleToContentValuesIfPresent(Cursor cursor,
                                                        ContentValues values,
                                                        java.lang.String column)

Reads a Double out of a column in a Cursor and writes it to a ContentValues. Adds nothing to the ContentValues if the column isn't present or if its value is null.

Parameters:

cursor - The cursor to read from

column - The column to read

values - The ContentValues to put the value into

getSqlStatementType

public static int getSqlStatementType(java.lang.String sql)

Returns one of the following which represent the type of the given SQL statement.

1. STATEMENT_SELECT
2. STATEMENT_UPDATE
3. STATEMENT_ATTACH
4. STATEMENT_BEGIN
5. STATEMENT_COMMIT
6. STATEMENT_ABORT
7. STATEMENT_OTHER

Parameters:

sql - the SQL statement whose type is returned by this method

Returns:

one of the values listed above

appendSelectionArgs

public static java.lang.String[] appendSelectionArgs(java.lang.String[] originalValues,
                                                     java.lang.String[] newValues)

Appends one set of selection args to another. This is useful when adding a selection argument to a user provided set.

findRowIdColumnIndex

public static int findRowIdColumnIndex(java.lang.String[] columnNames)

Returns column index of "_id" column, or -1 if not found.