datus-snowflake 0.1.0__tar.gz

datus_snowflake-0.1.0/.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# uv
+uv.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db

datus_snowflake-0.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: datus-snowflake
+Version: 0.1.0
+Summary: Snowflake adapter for Datus Agent
+Author-email: DatusAI <support@datus.ai>
+License: Apache-2.0
+Requires-Python: >=3.8
+Requires-Dist: datus-agent>0.2.1
+Requires-Dist: snowflake-connector-python>=3.6.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Datus Snowflake Adapter
+
+Snowflake database adapter for Datus Agent, providing native Snowflake connector support.
+
+## Features
+
+- **Native Snowflake SDK**: Uses `snowflake-connector-python` for optimal performance
+- **Full Snowflake Support**: Databases, schemas, tables, views, and materialized views
+- **Efficient Metadata Retrieval**: Uses SHOW commands for fast metadata queries
+- **Arrow-based Execution**: High-performance query execution with Apache Arrow
+- **Multiple Result Formats**: CSV, Pandas DataFrame, Arrow Table, and Python list
+- **Complete CRUD Operations**: INSERT, UPDATE, DELETE, and DDL support
+
+## Installation
+
+```bash
+pip install datus-snowflake
+```
+
+This will automatically install the required dependencies:
+- `datus-agent>=0.3.0`
+- `snowflake-connector-python>=3.6.0`
+
+## Usage
+
+### Basic Connection
+
+```python
+from datus_snowflake import SnowflakeConnector
+
+# Create connector
+connector = SnowflakeConnector(
+    account="myaccount",
+    user="myuser",
+    password="mypassword",
+    warehouse="my_warehouse",
+    database="my_database",
+    schema="my_schema"
+)
+
+# Test connection
+result = connector.test_connection()
+print(result)  # {'success': True, 'message': 'Connection successful', 'databases': ''}
+```
+
+### Execute Queries
+
+```python
+# Execute query and get CSV result
+result = connector.execute_query("SELECT * FROM users LIMIT 10")
+print(result.sql_return)  # CSV string
+
+# Execute query and get pandas DataFrame
+result = connector.execute_query("SELECT * FROM users LIMIT 10", result_format="pandas")
+df = result.sql_return
+print(df.head())
+
+# Execute query and get Arrow table
+result = connector.execute_query("SELECT * FROM users LIMIT 10", result_format="arrow")
+arrow_table = result.sql_return
+print(arrow_table.schema)
+```
+
+### Metadata Operations
+
+```python
+# Get databases
+databases = connector.get_databases()
+print(f"Databases: {databases}")
+
+# Get schemas
+schemas = connector.get_schemas(database_name="my_database")
+print(f"Schemas: {schemas}")
+
+# Get tables
+tables = connector.get_tables(database_name="my_database", schema_name="public")
+print(f"Tables: {tables}")
+
+# Get views
+views = connector.get_views(database_name="my_database", schema_name="public")
+print(f"Views: {views}")
+
+# Get materialized views
+mvs = connector.get_materialized_views(database_name="my_database", schema_name="public")
+print(f"Materialized Views: {mvs}")
+```
+
+### Get Table Schema
+
+```python
+# Get table structure
+schema = connector.get_schema(
+    database_name="my_database",
+    schema_name="public",
+    table_name="users"
+)
+
+for column in schema[:-1]:  # Last item is table metadata
+    print(f"{column['name']}: {column['type']} (nullable: {column['nullable']})")
+```
+
+### Get DDL Definitions
+
+```python
+# Get tables with DDL
+tables_with_ddl = connector.get_tables_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+
+for table in tables_with_ddl:
+    print(f"\nTable: {table['table_name']}")
+    print(f"DDL:\n{table['definition']}")
+
+# Get views with DDL
+views_with_ddl = connector.get_views_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+
+# Get materialized views with DDL
+mvs_with_ddl = connector.get_materialized_views_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+```
+
+### Get Sample Data
+
+```python
+# Get sample rows from specific tables
+samples = connector.get_sample_rows(
+    tables=["users", "orders"],
+    top_n=5,
+    database_name="my_database",
+    schema_name="public"
+)
+
+for sample in samples:
+    print(f"\nTable: {sample['table_name']}")
+    print(sample['sample_rows'])  # CSV format
+```
+
+### CRUD Operations
+
+```python
+# INSERT
+result = connector.execute_insert(
+    "INSERT INTO users (name, email) VALUES ('John', 'john@example.com')"
+)
+print(f"Inserted rows: {result.row_count}")
+
+# UPDATE
+result = connector.execute_update(
+    "UPDATE users SET email = 'newemail@example.com' WHERE name = 'John'"
+)
+print(f"Updated rows: {result.row_count}")
+
+# DELETE
+result = connector.execute_delete(
+    "DELETE FROM users WHERE name = 'John'"
+)
+print(f"Deleted rows: {result.row_count}")
+
+# DDL
+result = connector.execute_ddl(
+    "CREATE TABLE test_table (id INT, name VARCHAR(100))"
+)
+print(f"DDL executed: {result.success}")
+```
+
+### Context Switching
+
+```python
+# Switch database
+connector.do_switch_context(database_name="another_database")
+
+# Switch schema
+connector.do_switch_context(
+    database_name="my_database",
+    schema_name="another_schema"
+)
+```
+
+## Configuration with Datus Agent
+
+When using with Datus Agent, the adapter is automatically discovered via entry points:
+
+```yaml
+# config.yaml
+database:
+  type: snowflake
+  account: myaccount
+  username: myuser
+  password: mypassword
+  warehouse: my_warehouse
+  database: my_database
+  schema: my_schema
+```
+
+The adapter will be automatically loaded when you use `type: snowflake`.
+
+## Architecture
+
+This adapter:
+- Inherits from `BaseSqlConnector` in `datus-agent`
+- Uses native Snowflake connector for optimal performance
+- Implements all required abstract methods
+- Provides Snowflake-specific optimizations (SHOW commands, Arrow format)
+
+## Development
+
+```bash
+# Install in development mode
+cd datus-snowflake
+pip install -e .
+
+# Run tests
+pytest tests/
+```
+
+## License
+
+Apache License 2.0

datus_snowflake-0.1.0/README.md

@@ -0,0 +1,224 @@
+# Datus Snowflake Adapter
+
+Snowflake database adapter for Datus Agent, providing native Snowflake connector support.
+
+## Features
+
+- **Native Snowflake SDK**: Uses `snowflake-connector-python` for optimal performance
+- **Full Snowflake Support**: Databases, schemas, tables, views, and materialized views
+- **Efficient Metadata Retrieval**: Uses SHOW commands for fast metadata queries
+- **Arrow-based Execution**: High-performance query execution with Apache Arrow
+- **Multiple Result Formats**: CSV, Pandas DataFrame, Arrow Table, and Python list
+- **Complete CRUD Operations**: INSERT, UPDATE, DELETE, and DDL support
+
+## Installation
+
+```bash
+pip install datus-snowflake
+```
+
+This will automatically install the required dependencies:
+- `datus-agent>=0.3.0`
+- `snowflake-connector-python>=3.6.0`
+
+## Usage
+
+### Basic Connection
+
+```python
+from datus_snowflake import SnowflakeConnector
+
+# Create connector
+connector = SnowflakeConnector(
+    account="myaccount",
+    user="myuser",
+    password="mypassword",
+    warehouse="my_warehouse",
+    database="my_database",
+    schema="my_schema"
+)
+
+# Test connection
+result = connector.test_connection()
+print(result)  # {'success': True, 'message': 'Connection successful', 'databases': ''}
+```
+
+### Execute Queries
+
+```python
+# Execute query and get CSV result
+result = connector.execute_query("SELECT * FROM users LIMIT 10")
+print(result.sql_return)  # CSV string
+
+# Execute query and get pandas DataFrame
+result = connector.execute_query("SELECT * FROM users LIMIT 10", result_format="pandas")
+df = result.sql_return
+print(df.head())
+
+# Execute query and get Arrow table
+result = connector.execute_query("SELECT * FROM users LIMIT 10", result_format="arrow")
+arrow_table = result.sql_return
+print(arrow_table.schema)
+```
+
+### Metadata Operations
+
+```python
+# Get databases
+databases = connector.get_databases()
+print(f"Databases: {databases}")
+
+# Get schemas
+schemas = connector.get_schemas(database_name="my_database")
+print(f"Schemas: {schemas}")
+
+# Get tables
+tables = connector.get_tables(database_name="my_database", schema_name="public")
+print(f"Tables: {tables}")
+
+# Get views
+views = connector.get_views(database_name="my_database", schema_name="public")
+print(f"Views: {views}")
+
+# Get materialized views
+mvs = connector.get_materialized_views(database_name="my_database", schema_name="public")
+print(f"Materialized Views: {mvs}")
+```
+
+### Get Table Schema
+
+```python
+# Get table structure
+schema = connector.get_schema(
+    database_name="my_database",
+    schema_name="public",
+    table_name="users"
+)
+
+for column in schema[:-1]:  # Last item is table metadata
+    print(f"{column['name']}: {column['type']} (nullable: {column['nullable']})")
+```
+
+### Get DDL Definitions
+
+```python
+# Get tables with DDL
+tables_with_ddl = connector.get_tables_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+
+for table in tables_with_ddl:
+    print(f"\nTable: {table['table_name']}")
+    print(f"DDL:\n{table['definition']}")
+
+# Get views with DDL
+views_with_ddl = connector.get_views_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+
+# Get materialized views with DDL
+mvs_with_ddl = connector.get_materialized_views_with_ddl(
+    database_name="my_database",
+    schema_name="public"
+)
+```
+
+### Get Sample Data
+
+```python
+# Get sample rows from specific tables
+samples = connector.get_sample_rows(
+    tables=["users", "orders"],
+    top_n=5,
+    database_name="my_database",
+    schema_name="public"
+)
+
+for sample in samples:
+    print(f"\nTable: {sample['table_name']}")
+    print(sample['sample_rows'])  # CSV format
+```
+
+### CRUD Operations
+
+```python
+# INSERT
+result = connector.execute_insert(
+    "INSERT INTO users (name, email) VALUES ('John', 'john@example.com')"
+)
+print(f"Inserted rows: {result.row_count}")
+
+# UPDATE
+result = connector.execute_update(
+    "UPDATE users SET email = 'newemail@example.com' WHERE name = 'John'"
+)
+print(f"Updated rows: {result.row_count}")
+
+# DELETE
+result = connector.execute_delete(
+    "DELETE FROM users WHERE name = 'John'"
+)
+print(f"Deleted rows: {result.row_count}")
+
+# DDL
+result = connector.execute_ddl(
+    "CREATE TABLE test_table (id INT, name VARCHAR(100))"
+)
+print(f"DDL executed: {result.success}")
+```
+
+### Context Switching
+
+```python
+# Switch database
+connector.do_switch_context(database_name="another_database")
+
+# Switch schema
+connector.do_switch_context(
+    database_name="my_database",
+    schema_name="another_schema"
+)
+```
+
+## Configuration with Datus Agent
+
+When using with Datus Agent, the adapter is automatically discovered via entry points:
+
+```yaml
+# config.yaml
+database:
+  type: snowflake
+  account: myaccount
+  username: myuser
+  password: mypassword
+  warehouse: my_warehouse
+  database: my_database
+  schema: my_schema
+```
+
+The adapter will be automatically loaded when you use `type: snowflake`.
+
+## Architecture
+
+This adapter:
+- Inherits from `BaseSqlConnector` in `datus-agent`
+- Uses native Snowflake connector for optimal performance
+- Implements all required abstract methods
+- Provides Snowflake-specific optimizations (SHOW commands, Arrow format)
+
+## Development
+
+```bash
+# Install in development mode
+cd datus-snowflake
+pip install -e .
+
+# Run tests
+pytest tests/
+```
+
+## License
+
+Apache License 2.0

datus_snowflake-0.1.0/datus_snowflake/__init__.py

@@ -0,0 +1,18 @@
+"""Snowflake adapter for Datus Agent."""
+
+from datus.tools.db_tools import connector_registry
+
+from .config import SnowflakeConfig
+from .connector import SnowflakeConnector
+
+__version__ = "0.1.0"
+__all__ = ["SnowflakeConnector", "SnowflakeConfig", "register"]
+
+
+def register():
+    """Register Snowflake connector with Datus registry."""
+    connector_registry.register("snowflake", SnowflakeConnector)
+
+
+# Auto-register when imported
+register()

datus_snowflake-0.1.0/datus_snowflake/config.py

@@ -0,0 +1,22 @@
+# Copyright 2025-present DatusAI, Inc.
+# Licensed under the Apache License, Version 2.0.
+# See http://www.apache.org/licenses/LICENSE-2.0 for details.
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class SnowflakeConfig(BaseModel):
+    """Snowflake-specific configuration."""
+
+    model_config = ConfigDict(extra="forbid", populate_by_name=True)
+
+    account: str = Field(..., description="Snowflake account identifier")
+    username: str = Field(..., description="Snowflake username")
+    password: str = Field(..., description="Snowflake password")
+    warehouse: str = Field(..., description="Snowflake warehouse name")
+    database: Optional[str] = Field(default=None, description="Default database name")
+    schema_name: Optional[str] = Field(default=None, alias="schema", description="Default schema name")
+    role: Optional[str] = Field(default=None, description="Snowflake role to use")
+    timeout_seconds: int = Field(default=30, description="Connection timeout in seconds")