android.database.sqlite.SQLiteQueryBuilder
This is a convience class that helps build SQL queries to be sent to
SQLiteDatabase objects.
Summary
Public Constructors
Public Methods
|
|
|
static |
|
void |
appendColumns(StringBuilder s, String[] columns) |
|
|
|
|
|
void |
appendWhere(CharSequence inWhere) |
|
|
|
|
|
void |
appendWhereEscapeString(String inWhere) |
|
|
|
|
|
String |
buildQuery(String[] projectionIn, String selection, String[] selectionArgs, String groupBy, String having, String sortOrder, String limit) |
|
|
|
static |
|
String |
buildQueryString(boolean distinct, String tables, String[] columns, String where, String groupBy, String having, String orderBy, String limit) |
|
|
|
|
|
String |
buildUnionQuery(String[] subQueries, String sortOrder, String limit) |
|
|
|
|
|
String |
buildUnionSubQuery(String typeDiscriminatorColumn, String[] unionColumns, Set<String> columnsPresentInTable, int computedColumnsOffset, String typeDiscriminatorValue, String selection, String[] selectionArgs, String groupBy, String having) |
|
|
|
|
|
String |
getTables() |
|
|
|
|
|
Cursor |
query(SQLiteDatabase db, String[] projectionIn, String selection, String[] selectionArgs, String groupBy, String having, String sortOrder) |
|
|
|
|
|
Cursor |
query(SQLiteDatabase db, String[] projectionIn, String selection, String[] selectionArgs, String groupBy, String having, String sortOrder, String limit) |
|
|
|
|
|
void |
setCursorFactory(SQLiteDatabase.CursorFactory factory) |
|
|
|
|
|
void |
setDistinct(boolean distinct) |
|
|
|
|
|
void |
setProjectionMap(Map<String, String> columnMap) |
|
|
|
|
|
void |
setTables(String inTables) |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Constructors
public
SQLiteQueryBuilder()
Public Methods
public
static
void
appendColumns(StringBuilder s, String[] columns)
Add the names that are non-null in columns to s, separating
them with commas.
public
void
appendWhere(CharSequence inWhere)
Append a chunk to the WHERE clause of the query. All chunks appended are surrounded
by parenthesis and ANDed with the selection passed to
query(SQLiteDatabase, String[], String, String[], String, String, String). The final
WHERE clause looks like:
WHERE (<append chunk 1><append chunk2>) AND (<query() selection parameter>)
Parameters
inWhere
| the chunk of text to append to the WHERE clause.
|
public
void
appendWhereEscapeString(String inWhere)
Append a chunk to the WHERE clause of the query. All chunks appended are surrounded
by parenthesis and ANDed with the selection passed to
query(SQLiteDatabase, String[], String, String[], String, String, String). The final
WHERE clause looks like:
WHERE (<append chunk 1><append chunk2>) AND (<query() selection parameter>)
Parameters
inWhere
| the chunk of text to append to the WHERE clause. it will be escaped
to avoid SQL injection attacks
|
Construct a SELECT statement suitable for use in a group of
SELECT statements that will be joined through UNION operators
in buildUnionQuery.
Parameters
projectionIn
| A list of which columns to return. Passing
null will return all columns, which is discouraged to
prevent reading data from storage that isn't going to be
used. |
selection
| A filter declaring which rows to return,
formatted as an SQL WHERE clause (excluding the WHERE
itself). Passing null will return all rows for the given
URL. |
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. |
groupBy
| A filter declaring how to group rows, formatted
as an SQL GROUP BY clause (excluding the GROUP BY itself).
Passing null will cause the rows to not be grouped. |
having
| A filter declare which row groups to include in
the cursor, if row grouping is being used, formatted as an
SQL HAVING clause (excluding the HAVING itself). Passing
null will cause all row groups to be included, and is
required when row grouping is not being used. |
sortOrder
| How to order the rows, formatted as an SQL
ORDER BY clause (excluding the ORDER BY itself). Passing null
will use the default sort order, which may be unordered. |
limit
| Limits the number of rows returned by the query,
formatted as LIMIT clause. Passing null denotes no LIMIT clause. |
Returns
- the resulting SQL SELECT statement
public
static
String
buildQueryString(boolean distinct, String tables, String[] columns, String where, String groupBy, String having, String orderBy, String limit)
Build an SQL query string from the given clauses.
Parameters
distinct
| true if you want each row to be unique, false otherwise. |
tables
| The table names to compile the query against. |
columns
| A list of which columns to return. Passing null will
return all columns, which is discouraged to prevent reading
data from storage that isn't going to be used. |
where
| A filter declaring which rows to return, formatted as an SQL
WHERE clause (excluding the WHERE itself). Passing null will
return all rows for the given URL. |
groupBy
| A filter declaring how to group rows, formatted as an SQL
GROUP BY clause (excluding the GROUP BY itself). Passing null
will cause the rows to not be grouped. |
having
| A filter declare which row groups to include in the cursor,
if row grouping is being used, formatted as an SQL HAVING
clause (excluding the HAVING itself). Passing null will cause
all row groups to be included, and is required when row
grouping is not being used. |
orderBy
| How to order the rows, formatted as an SQL ORDER BY clause
(excluding the ORDER BY itself). Passing null will use the
default sort order, which may be unordered. |
limit
| Limits the number of rows returned by the query,
formatted as LIMIT clause. Passing null denotes no LIMIT clause. |
public
String
buildUnionQuery(String[] subQueries, String sortOrder, String limit)
Given a set of subqueries, all of which are SELECT statements,
construct a query that returns the union of what those
subqueries return.
Parameters
subQueries
| an array of SQL SELECT statements, all of
which must have the same columns as the same positions in
their results |
sortOrder
| How to order the rows, formatted as an SQL
ORDER BY clause (excluding the ORDER BY itself). Passing
null will use the default sort order, which may be unordered. |
limit
| The limit clause, which applies to the entire union result set |
Returns
- the resulting SQL SELECT statement
public
String
buildUnionSubQuery(String typeDiscriminatorColumn, String[] unionColumns, Set<String> columnsPresentInTable, int computedColumnsOffset, String typeDiscriminatorValue, String selection, String[] selectionArgs, String groupBy, String having)
Construct a SELECT statement suitable for use in a group of
SELECT statements that will be joined through UNION operators
in buildUnionQuery.
Parameters
typeDiscriminatorColumn
| the name of the result column
whose cells will contain the name of the table from which
each row was drawn. |
unionColumns
| the names of the columns to appear in the
result. This may include columns that do not appear in the
table this SELECT is querying (i.e. mTables), but that do
appear in one of the other tables in the UNION query that we
are constructing. |
columnsPresentInTable
| a Set of the names of the columns
that appear in this table (i.e. in the table whose name is
mTables). Since columns in unionColumns include columns that
appear only in other tables, we use this array to distinguish
which ones actually are present. Other columns will have
NULL values for results from this subquery. |
computedColumnsOffset
| all columns in unionColumns before
this index are included under the assumption that they're
computed and therefore won't appear in columnsPresentInTable,
e.g. "date * 1000 as normalized_date" |
typeDiscriminatorValue
| the value used for the
type-discriminator column in this subquery |
selection
| A filter declaring which rows to return,
formatted as an SQL WHERE clause (excluding the WHERE
itself). Passing null will return all rows for the given
URL. |
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. |
groupBy
| A filter declaring how to group rows, formatted
as an SQL GROUP BY clause (excluding the GROUP BY itself).
Passing null will cause the rows to not be grouped. |
having
| A filter declare which row groups to include in
the cursor, if row grouping is being used, formatted as an
SQL HAVING clause (excluding the HAVING itself). Passing
null will cause all row groups to be included, and is
required when row grouping is not being used. |
Returns
- the resulting SQL SELECT statement
public
String
getTables()
Returns the list of tables being queried
Returns
- the list of tables being queried
Perform a query by combining all current settings and the
information passed into this method.
Parameters
db
| the database to query on |
projectionIn
| A list of which columns to return. Passing
null will return all columns, which is discouraged to prevent
reading data from storage that isn't going to be used. |
selection
| A filter declaring which rows to return,
formatted as an SQL WHERE clause (excluding the WHERE
itself). Passing null will return all rows for the given URL. |
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. |
groupBy
| A filter declaring how to group rows, formatted
as an SQL GROUP BY clause (excluding the GROUP BY
itself). Passing null will cause the rows to not be grouped. |
having
| A filter declare which row groups to include in
the cursor, if row grouping is being used, formatted as an
SQL HAVING clause (excluding the HAVING itself). Passing
null will cause all row groups to be included, and is
required when row grouping is not being used. |
sortOrder
| How to order the rows, formatted as an SQL
ORDER BY clause (excluding the ORDER BY itself). Passing null
will use the default sort order, which may be unordered. |
Returns
- a cursor over the result set
Perform a query by combining all current settings and the
information passed into this method.
Parameters
db
| the database to query on |
projectionIn
| A list of which columns to return. Passing
null will return all columns, which is discouraged to prevent
reading data from storage that isn't going to be used. |
selection
| A filter declaring which rows to return,
formatted as an SQL WHERE clause (excluding the WHERE
itself). Passing null will return all rows for the given URL. |
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. |
groupBy
| A filter declaring how to group rows, formatted
as an SQL GROUP BY clause (excluding the GROUP BY
itself). Passing null will cause the rows to not be grouped. |
having
| A filter declare which row groups to include in
the cursor, if row grouping is being used, formatted as an
SQL HAVING clause (excluding the HAVING itself). Passing
null will cause all row groups to be included, and is
required when row grouping is not being used. |
sortOrder
| How to order the rows, formatted as an SQL
ORDER BY clause (excluding the ORDER BY itself). Passing null
will use the default sort order, which may be unordered. |
limit
| Limits the number of rows returned by the query,
formatted as LIMIT clause. Passing null denotes no LIMIT clause. |
Returns
- a cursor over the result set
Sets the cursor factory to be used for the query. You can use
one factory for all queries on a database but it is normally
easier to specify the factory when doing this query. @param
factory the factor to use
public
void
setDistinct(boolean distinct)
Mark the query as DISTINCT.
Parameters
distinct
| if true the query is DISTINCT, otherwise it isn't
|
public
void
setProjectionMap(Map<String, String> columnMap)
Sets the projection map for the query. The projection map maps
from column names that the caller passes into query to database
column names. This is useful for renaming columns as well as
disambiguating column names when doing joins. For example you
could map "name" to "people.name". If a projection map is set
it must contain all column names the user may request, even if
the key and value are the same.
Parameters
columnMap
| maps from the user column names to the database column names
|
public
void
setTables(String inTables)
Sets the list of tables to query. Multiple tables can be specified to perform a join.
For example:
setTables("foo, bar")
setTables("foo LEFT OUTER JOIN bar ON (foo.id = bar.foo_id)")
Parameters
inTables
| the list of tables to query on
|