Merge pull request #94 from duneanalytics/ping-frequency

Reduce ping_frequency
duneanalytics · Sep 22, 2023 · b510c97 · b510c97
2 parents 0578771 + fb225f9
commit b510c97
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ pip install dune-client
 
 # Example Usage
 
-## Quickstart: run_sql
+## Quickstart: run_query
 
 Export your `DUNE_API_KEY` (or place it in a `.env` file - as in
 here [.env.sample](./.env.sample) and `source .env`).

diff --git a/dune_client/api/extensions.py b/dune_client/api/extensions.py
@@ -24,7 +24,10 @@
 from dune_client.types import QueryParameter
 from dune_client.util import age_in_hours
 
+# This is the expiry time on old query results.
 THREE_MONTHS_IN_HOURS = 2191
+# Seconds between checking execution status
+POLL_FREQUENCY_SECONDS = 1
 
 
 class ExtendedAPI(ExecutionAPI, QueryAPI):
@@ -36,7 +39,7 @@ class ExtendedAPI(ExecutionAPI, QueryAPI):
     def run_query(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> ResultsResponse:
         """
@@ -50,7 +53,7 @@ def run_query(
     def run_query_csv(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> ExecutionResultCSV:
         """
@@ -64,7 +67,7 @@ def run_query_csv(
     def run_query_dataframe(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> Any:
         """
@@ -183,7 +186,7 @@ def run_sql(
     def refresh(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> ResultsResponse:
         """
@@ -197,7 +200,7 @@ def refresh(
     def refresh_csv(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> ExecutionResultCSV:
         """
@@ -211,7 +214,7 @@ def refresh_csv(
     def refresh_into_dataframe(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> Any:
         """
@@ -228,7 +231,7 @@ def refresh_into_dataframe(
     def _refresh(
         self,
         query: QueryBase,
-        ping_frequency: int = 5,
+        ping_frequency: int = POLL_FREQUENCY_SECONDS,
         performance: Optional[str] = None,
     ) -> str:
         """