| Name | llama-index-readers-clickhouse JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers clickhouse integration |
| upload_time | 2024-11-18 00:20:25 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Readers Integration: ClickHouse
## Overview
ClickHouse Reader is a tool designed to retrieve documents from ClickHouse databases efficiently.
## Installation
You can install ClickHouse Reader via pip:
```bash
pip install llama-index-readers-clickhouse
```
## Usage
```python
from llama_index.core.schema import Document
from llama_index.readers.clickhouse import ClickHouseReader
# Initialize ClickHouseReader with the connection details and configuration
reader = ClickHouseReader(
clickhouse_host="<ClickHouse Host>",
username="<Username>",
password="<Password>",
clickhouse_port=8123, # Optional: Default port is 8123
database="<Database Name>",
engine="MergeTree", # Optional: Default engine is "MergeTree"
table="<Table Name>",
index_type="NONE", # Optional: Default index type is "NONE"
metric="cosine", # Optional: Default metric is "cosine"
batch_size=1000, # Optional: Default batch size is 1000
index_params=None, # Optional: Index parameters
search_params=None, # Optional: Search parameters
)
# Load data from ClickHouse
documents = reader.load_data(
query_vector=[0.1, 0.2, 0.3], # Query vector
where_str=None, # Optional: Where condition string
limit=10, # Optional: Number of results to return
)
```
This loader is designed to be used as a way to load data into
[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently
used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-clickhouse",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/d2/c0/143445dd42ec1271bc7f75b889f397f3110fda865848b0123ae3e0cf04a6/llama_index_readers_clickhouse-0.3.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: ClickHouse\n\n## Overview\n\nClickHouse Reader is a tool designed to retrieve documents from ClickHouse databases efficiently.\n\n## Installation\n\nYou can install ClickHouse Reader via pip:\n\n```bash\npip install llama-index-readers-clickhouse\n```\n\n## Usage\n\n```python\nfrom llama_index.core.schema import Document\nfrom llama_index.readers.clickhouse import ClickHouseReader\n\n# Initialize ClickHouseReader with the connection details and configuration\nreader = ClickHouseReader(\n clickhouse_host=\"<ClickHouse Host>\",\n username=\"<Username>\",\n password=\"<Password>\",\n clickhouse_port=8123, # Optional: Default port is 8123\n database=\"<Database Name>\",\n engine=\"MergeTree\", # Optional: Default engine is \"MergeTree\"\n table=\"<Table Name>\",\n index_type=\"NONE\", # Optional: Default index type is \"NONE\"\n metric=\"cosine\", # Optional: Default metric is \"cosine\"\n batch_size=1000, # Optional: Default batch size is 1000\n index_params=None, # Optional: Index parameters\n search_params=None, # Optional: Search parameters\n)\n\n# Load data from ClickHouse\ndocuments = reader.load_data(\n query_vector=[0.1, 0.2, 0.3], # Query vector\n where_str=None, # Optional: Where condition string\n limit=10, # Optional: Number of results to return\n)\n```\n\nThis loader is designed to be used as a way to load data into\n[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently\nused as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers clickhouse integration",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad5087c4396c4850bb243ed5802fff46c81f87cf94e0efec23e26dd16ba35f7d",
"md5": "9b1698e84d6c513290ac7b1f950f264c",
"sha256": "870f1a91cb3d0f8365410213ed58f811c8302aa6933dd566b07e2caa2023144d"
},
"downloads": -1,
"filename": "llama_index_readers_clickhouse-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b1698e84d6c513290ac7b1f950f264c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 3991,
"upload_time": "2024-11-18T00:20:24",
"upload_time_iso_8601": "2024-11-18T00:20:24.206341Z",
"url": "https://files.pythonhosted.org/packages/ad/50/87c4396c4850bb243ed5802fff46c81f87cf94e0efec23e26dd16ba35f7d/llama_index_readers_clickhouse-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2c0143445dd42ec1271bc7f75b889f397f3110fda865848b0123ae3e0cf04a6",
"md5": "bbbf7ebb4e01c929cfac6d6e5da99d99",
"sha256": "e6f4fc9432f71c2c1b5492588efd453dbfffce5f57d5a2fb7cc95278565f5b70"
},
"downloads": -1,
"filename": "llama_index_readers_clickhouse-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "bbbf7ebb4e01c929cfac6d6e5da99d99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3603,
"upload_time": "2024-11-18T00:20:25",
"upload_time_iso_8601": "2024-11-18T00:20:25.131750Z",
"url": "https://files.pythonhosted.org/packages/d2/c0/143445dd42ec1271bc7f75b889f397f3110fda865848b0123ae3e0cf04a6/llama_index_readers_clickhouse-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 00:20:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-clickhouse"
}
