datus-doris 0.1.0__tar.gz

datus_doris-0.1.0/.gitignore

@@ -0,0 +1,143 @@
+# 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
+
+
+.omc
+
+uv.toml
+*/uv.toml

datus_doris-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: datus-doris
+Version: 0.1.0
+Summary: Doris database adapter for Datus
+Project-URL: Homepage, https://github.com/Datus-ai/datus-db-adapters
+Project-URL: Repository, https://github.com/Datus-ai/datus-db-adapters
+Project-URL: Issues, https://github.com/Datus-ai/datus-db-adapters/issues
+Author-email: DatusAI <support@datus.ai>
+License: Apache-2.0
+Keywords: adapter,database,datus,doris
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: datus-db-core>=0.1.5
+Requires-Dist: datus-mysql>=0.1.8
+Requires-Dist: datus-sqlalchemy>=0.1.7
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pymysql>=1.1.1
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# datus-doris
+
+Apache Doris database adapter for Datus.
+
+## Features
+
+- MySQL-protocol connection and SQL execution
+- Multi-catalog discovery and context switching
+- Catalog-aware table, view, schema, and sample-row metadata
+- Asynchronous materialized-view discovery and DDL retrieval
+- Three-part identifiers: `catalog.database.table`
+- Doris migration capability, table-layout, and type-mapping guidance
+- List, CSV, Pandas, and Arrow result formats inherited from `datus-mysql`
+
+## Installation
+
+```bash
+pip install datus-doris
+```
+
+The package installs `datus-db-core` and `datus-mysql` as dependencies and
+registers the `doris` adapter through the `datus.adapters` entry-point group.
+
+## Configuration
+
+```yaml
+database:
+  type: doris
+  host: localhost
+  port: 9030
+  username: root
+  password: ""
+  catalog: internal
+  database: analytics
+```
+
+The built-in catalog is `internal`. External catalogs, including Hive Metastore
+catalogs, can be selected through the same connector API.
+
+## Python API
+
+```python
+from datus_doris import DorisConfig, DorisConnector
+
+config = DorisConfig(
+    host="localhost",
+    port=9030,
+    username="root",
+    password="",
+    catalog="internal",
+    database="analytics",
+)
+
+with DorisConnector(config) as connector:
+    catalogs = connector.get_catalogs()
+    tables = connector.get_tables(database_name="analytics")
+    views = connector.get_views(database_name="analytics")
+    materialized_views = connector.get_materialized_views_with_ddl(
+        database_name="analytics"
+    )
+    result = connector.execute_query("SELECT 1")
+```
+
+Catalog context can be switched explicitly:
+
+```python
+connector.switch_catalog("hive_catalog")
+databases = connector.get_databases()
+connector.switch_catalog("internal")
+```
+
+Fully qualified identifiers are rendered as Doris three-part names:
+
+```python
+connector.full_name(
+    catalog_name="internal",
+    database_name="analytics",
+    table_name="events",
+)
+# `internal`.`analytics`.`events`
+```
+
+## Development and testing
+
+Unit tests do not require a database:
+
+```bash
+ci/run-unit-tests.sh datus-doris
+```
+
+The repository integration runner starts Apache Doris FE/BE 4.0.7 and Hive
+Metastore 4.0.1, waits for an alive backend and a successful OLAP DDL probe,
+runs the complete integration suite, and removes the test services afterward:
+
+```bash
+ci/run-integration-tests.sh doris
+```
+
+To run the package-local workflow manually:
+
+```bash
+cd datus-doris
+docker compose up -d --wait
+./scripts/test.sh integration
+docker compose down -v
+```
+
+The integration suite covers catalog operations, Hive external catalogs,
+tables, views, asynchronous materialized views, DDL/DML, sample rows, TPC-H
+queries, and list/CSV/Pandas/Arrow output.
+
+### Environment variables
+
+| Variable | Default | Description |
+| --- | --- | --- |
+| `DORIS_HOST` | `localhost` | FE query host |
+| `DORIS_PORT` | `9030` | MySQL protocol port |
+| `DORIS_USER` | `root` | Username |
+| `DORIS_PASSWORD` | empty | Password |
+| `DORIS_CATALOG` | `internal` | Initial catalog |
+| `DORIS_DATABASE` | `test` | Test database |
+| `DORIS_FE_JAVA_XMS` | `1024m` | Initial FE JVM heap for the Docker test environment |
+| `DORIS_FE_JAVA_XMX` | `2048m` | Maximum FE JVM heap for the Docker test environment |
+| `HIVE_METASTORE_URI` | `thrift://hive-metastore:9083` | Hive catalog metastore URI |
+
+## License
+
+Apache License 2.0

datus_doris-0.1.0/README.md

@@ -0,0 +1,128 @@
+# datus-doris
+
+Apache Doris database adapter for Datus.
+
+## Features
+
+- MySQL-protocol connection and SQL execution
+- Multi-catalog discovery and context switching
+- Catalog-aware table, view, schema, and sample-row metadata
+- Asynchronous materialized-view discovery and DDL retrieval
+- Three-part identifiers: `catalog.database.table`
+- Doris migration capability, table-layout, and type-mapping guidance
+- List, CSV, Pandas, and Arrow result formats inherited from `datus-mysql`
+
+## Installation
+
+```bash
+pip install datus-doris
+```
+
+The package installs `datus-db-core` and `datus-mysql` as dependencies and
+registers the `doris` adapter through the `datus.adapters` entry-point group.
+
+## Configuration
+
+```yaml
+database:
+  type: doris
+  host: localhost
+  port: 9030
+  username: root
+  password: ""
+  catalog: internal
+  database: analytics
+```
+
+The built-in catalog is `internal`. External catalogs, including Hive Metastore
+catalogs, can be selected through the same connector API.
+
+## Python API
+
+```python
+from datus_doris import DorisConfig, DorisConnector
+
+config = DorisConfig(
+    host="localhost",
+    port=9030,
+    username="root",
+    password="",
+    catalog="internal",
+    database="analytics",
+)
+
+with DorisConnector(config) as connector:
+    catalogs = connector.get_catalogs()
+    tables = connector.get_tables(database_name="analytics")
+    views = connector.get_views(database_name="analytics")
+    materialized_views = connector.get_materialized_views_with_ddl(
+        database_name="analytics"
+    )
+    result = connector.execute_query("SELECT 1")
+```
+
+Catalog context can be switched explicitly:
+
+```python
+connector.switch_catalog("hive_catalog")
+databases = connector.get_databases()
+connector.switch_catalog("internal")
+```
+
+Fully qualified identifiers are rendered as Doris three-part names:
+
+```python
+connector.full_name(
+    catalog_name="internal",
+    database_name="analytics",
+    table_name="events",
+)
+# `internal`.`analytics`.`events`
+```
+
+## Development and testing
+
+Unit tests do not require a database:
+
+```bash
+ci/run-unit-tests.sh datus-doris
+```
+
+The repository integration runner starts Apache Doris FE/BE 4.0.7 and Hive
+Metastore 4.0.1, waits for an alive backend and a successful OLAP DDL probe,
+runs the complete integration suite, and removes the test services afterward:
+
+```bash
+ci/run-integration-tests.sh doris
+```
+
+To run the package-local workflow manually:
+
+```bash
+cd datus-doris
+docker compose up -d --wait
+./scripts/test.sh integration
+docker compose down -v
+```
+
+The integration suite covers catalog operations, Hive external catalogs,
+tables, views, asynchronous materialized views, DDL/DML, sample rows, TPC-H
+queries, and list/CSV/Pandas/Arrow output.
+
+### Environment variables
+
+| Variable | Default | Description |
+| --- | --- | --- |
+| `DORIS_HOST` | `localhost` | FE query host |
+| `DORIS_PORT` | `9030` | MySQL protocol port |
+| `DORIS_USER` | `root` | Username |
+| `DORIS_PASSWORD` | empty | Password |
+| `DORIS_CATALOG` | `internal` | Initial catalog |
+| `DORIS_DATABASE` | `test` | Test database |
+| `DORIS_FE_JAVA_XMS` | `1024m` | Initial FE JVM heap for the Docker test environment |
+| `DORIS_FE_JAVA_XMX` | `2048m` | Maximum FE JVM heap for the Docker test environment |
+| `HIVE_METASTORE_URI` | `thrift://hive-metastore:9083` | Hive catalog metastore URI |
+
+## License
+
+Apache License 2.0

datus_doris-0.1.0/datus_doris/__init__.py

@@ -0,0 +1,21 @@
+# 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 .config import DorisConfig
+from .connector import DorisConnector
+
+__version__ = "0.1.0"
+__all__ = ["DorisConnector", "DorisConfig", "register"]
+
+
+def register():
+    """Register Doris connector with Datus registry."""
+    from datus_db_core import connector_registry
+
+    connector_registry.register(
+        "doris",
+        DorisConnector,
+        config_class=DorisConfig,
+        capabilities={"catalog", "database"},
+    )

datus_doris-0.1.0/datus_doris/config.py

@@ -0,0 +1,27 @@
+# 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 DorisConfig(BaseModel):
+    """Doris-specific configuration."""
+
+    model_config = ConfigDict(extra="forbid")
+
+    host: str = Field(default="127.0.0.1", description="Doris server host")
+    port: int = Field(default=9030, description="Doris server port")
+    username: str = Field(..., description="Doris username")
+    password: str = Field(
+        default="",
+        description="Doris password",
+        json_schema_extra={"input_type": "password"},
+    )
+    catalog: str = Field(default="internal", description="Default catalog name")
+    database: Optional[str] = Field(default=None, description="Default database name")
+    charset: str = Field(default="utf8mb4", description="Character set to use")
+    autocommit: bool = Field(default=True, description="Enable autocommit mode")
+    timeout_seconds: int = Field(default=30, description="Connection timeout in seconds")