ckanapi-harvesters 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

ckanapi_harvesters/builder/example/builder_example_test_sql.py

@@ -37,12 +37,33 @@ def run(ckan:CkanApi = None):
         ckan.api_help_show("datastore_search_sql")
     except CkanNotFoundError:
         print("No datastore_search_sql help")
+
     users_table_id = mdl.get_or_query_resource_id(ckan, "users.csv")
+    traces_table_id = mdl.get_or_query_resource_id(ckan, "traces.csv")
+
+    # datastore_search simple API
+    cursor = ckan.datastore_search_cursor(users_table_id, limit=1)
+    document = next(cursor)
+    user_id = document["user_id"]
+    cursor = ckan.datastore_search_cursor(traces_table_id, filters={"user_id": float(user_id)}, limit=10)
+    for document in cursor:
+        print(document)
+
     try:
         ckan.datastore_search_sql(f'SELECT * FROM "{users_table_id}"')
     except CkanSqlCapabilityError:
         print("datastore_search_sql is not accessible")
 
+    query = f"""
+    SELECT t.*, u.* FROM "{traces_table_id}" t
+    JOIN "{users_table_id}" u ON t.user_id = u.user_id
+    WHERE t.user_id = {user_id}
+    LIMIT 10
+    """
+    cursor = ckan.datastore_search_sql_cursor(query, return_df=False)
+    for document in cursor:
+        print(document)
+
     print("Tests done.")
 
 

ckanapi_harvesters/ckan_api/ckan_api_2_readonly.py

@@ -280,7 +280,7 @@ class CkanApiReadOnly(CkanApiMap):
     ### Search method ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     def _api_datastore_search_raw(self, resource_id:str, *, filters:dict=None, q:str=None, fields:List[str]=None,
                                   distinct:bool=None, sort:str=None, limit:int=None, offset:int=0, format:str=None,
-                                  params:dict=None, compute_len:int=False) -> CkanActionResponse:
+                                  params:dict=None, compute_len:bool=False) -> CkanActionResponse:
         """
         API call to datastore_search. Performs queries on the DataStore.
 
@@ -338,7 +338,8 @@ class CkanApiReadOnly(CkanApiMap):
             raise response.default_error(self)
 
     def _api_datastore_search_df(self, resource_id:str, *, filters:dict=None, q:str=None, fields:List[str]=None,
-                                 distinct:bool=None, sort:str=None, limit:int=None, offset:int=0, format:str=None, params:dict=None) -> pd.DataFrame:
+                                 distinct:bool=None, sort:str=None, limit:int=None, offset:int=0, format:str=None,
+                                 params:dict=None, compute_len:bool=True) -> pd.DataFrame:
         """
         Convert output of _api_datastore_search_raw to pandas DataFrame.
         """
@@ -486,6 +487,10 @@ class CkanApiReadOnly(CkanApiMap):
             params["limit"] = limit
         response = self._api_action_request(f"datastore_search_sql", method=RequestType.Post, params=params)
         if response.success:
+            if response.dry_run:
+                return response
+            else:
+                response.len = len(response.result["records"])
             return response
         elif response.status_code == 400 and response.success_json_loads and response.response.text == '"Bad request - Action name not known: datastore_search_sql"':
             raise CkanSqlCapabilityError(self, response)
@@ -659,7 +664,7 @@ class CkanApiReadOnly(CkanApiMap):
 
     def datastore_search_cursor(self, resource_id:str, *, filters:dict=None, q:str=None, fields:List[str]=None,
                                    distinct:bool=None, sort:str=None, limit:int=None, offset:int=0, params:dict=None,
-                                   search_all:bool=False, search_method:bool=True, format:str=None, return_df:bool=True) \
+                                   search_all:bool=False, search_method:bool=True, format:str=None, return_df:bool=False) \
             -> Generator[Union[pd.Series, Tuple[dict,dict], Tuple[list,dict], Tuple[str,dict]], Any, None]:
         """
         Cursor on rows
@@ -752,7 +757,7 @@ class CkanApiReadOnly(CkanApiMap):
         return self._api_datastore_search_sql_all_generator(sql, params=params, limit=limit, offset=offset, search_all=search_all, return_df=return_df)
 
     def datastore_search_sql_cursor(self, sql:str, *, params:dict=None, search_all:bool=False,
-                                    limit:int=None, offset:int=0, return_df:bool=True) \
+                                    limit:int=None, offset:int=0, return_df:bool=False) \
             -> Generator[Union[pd.Series,Tuple[dict,dict]], Any, None]:
         generator = self.datastore_search_sql_generator(sql, params=params, search_all=search_all,
                                                         limit=limit, offset=offset, return_df=return_df)

{ckanapi_harvesters-0.0.4.dist-info → ckanapi_harvesters-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ckanapi_harvesters
-Version: 0.0.4
+Version: 0.0.5
 Summary: Package helping to upload local resources to a CKAN server using the CKAN API. Metadata and the list of resources can be defined in an Excel spreadsheet. The package includes requests to download resources and checks metadata against formatting rules.
 Author-email: ifpen-gp <63413841+ifpen-gp@users.noreply.github.com>
 Maintainer-email: ifpen-gp <63413841+ifpen-gp@users.noreply.github.com>

{ckanapi_harvesters-0.0.4.dist-info → ckanapi_harvesters-0.0.5.dist-info}/RECORD

@@ -48,7 +48,7 @@ ckanapi_harvesters/builder/example/builder_example_download.py,sha256=teL6iusYbT
 ckanapi_harvesters/builder/example/builder_example_generate_data.py,sha256=dspJAdb0biAz_v159nWcDrVaG7uXs1DoXg6EmGQFmt4,3527
 ckanapi_harvesters/builder/example/builder_example_patch_upload.py,sha256=10iaJ78IBJTd-Uti-Q9TLFfz9tQw13UKwvSg9i5NrlM,1634
 ckanapi_harvesters/builder/example/builder_example_policy.py,sha256=-jy89E_z2Mp5SrsS7zd0Y4ubrQn67NHcVxWh6mDyUFQ,4593
-ckanapi_harvesters/builder/example/builder_example_test_sql.py,sha256=Qe4YuqQW1S9LyMjFU7nhaPw2fJwovatsyMYImKiyZI4,1595
+ckanapi_harvesters/builder/example/builder_example_test_sql.py,sha256=w-ed_-y45OVFS2En7WXVt6YKp64NLZd7zmWkbReDM-Y,2285
 ckanapi_harvesters/builder/example/builder_example_tests.py,sha256=1JxpKoYnRm35J9QW7asS5jSygUYEMv0C6s_wufm2pSg,2934
 ckanapi_harvesters/builder/example/builder_example_tests_offline.py,sha256=VcFxsnUjtkAFwdmSQaphaEPjMgzo6XR3Dubvxece_Yk,1773
 ckanapi_harvesters/builder/example/package/ckan-dpg.svg,sha256=YNk-H1EEu-ipdLt5Ik0nUmtXBqUSU_XoamAkFdOT65A,9683
@@ -65,7 +65,7 @@ ckanapi_harvesters/ckan_api/__init__.py,sha256=ZEe0P35WNVxhQPUCnaLRIfMBzbL44oOHy
 ckanapi_harvesters/ckan_api/ckan_api.py,sha256=_XmiDL89veF4LODisq1FwWOAkJuWpzynbIAUxKsv_ds,439
 ckanapi_harvesters/ckan_api/ckan_api_0_base.py,sha256=WjICbv1N1N-rIkwmh3D2U6GB5jG0HzNCN-_bhihFrJw,43253
 ckanapi_harvesters/ckan_api/ckan_api_1_map.py,sha256=4N9BE9dlImIdO_XOut7M5nwhe9IY-lvAjtXB9BDgJzs,52537
-ckanapi_harvesters/ckan_api/ckan_api_2_readonly.py,sha256=4g_Ny-6W7TPfx4WAza5XrF6WtqA1ERlu7qXTLa_AYVw,54803
+ckanapi_harvesters/ckan_api/ckan_api_2_readonly.py,sha256=VxZVhpTlfXGmSz0zFZG6gYykrmj4ddY7abXTjc5rHO4,55008
 ckanapi_harvesters/ckan_api/ckan_api_3_policy.py,sha256=zzm7CxYrwlrRWtQq62qJCzoHKM068Z5Fk65eMpv86Ik,11595
 ckanapi_harvesters/ckan_api/ckan_api_4_readwrite.py,sha256=L2WEHJiVq9J_uXgNDr3YDGi8l6HuMmabQAkpSXE2eZ4,30816
 ckanapi_harvesters/ckan_api/ckan_api_5_manage.py,sha256=KFfMjXmqLJZq0btyJVcfTPzKcFb_4psuQpMFVO9vDYI,65578
@@ -105,7 +105,7 @@ ckanapi_harvesters/policies/data_format_policy_lists.py,sha256=Lh_pYUvolW6QujaHd
 ckanapi_harvesters/policies/data_format_policy_tag_groups.py,sha256=KBxXm9hLgaiuJDTnP-ti2iZAyvf04uvUkIoo_Jqbpog,1341
 ckanapi_harvesters/reports/__init__.py,sha256=LuacieaFOyqaivLuaRAD7Umx0rE_Lz9jD7bL88XLonw,137
 ckanapi_harvesters/reports/admin_report.py,sha256=fSqNSLGe-XFmRQ6QanOm9VcAIbjDsiCNQSpVIGsH9XE,16773
-ckanapi_harvesters-0.0.4.dist-info/METADATA,sha256=slsQyNmYj47hGErq5cLt5eD3zjJy6qIfp88aiEfd3Ro,12564
-ckanapi_harvesters-0.0.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-ckanapi_harvesters-0.0.4.dist-info/top_level.txt,sha256=WvJprCJXBEK-Eew36dTdVdt9I_r4AdgA2Kur3RhLTPg,19
-ckanapi_harvesters-0.0.4.dist-info/RECORD,,
+ckanapi_harvesters-0.0.5.dist-info/METADATA,sha256=efgLQqp-wM1oZ8k7_ZId_OWPcL4JCNs2GTUFckAT8u0,12564
+ckanapi_harvesters-0.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+ckanapi_harvesters-0.0.5.dist-info/top_level.txt,sha256=WvJprCJXBEK-Eew36dTdVdt9I_r4AdgA2Kur3RhLTPg,19
+ckanapi_harvesters-0.0.5.dist-info/RECORD,,