pg_lookup_products.h (3370B)
1 /* 2 This file is part of TALER 3 Copyright (C) 2022 Taler Systems SA 4 5 TALER is free software; you can redistribute it and/or modify it under the 6 terms of the GNU General Public License as published by the Free Software 7 Foundation; either version 3, or (at your option) any later version. 8 9 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU General Public License for more details. 12 13 You should have received a copy of the GNU General Public License along with 14 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 */ 16 /** 17 * @file backenddb/pg_lookup_products.h 18 * @brief implementation of the lookup_products function for Postgres 19 * @author Iván Ávalos 20 */ 21 #ifndef PG_LOOKUP_PRODUCTS_H 22 #define PG_LOOKUP_PRODUCTS_H 23 24 #include <taler/taler_util.h> 25 #include <taler/taler_json_lib.h> 26 #include "taler_merchantdb_plugin.h" 27 28 /** 29 * Lookup all of the products the given instance has configured. 30 * 31 * @param cls closure 32 * @param instance_id instance to lookup products for 33 * @param offset transfer_serial number of the transfer we want to offset from 34 * @param limit number of entries to return, negative for descending, 35 * positive for ascending 36 * @param category_filter filter products by category, NULL to not filter; 37 * uses the Postgresql "LIKE" pattern matcher, so 38 * "%" stands for any sequence of zero or more characters, 39 * "_" stands for any single character; 40 * use "\%" and "\_" to exactly match "%" or "_". 41 * We will always use case-insensitive searches, for case-sensitive 42 * matching the client should filter the result set. 43 * @param name_filter filter products by name, NULL to not filter 44 * uses the Postgresql "LIKE" pattern matcher, so 45 * "%" stands for any sequence of zero or more characters, 46 * "_" stands for any single character 47 * use "\%" and "\_" to exactly match "%" or "_". 48 * We will always use case-insensitive searches, for case-sensitive 49 * matching the client should filter the result set. 50 * @param description_filter filter products by description, NULL to not filter 51 * uses the Postgresql "LIKE" pattern matcher, so 52 * "%" stands for any sequence of zero or more characters, 53 * "_" stands for any single character 54 * use "\%" and "\_" to exactly match "%" or "_". 55 * We will always use case-insensitive searches, for case-sensitive 56 * matching the client should filter the result set. 57 * @param cb function to call on all products found 58 * @param cb_cls closure for @a cb 59 * @return database result code 60 */ 61 enum GNUNET_DB_QueryStatus 62 TMH_PG_lookup_products (void *cls, 63 const char *instance_id, 64 uint64_t offset, 65 int64_t limit, 66 const char *category_filter, 67 const char *name_filter, 68 const char *description_filter, 69 TALER_MERCHANTDB_ProductsCallback cb, 70 void *cb_cls); 71 72 #endif