| Name | llama-index-readers-clickhouse JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | llama-index readers clickhouse integration |
| upload_time | 2024-05-02 17:05:25 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| 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.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/01/af/5d90935dffd053a5039d5272d9386f4429d46055ee2f82b4a2b921475e2f/llama_index_readers_clickhouse-0.1.2.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.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41669374b60eda9b06301b085bebb9d431ff0780dbd7913d9a7900364b793bf2",
"md5": "d4dd8a4a250f9f0675dfb0d84dffe285",
"sha256": "07362f08dc18458d92b9a0abb29e9bca92791784bcceb294f7a0487f84173c67"
},
"downloads": -1,
"filename": "llama_index_readers_clickhouse-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4dd8a4a250f9f0675dfb0d84dffe285",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3988,
"upload_time": "2024-05-02T17:05:24",
"upload_time_iso_8601": "2024-05-02T17:05:24.056587Z",
"url": "https://files.pythonhosted.org/packages/41/66/9374b60eda9b06301b085bebb9d431ff0780dbd7913d9a7900364b793bf2/llama_index_readers_clickhouse-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01af5d90935dffd053a5039d5272d9386f4429d46055ee2f82b4a2b921475e2f",
"md5": "d8d09d7d0248895e7e960febcd04d0aa",
"sha256": "67aca1c2c67844b4a3783570848b6dd482e3532fe1f85167eed14e9b2026bc68"
},
"downloads": -1,
"filename": "llama_index_readers_clickhouse-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d8d09d7d0248895e7e960febcd04d0aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 3546,
"upload_time": "2024-05-02T17:05:25",
"upload_time_iso_8601": "2024-05-02T17:05:25.597423Z",
"url": "https://files.pythonhosted.org/packages/01/af/5d90935dffd053a5039d5272d9386f4429d46055ee2f82b4a2b921475e2f/llama_index_readers_clickhouse-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 17:05:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-clickhouse"
}
