Metadata-Version: 2.5
Name: archipy-starrocks
Version: 5.18.1
Summary: ArchiPy starrocks adapter.
Author-email: Hossein Nejati <hosseinnejati14@gmail.com>
License-Expression: Apache-2.0
Requires-Python: <4,>=3.14
Requires-Dist: archipy==5.18.1
Provides-Extra: async
Requires-Dist: asyncmy2>=0.2.21; extra == 'async'
Requires-Dist: starrocks>=1.3.4; extra == 'async'
Provides-Extra: sync
Requires-Dist: pymysql>=1.2.3; extra == 'sync'
Requires-Dist: starrocks>=1.3.4; extra == 'sync'
Description-Content-Type: text/markdown

# archipy-starrocks

StarRocks adapter for [ArchiPy](https://syntaxarc.github.io/ArchiPy/): SQLAlchemy access to StarRocks.

## Install

Install it through the core extra, which pins this package to the matching ArchiPy version:

```bash
uv add "archipy[starrocks]"
uv add "archipy[starrocks-async]"
```

## Usage

```python
from archipy.adapters.starrocks.sqlalchemy.adapters import StarrocksSQLAlchemyAdapter

adapter = StarrocksSQLAlchemyAdapter()
```

The adapter reads its settings from the `STARROCKS_SQLALCHEMY` section of the global config, for example `STARROCKS_SQLALCHEMY__<FIELD>` environment variables.

Classes in `archipy.adapters.starrocks.sqlalchemy.adapters`: `StarrocksSQLAlchemyAdapter`, `AsyncStarrocksSQLAlchemyAdapter`.

See the [StarRocks tutorial](https://syntaxarc.github.io/ArchiPy/tutorials/adapters/starrocks/) for the full API.
