lookup_products.h (4120B)
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 src/include/merchant-database/lookup_products.h 18 * @brief implementation of the lookup_products function for Postgres 19 * @author Iván Ávalos 20 */ 21 #ifndef MERCHANT_DATABASE_LOOKUP_PRODUCTS_H 22 #define MERCHANT_DATABASE_LOOKUP_PRODUCTS_H 23 24 #include <taler/taler_util.h> 25 #include <taler/taler_json_lib.h> 26 #include "merchantdb_lib.h" 27 28 29 struct TALER_MERCHANTDB_PostgresContext; 30 /* Callback typedefs */ 31 /** 32 * Typically called by `lookup_products`. 33 * 34 * @param cls a `json_t *` JSON array to build 35 * @param product_serial row ID of the product 36 * @param product_id ID of the product 37 */ 38 typedef void 39 (*TALER_MERCHANTDB_ProductsCallback)( 40 void *cls, 41 uint64_t product_serial, 42 const char *product_id); 43 44 /** 45 * Lookup all of the products the given instance has configured. 46 * 47 * @param pg database context 48 * @param instance_id instance to lookup products for 49 * @param offset transfer_serial number of the transfer we want to offset from 50 * @param limit number of entries to return, negative for descending, 51 * positive for ascending 52 * @param category_filter filter products by category, NULL to not filter; 53 * uses the Postgresql "LIKE" pattern matcher, so 54 * "%" stands for any sequence of zero or more characters, 55 * "_" stands for any single character; 56 * use "\%" and "\_" to exactly match "%" or "_". 57 * We will always use case-insensitive searches, for case-sensitive 58 * matching the client should filter the result set. 59 * @param name_filter filter products by name, NULL to not filter 60 * uses the Postgresql "LIKE" pattern matcher, so 61 * "%" stands for any sequence of zero or more characters, 62 * "_" stands for any single character 63 * use "\%" and "\_" to exactly match "%" or "_". 64 * We will always use case-insensitive searches, for case-sensitive 65 * matching the client should filter the result set. 66 * @param description_filter filter products by description, NULL to not filter 67 * uses the Postgresql "LIKE" pattern matcher, so 68 * "%" stands for any sequence of zero or more characters, 69 * "_" stands for any single character 70 * use "\%" and "\_" to exactly match "%" or "_". 71 * We will always use case-insensitive searches, for case-sensitive 72 * matching the client should filter the result set. 73 * @param product_group_id_filter only return products in where the 74 * product group ID matches the given ID, 0 to not filter 75 * @param cb function to call on all products found 76 * @param cb_cls closure for @a cb 77 * @return database result code 78 */ 79 enum GNUNET_DB_QueryStatus 80 TALER_MERCHANTDB_lookup_products (struct TALER_MERCHANTDB_PostgresContext *pg, 81 const char *instance_id, 82 uint64_t offset, 83 int64_t limit, 84 const char *category_filter, 85 const char *name_filter, 86 const char *description_filter, 87 uint64_t product_group_id_filter, 88 TALER_MERCHANTDB_ProductsCallback cb, 89 void *cb_cls); 90 91 #endif