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

definite_sdk/client.py

@@ -1,6 +1,7 @@
 import os
 from typing import Optional
 
+import requests
 from definite_sdk.integration import DefiniteIntegrationStore
 from definite_sdk.message import DefiniteMessageClient
 from definite_sdk.secret import DefiniteSecretStore
@@ -66,6 +67,55 @@ class DefiniteClient:
 
         return DefiniteSqlClient(self.api_key, self.api_url)
 
+    def attach_ducklake(self, alias: str = "lake") -> str:
+        """Generates SQL statements to attach DuckLake to a DuckDB connection.
+        
+        This method fetches the team's DuckLake integration credentials and generates
+        the necessary SQL statements to create a GCS secret and attach DuckLake.
+        
+        Args:
+            alias: The alias name for the attached DuckLake database (default: "lake")
+            
+        Returns:
+            str: SQL statements to execute for attaching DuckLake
+            
+        Example:
+            >>> client = DefiniteClient(os.environ["DEFINITE_API_KEY"])
+            >>> sql = client.attach_ducklake()
+            >>> conn.execute(sql)
+        """
+        # Fetch DuckLake integration details
+        response = requests.get(
+            f"{self.api_url}/v1/api/integration/DuckLake",
+            headers={"Authorization": f"Bearer {self.api_key}"},
+        )
+        response.raise_for_status()
+        dl_integration = response.json()
+        
+        # Generate SQL statements
+        create_secret_sql = f"""CREATE SECRET (
+    TYPE gcs,
+    KEY_ID '{dl_integration['gcs_access_key_id']}',
+    SECRET '{dl_integration['gcs_secret_access_key']}'
+);"""
+        
+        # Build PostgreSQL connection string
+        pg_conn_str = (
+            f"postgresql://{dl_integration['pg_user']}:"
+            f"{dl_integration['pg_password']}@"
+            f"{dl_integration['pg_host']}:"
+            f"{dl_integration['pg_port']}/"
+            f"{dl_integration['pg_database']}"
+        )
+        
+        attach_sql = (
+            f"ATTACH 'ducklake:postgres:{pg_conn_str}' AS {alias} "
+            f"(DATA_PATH 'gs://{dl_integration['gcs_bucket_path']}', "
+            f"METADATA_SCHEMA '{dl_integration['pg_schema']}');"
+        )
+        
+        return f"{create_secret_sql}\n\n{attach_sql}"
+
     # Alias methods for consistency
     def kv_store(self, name: str) -> DefiniteKVStore:
         """Alias for get_kv_store."""

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,9 +80,12 @@ class DefiniteSqlClient:
         return response.json()
 
     def execute_cube_query(
-        self, 
-        cube_query: Dict[str, Any], 
-        integration_id: Optional[str] = None
+        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.
@@ -93,6 +94,9 @@ class DefiniteSqlClient:
             cube_query (Dict[str, Any]): The Cube query in JSON format.
             integration_id (Optional[str]): The Cube integration ID to query against.
                 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.
@@ -106,21 +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.9.dist-info → definite_sdk-0.1.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: definite-sdk
-Version: 0.1.9
+Version: 0.1.12
 Summary: Definite SDK for Python
 License: MIT
 Author: Definite
@@ -59,6 +59,7 @@ client = DefiniteClient("YOUR_API_KEY")
 - **Integration Store**: Read-only access to integration configurations
 - **Messaging**: Send messages through various channels (Slack, and more coming soon)
 - **dlt Integration**: Run dlt pipelines with automatic state persistence to Definite
+- **DuckLake Integration**: Easy attachment of your team's DuckLake to DuckDB connections
 - **DuckDB Support**: Automatic discovery and connection to team's DuckDB integrations
 
 ## Basic Usage
@@ -231,6 +232,39 @@ pipeline.run(orders())
 last_cursor = pipeline.get_state("orders")
 ```
 
+### DuckLake Integration
+
+Attach your team's DuckLake to a DuckDB connection for seamless data access:
+
+```python
+import duckdb
+from definite_sdk import DefiniteClient
+
+# Initialize the client
+client = DefiniteClient("YOUR_API_KEY")
+
+# Connect to DuckDB and attach DuckLake
+conn = duckdb.connect()
+conn.execute(client.attach_ducklake())
+
+# Now you can use DuckLake tables
+conn.execute("CREATE SCHEMA IF NOT EXISTS lake.my_schema;")
+conn.execute("CREATE OR REPLACE TABLE lake.my_schema.users AS SELECT * FROM df")
+
+# Query your DuckLake data
+result = conn.sql("SELECT * FROM lake.my_schema.users").df()
+```
+
+You can also specify a custom alias for the attached DuckLake:
+
+```python
+# Attach with custom alias
+conn.execute(client.attach_ducklake(alias="warehouse"))
+
+# Use the custom alias
+conn.execute("SELECT * FROM warehouse.my_schema.users")
+```
+
 ### DuckDB Integration Discovery
 
 ```python

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

@@ -1,13 +1,13 @@
 definite_sdk/__init__.py,sha256=Y3GwfDOkpWt6EILoZ7PRT7nXuoVnk0zHrNOPHlkEHS4,604
-definite_sdk/client.py,sha256=2wRrFFwMMeGfP5riaEGhCLk1OiyBsJj_uMqFb3hIooY,3199
+definite_sdk/client.py,sha256=mpXFpJVmK3JVYsNrn7f4bzqlxMbIsS3meRu3XMiXWZ4,5075
 definite_sdk/dlt.py,sha256=JC-S1jd6zqnpGSnvk9kYb8GQ1IPZRd1zVKTVYAbeA4w,7188
 definite_sdk/integration.py,sha256=v15QIpWm3eAZr-cmavfA39LXTjpskEEQ2SM_TBV4E1U,3395
 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=K5cPXM7B60Fzd8CyI-B4rXwK7hLpLT1Z8XZSZJjSogQ,3878
+definite_sdk/sql.py,sha256=o2ume-S7__wp8hMBy2aC6dmGYV4s-IXMlMAyEuyAP84,4705
 definite_sdk/store.py,sha256=7VYvROIrlWyM_ZX3LpqWWAfVLNDm0XMccMLv6qi9id8,5575
-definite_sdk-0.1.9.dist-info/LICENSE,sha256=jMd7PtwNWiMoGIDgFutC1v4taO69W9SRZLKe9o470Vk,1064
-definite_sdk-0.1.9.dist-info/METADATA,sha256=jZfdfG0EFt7kfN6HpbSCnAzhZHBrEy7SV7WKH-K0LVU,8196
-definite_sdk-0.1.9.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-definite_sdk-0.1.9.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,,