Package android.database.sqlite

Class SQLiteQueryBuilder

  • public class SQLiteQueryBuilder
extends Object
    This is a convience class that helps build SQL queries to be sent to SQLiteDatabase objects.

    • Constructor Detail

      • SQLiteQueryBuilder

        public SQLiteQueryBuilder()

    • Method Detail

      • setDistinct

        public void setDistinct​(boolean distinct)
        Mark the query as DISTINCT.
        Parameters:
        distinct - if true the query is DISTINCT, otherwise it isn't

      • getTables

        public String getTables()
        Returns the list of tables being queried
        Returns:
        the list of tables being queried

      • setTables

        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

      • setProjectionMap

        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

      • setCursorFactory

        public void setCursorFactory​(SQLiteDatabase.CursorFactory factory)
        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.
        Parameters:
        factory - the factory to use.

      • buildQueryString

        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.
        Returns:
        the SQL query string

      • appendColumns

        public static void appendColumns​(StringBuilder s,
                                 String[] columns)
        Add the names that are non-null in columns to s, separating them with commas.

      • query

        public Cursor query​(SQLiteDatabase db,
                    String[] projectionIn,
                    String selection,
                    String[] selectionArgs,
                    String groupBy,
                    String having,
                    String sortOrder)
        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
        See Also:
        android.content.ContentResolver#query(android.net.Uri, String[], String, String[], String)

      • query

        public Cursor query​(SQLiteDatabase db,
                    String[] projectionIn,
                    String selection,
                    String[] selectionArgs,
                    String groupBy,
                    String having,
                    String sortOrder,
                    String limit)
        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
        See Also:
        android.content.ContentResolver#query(android.net.Uri, String[], String, String[], String)

      • query

        public Cursor query​(SQLiteDatabase db,
                    String[] projectionIn,
                    String selection,
                    String[] selectionArgs,
                    String groupBy,
                    String having,
                    String sortOrder,
                    String limit,
                    CancellationSignal cancellationSignal)
        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.
        cancellationSignal - A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed.
        Returns:
        a cursor over the result set
        See Also:
        android.content.ContentResolver#query(android.net.Uri, String[], String, String[], String)

      • buildQuery

        public String buildQuery​(String[] projectionIn,
                         String selection,
                         String groupBy,
                         String having,
                         String sortOrder,
                         String limit)
        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.
        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

      • buildUnionSubQuery

        public String buildUnionSubQuery​(String typeDiscriminatorColumn,
                                 String[] unionColumns,
                                 Set<String> columnsPresentInTable,
                                 int computedColumnsOffset,
                                 String typeDiscriminatorValue,
                                 String selection,
                                 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.
        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

      • buildUnionQuery

        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