definite-sdk 0.1.11__py3-none-any.whl → 0.1.12__py3-none-any.whl

definite_sdk/sql.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, Optional
 
 import requests
 
@@ -31,7 +31,9 @@ class DefiniteSqlClient:
     ...     "timeDimensions": [{"dimension": "sales.date", "granularity": "month"}],
     ...     "limit": 1000
     ... }
-    >>> result = sql_client.execute_cube_query(cube_query, integration_id="my_cube_integration")
+    >>> result = sql_client.execute_cube_query(
+    ...     cube_query, integration_id="my_cube_integration"
+    ... )
     >>> print(result)
     """
 
@@ -46,11 +48,7 @@ class DefiniteSqlClient:
         self._api_key = api_key
         self._sql_url = api_url + SQL_ENDPOINT
 
-    def execute(
-        self, 
-        sql: str, 
-        integration_id: Optional[str] = None
-    ) -> Dict[str, Any]:
+    def execute(self, sql: str, integration_id: Optional[str] = None) -> Dict[str, Any]:
         """
         Executes a SQL query against a database integration.
 
@@ -69,7 +67,7 @@ class DefiniteSqlClient:
             >>> result = sql_client.execute("SELECT COUNT(*) FROM users")
             >>> print(result)
         """
-        payload = {"sql": sql}
+        payload: Dict[str, Any] = {"sql": sql}
         if integration_id:
             payload["integration_id"] = integration_id
 
@@ -82,11 +80,12 @@ class DefiniteSqlClient:
         return response.json()
 
     def execute_cube_query(
-        self, 
-        cube_query: Dict[str, Any], 
+        self,
+        cube_query: Dict[str, Any],
         integration_id: Optional[str] = None,
         persist: bool = True,
         invalidate: bool = False,
+        raw: bool = False,
     ) -> Dict[str, Any]:
         """
         Executes a Cube query against a Cube integration.
@@ -97,6 +96,7 @@ class DefiniteSqlClient:
                 If not provided, the default integration will be used.
             persist (bool): Whether to persist the query result to the cache.
             invalidate (bool): Whether to invalidate the cached result.
+            raw (bool): Whether to return raw/unformatted cube results.
 
         Returns:
             Dict[str, Any]: The query result as returned by the API.
@@ -110,24 +110,38 @@ class DefiniteSqlClient:
             ...     "measures": ["sales.total_amount"],
             ...     "timeDimensions": [{
             ...         "dimension": "sales.date",
-            ...         "granularity": "month"
+            ...         "granularity": "month",
             ...     }],
             ...     "limit": 1000
             ... }
-            >>> result = sql_client.execute_cube_query(cube_query, "my_cube_integration")
+            >>> result = sql_client.execute_cube_query(
+            ...     cube_query, "my_cube_integration"
+            ... )
             >>> print(result)
+
+            >>> # To get raw/unformatted results:
+            >>> raw_result = sql_client.execute_cube_query(
+            ...     cube_query, "my_cube_integration", raw=True
+            ... )
+            >>> print(raw_result)
         """
-        payload = {"cube_query": cube_query}
+        payload: Dict[str, Any] = {"cube_query": cube_query}
         if integration_id:
             payload["integration_id"] = integration_id
         if persist:
             payload["persist"] = persist
         if invalidate:
             payload["invalidate"] = invalidate
+
+        # Build URL with query parameters
+        url = self._sql_url
+        if raw:
+            url += "?raw=true"
+
         response = requests.post(
-            self._sql_url,
+            url,
             json=payload,
             headers={"Authorization": "Bearer " + self._api_key},
         )
         response.raise_for_status()
-        return response.json()
+        return response.json()

{definite_sdk-0.1.11.dist-info → definite_sdk-0.1.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: definite-sdk
-Version: 0.1.11
+Version: 0.1.12
 Summary: Definite SDK for Python
 License: MIT
 Author: Definite

{definite_sdk-0.1.11.dist-info → definite_sdk-0.1.12.dist-info}/RECORD

@@ -5,9 +5,9 @@ definite_sdk/integration.py,sha256=v15QIpWm3eAZr-cmavfA39LXTjpskEEQ2SM_TBV4E1U,3
 definite_sdk/message.py,sha256=I3qx2v9gIcC9NZyr5zEp_Seft8clRoER4WeUbAaDiFc,6549
 definite_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 definite_sdk/secret.py,sha256=3wvEnTZ946hOxJBdB29dxvppwJ0x-TJV_LxRcXGqtis,2503
-definite_sdk/sql.py,sha256=nVPUuQy4zLMoeUe9bRgU1eMmIJBwlNCNXZm2tO0M8sw,4223
+definite_sdk/sql.py,sha256=o2ume-S7__wp8hMBy2aC6dmGYV4s-IXMlMAyEuyAP84,4705
 definite_sdk/store.py,sha256=7VYvROIrlWyM_ZX3LpqWWAfVLNDm0XMccMLv6qi9id8,5575
-definite_sdk-0.1.11.dist-info/LICENSE,sha256=jMd7PtwNWiMoGIDgFutC1v4taO69W9SRZLKe9o470Vk,1064
-definite_sdk-0.1.11.dist-info/METADATA,sha256=Xvh6IRpK-0vcD1mY814f_otQpY-300jXxRHR-cXtWro,9136
-definite_sdk-0.1.11.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-definite_sdk-0.1.11.dist-info/RECORD,,
+definite_sdk-0.1.12.dist-info/LICENSE,sha256=jMd7PtwNWiMoGIDgFutC1v4taO69W9SRZLKe9o470Vk,1064
+definite_sdk-0.1.12.dist-info/METADATA,sha256=mR32ZrkWtX_q7BBMF6dtE2f2lHicy2SBo1lkMxOTFto,9136
+definite_sdk-0.1.12.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+definite_sdk-0.1.12.dist-info/RECORD,,