Utility class to construct and manage Appwrite-style database query filters. More...

#include <Query.hpp>

Collaboration diagram for Queries:

Public Member Functions
void	addComplexQuery (const std::string jsonQuery)
	Add a raw JSON complex query.

template<typename T >
void	notEqual (const std::string attributeId, std::list< T > &values)
	Filter documents where attribute does not equal any value in list.

	Queries ()
	Constructor.

template<typename T >
void	queryBetween (const std::string attributeId, const T &value1, const T &value2)
	Filter documents where attribute is between two values.

void	queryContains (const std::string attributeId, const std::string &value)
	Filter documents where attribute contains the value.

template<typename T >
void	queryContains (const std::string attributeId, std::list< T > &value)
	Filter documents where attribute contains any value from list.

void	queryCursorAfter (const std::string documentId)
	Add a cursor query to paginate after the given document ID.

void	queryEndsWith (const std::string attributeId, const std::string &value)
	Filter documents where attribute ends with given value.

template<typename T >
void	queryEqual (const std::string attributeId, std::list< T > &values)
	Filter documents where attribute equals any value in list.

template<typename T >
void	queryGreaterThan (const std::string attributeId, const T &value)
	Filter documents where attribute is greater than value.

template<typename T >
void	queryGreaterThanEqual (const std::string attributeId, const T &value)
	Filter documents where attribute is greater than or equal to value.

void	queryIsNotNull (const std::string attributeId)
	Filter documents where an attribute is not null.

void	queryIsNull (const std::string attributeId)
	Filter documents where an attribute is null.

template<typename T >
void	queryLessThan (const std::string attributeId, const T &value)
	Filter documents where attribute is less than value.

template<typename T >
void	queryLessThanEqual (const std::string attributeId, const T &value)
	Filter documents where attribute is less than or equal to value.

void	queryLimit (int limit)
	Limit the number of documents returned.

void	querySelect (std::list< std::string > &values)
	Select only certain fields from the result.

void	queryStartsWith (const std::string attributeId, const std::string &value)
	Filter documents where attribute starts with given value.

bool	removeJsonQuery (int index)
	Remove a JSON query by index.

void	reset ()
	Resets the internal query list.

std::string	to_string ()
	Serialize all added queries into a JSON string.

Detailed Description

Utility class to construct and manage Appwrite-style database query filters.

Provides methods to build query filters like equal, contains, range-based, null checks, and complex queries for Appwrite API requests.

Definition at line 24 of file Query.hpp.

Constructor & Destructor Documentation

◆ Queries()

Queries::Queries ( )

Constructor.

Member Function Documentation

◆ addComplexQuery()

void Queries::addComplexQuery ( const std::string jsonQuery )

Add a raw JSON complex query.

Parameters

jsonQuery A valid Appwrite-style JSON query string.

◆ notEqual()

template<typename T >

void Queries::notEqual	(	const std::string	attributeId,
		std::list< T > &	values
	)

inline

Filter documents where attribute does not equal any value in list.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
values	List of disallowed values.

Definition at line 244 of file Query.hpp.

                                                                   {
        std::string query = "{\"method\":\"notEqual\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" +
                            listToString(values) + "]}";
        if (not_equal_iter == queries.end()) {
            queries.push_back(query);
            not_equal_iter = std::prev(queries.end());
            return;
        }
        *not_equal_iter = query;
    }

◆ queryBetween()

template<typename T >

void Queries::queryBetween	(	const std::string	attributeId,
		const T &	value1,
		const T &	value2
	)

inline

Filter documents where attribute is between two values.

Template Parameters

T	Comparable value type.

Parameters

attributeId	The attribute key.
value1	Lower bound.
value2	Upper bound.

Definition at line 118 of file Query.hpp.

                                       {
        std::ostringstream oss;
 
        oss << append_encoded(oss, value1);
        oss << ",";
        oss << append_encoded(oss, value2);
 
        std::string query = "{\"method\":\"between\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" + oss.str() + "]}";
        if (between_iter == queries.end()) {
            queries.push_back(query);
            between_iter = std::prev(queries.end());
            return;
        }
        *between_iter = query;
    }

◆ queryContains() [1/2]

void Queries::queryContains	(	const std::string	attributeId,
		const std::string &	value
	)

Filter documents where attribute contains the value.

Parameters

attributeId	The attribute key.
value	The substring to match.

◆ queryContains() [2/2]

template<typename T >

void Queries::queryContains	(	const std::string	attributeId,
		std::list< T > &	value
	)

inline

Filter documents where attribute contains any value from list.

Template Parameters

T	Type of values in the list.

Parameters

attributeId	The attribute key.
value	List of values to check containment.

Definition at line 98 of file Query.hpp.

                                                                       {
        std::string query = "{\"method\":\"contains\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" +
                            listToString(value) + "]}";
        if (contains_iter == queries.end()) {
            queries.push_back(query);
            contains_iter = std::prev(queries.end());
            return;
        }
        *contains_iter = query;
    }

◆ queryCursorAfter()

void Queries::queryCursorAfter ( const std::string documentId )

Add a cursor query to paginate after the given document ID.

Parameters

documentId The document ID to start after.

◆ queryEndsWith()

void Queries::queryEndsWith	(	const std::string	attributeId,
		const std::string &	value
	)

Filter documents where attribute ends with given value.

Parameters

attributeId	The attribute key.
value	The ending value to match.

◆ queryEqual()

template<typename T >

void Queries::queryEqual	(	const std::string	attributeId,
		std::list< T > &	values
	)

inline

Filter documents where attribute equals any value in list.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
values	List of accepted values.

Definition at line 225 of file Query.hpp.

                                                                     {
        std::string query = "{\"method\":\"equal\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" +
                            listToString(values) + "]}";
        if (equal_iter == queries.end()) {
            queries.push_back(query);
            equal_iter = std::prev(queries.end());
            return;
        }
        *equal_iter = query;
    }

◆ queryGreaterThan()

template<typename T >

void Queries::queryGreaterThan	(	const std::string	attributeId,
		const T &	value
	)

inline

Filter documents where attribute is greater than value.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
value	The threshold.

Definition at line 165 of file Query.hpp.

                                                                       {
        std::ostringstream oss;
        append_encoded(oss, value);
        std::string query = "{\"method\":\"greaterThan\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" + oss.str() + "]}";
        if (greater_than_iter == queries.end()) {
            queries.push_back(query);
            greater_than_iter = std::prev(queries.end());
            return;
        }
        *greater_than_iter = query;
    }

◆ queryGreaterThanEqual()

template<typename T >

void Queries::queryGreaterThanEqual	(	const std::string	attributeId,
		const T &	value
	)

inline

Filter documents where attribute is greater than or equal to value.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
value	The lower bound.

Definition at line 144 of file Query.hpp.

                                                                            {
        std::ostringstream oss;
        oss << append_encoded(oss, value);
        std::string query =
            "{\"method\":\"greaterThanEqual\",\"attribute\":\"" + attributeId +
            "\",\"values\":[" + oss.str() + "]}";
        if (greater_than_equal_iter == queries.end()) {
            queries.push_back(query);
            greater_than_equal_iter = std::prev(queries.end());
            return;
        }
        *greater_than_equal_iter = query;
    }

◆ queryIsNotNull()

void Queries::queryIsNotNull ( const std::string attributeId )

Filter documents where an attribute is not null.

Parameters

attributeId The attribute key to filter.

◆ queryIsNull()

void Queries::queryIsNull ( const std::string attributeId )

Filter documents where an attribute is null.

Parameters

attributeId The attribute key to filter.

◆ queryLessThan()

template<typename T >

void Queries::queryLessThan	(	const std::string	attributeId,
		const T &	value
	)

inline

Filter documents where attribute is less than value.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
value	The threshold.

Definition at line 205 of file Query.hpp.

                                                                    {
        std::ostringstream oss;
        append_encoded(oss, value);
        std::string query = "{\"method\":\"lessThan\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" + oss.str() + "]}";
        if (less_than_iter == queries.end()) {
            queries.push_back(query);
            less_than_iter = std::prev(queries.end());
            return;
        }
        *less_than_iter = query;
    }

◆ queryLessThanEqual()

template<typename T >

void Queries::queryLessThanEqual	(	const std::string	attributeId,
		const T &	value
	)

inline

Filter documents where attribute is less than or equal to value.

Template Parameters

T	Value type.

Parameters

attributeId	The attribute key.
value	The upper bound.

Definition at line 185 of file Query.hpp.

                                                                         {
        std::ostringstream oss;
        append_encoded(oss, value);
        std::string query = "{\"method\":\"lessThanEqual\",\"attribute\":\"" +
                            attributeId + "\",\"values\":[" + oss.str() + "]}";
        if (less_than_equal_iter == queries.end()) {
            queries.push_back(query);
            less_than_equal_iter = std::prev(queries.end());
            return;
        }
        *less_than_equal_iter = query;
    }

◆ queryLimit()

void Queries::queryLimit ( int limit )

Limit the number of documents returned.

Parameters

limit The maximum number of documents.

◆ querySelect()

void Queries::querySelect ( std::list< std::string > & values )

Select only certain fields from the result.

Parameters

values List of field names to return.

◆ queryStartsWith()

void Queries::queryStartsWith	(	const std::string	attributeId,
		const std::string &	value
	)

Filter documents where attribute starts with given value.

Parameters

attributeId	The attribute key.
value	The starting value to match.

◆ removeJsonQuery()

bool Queries::removeJsonQuery ( int index )

Remove a JSON query by index.

Parameters

index The index of the query to remove.

Returns: True if the query was removed, false if index is invalid.

◆ reset()

void Queries::reset ( )

Resets the internal query list.

◆ to_string()

std::string Queries::to_string ( )

Serialize all added queries into a JSON string.

Returns: Combined query string.

The documentation for this class was generated from the following file:

Query.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Queries()

Member Function Documentation

◆ addComplexQuery()

◆ notEqual()

◆ queryBetween()

◆ queryContains() [1/2]

◆ queryContains() [2/2]

◆ queryCursorAfter()

◆ queryEndsWith()

◆ queryEqual()

◆ queryGreaterThan()

◆ queryGreaterThanEqual()

◆ queryIsNotNull()

◆ queryIsNull()

◆ queryLessThan()

◆ queryLessThanEqual()

◆ queryLimit()

◆ querySelect()

◆ queryStartsWith()

◆ removeJsonQuery()

◆ reset()

◆ to_string()