From d23c9eef2e1528af749a180af19b01ad50ac8dea Mon Sep 17 00:00:00 2001 From: Jeesun Kim Date: Fri, 30 Dec 2016 13:12:41 +0900 Subject: [PATCH] add performance comment for _for_snippet APIs Change-Id: Id295b3ceca861877659a6ec704d57418acfac9bd --- include/contacts_db.h | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/include/contacts_db.h b/include/contacts_db.h index ccbfffb..2fefcd9 100644 --- a/include/contacts_db.h +++ b/include/contacts_db.h @@ -30,7 +30,7 @@ extern "C" * @file contacts_db.h */ - + /** * @ingroup CAPI_SOCIAL_CONTACTS_SVC_MODULE * @defgroup CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE Database @@ -41,7 +41,7 @@ extern "C" * @{ */ - + /** * @brief Enumeration for contact change state. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif @@ -569,7 +569,7 @@ int contacts_db_get_changes_by_version(const char *view_uri, contacts_list_h *change_record_list, int *current_contacts_db_version); - + /** * @brief Finds records based on a given keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @endif @@ -672,7 +672,8 @@ int contacts_db_search_records_with_range(const char *view_uri, const char *keyw * @remarks You must release @a record_list using contacts_list_destroy(). \n * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. \n + * Because start match and end match is needed to be composed with keyword, this API performance is lower than contacts_db_search_records(). * @param[in] view_uri The view URI to get records * @param[in] keyword The keyword * @param[in] offset The index from which to get results @@ -705,7 +706,8 @@ int contacts_db_search_records_for_snippet(const char *view_uri, const char *key * @remarks You must release @a record_list using contacts_list_destroy(). \n * This API works only for @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_contact, \n * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned \n - * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. + * and @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. \n + * Because start match and end match is needed to be composed with keyword, this API performance is lower than contacts_db_search_records_with_query(). * @param[in] query The query handle to filter * @param[in] keyword The keyword * @param[in] offset The index from which to get results @@ -741,7 +743,8 @@ int contacts_db_search_records_with_query_for_snippet(contacts_query_h query, co * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_grouprel, @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_assigned, \n * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_group_not_assigned. These views can search records with range @ref CONTACTS_SEARCH_RANGE_NAME, @ref CONTACTS_SEARCH_RANGE_NUMBER, @ref CONTACTS_SEARCH_RANGE_DATA. \n * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_number can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_NUMBER.\n - * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. + * @ref CAPI_SOCIAL_CONTACTS_SVC_VIEW_MODULE_contacts_person_email can search records with @ref CONTACTS_SEARCH_RANGE_NAME and @ref CONTACTS_SEARCH_RANGE_EMAIL. \n + * Because start match and end match is needed to be composed with keyword, this API performance is lower than contacts_db_search_records_with_range(). * @param[in] view_uri The view URI * @param[in] keyword The keyword * @param[in] offset The index from which to get results @@ -857,7 +860,7 @@ int contacts_db_get_last_change_version(int *last_change_version); * @} */ - + #ifdef __cplusplus } #endif -- 2.7.4