# TiDBLoader

> **Class** in `langchain_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-community/document_loaders/tidb/TiDBLoader)

Load documents from TiDB.

## Signature

```python
TiDBLoader(
    self,
    connection_string: str,
    query: str,
    page_content_columns: Optional[List[str]] = None,
    metadata_columns: Optional[List[str]] = None,
    engine_args: Optional[Dict[str, Any]] = None,
)
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `connection_string` | `str` | Yes | The connection string for the TiDB database, format: "mysql+pymysql://root@127.0.0.1:4000/test". |
| `query` | `str` | Yes | The query to run in TiDB. |
| `page_content_columns` | `Optional[List[str]]` | No | Optional. Columns written to Document `page_content`, default(None) to all columns. (default: `None`) |
| `metadata_columns` | `Optional[List[str]]` | No | Optional. Columns written to Document `metadata`, default(None) to no columns. (default: `None`) |
| `engine_args` | `Optional[Dict[str, Any]]` | No | Optional. Additional arguments to pass to sqlalchemy engine. (default: `None`) |

## Extends

- `BaseLoader`

## Constructors

```python
__init__(
    self,
    connection_string: str,
    query: str,
    page_content_columns: Optional[List[str]] = None,
    metadata_columns: Optional[List[str]] = None,
    engine_args: Optional[Dict[str, Any]] = None,
) -> None
```

| Name | Type |
|------|------|
| `connection_string` | `str` |
| `query` | `str` |
| `page_content_columns` | `Optional[List[str]]` |
| `metadata_columns` | `Optional[List[str]]` |
| `engine_args` | `Optional[Dict[str, Any]]` |


## Properties

- `connection_string`
- `query`
- `page_content_columns`
- `metadata_columns`
- `engine_args`

## Methods

- [`lazy_load()`](https://reference.langchain.com/python/langchain-community/document_loaders/tidb/TiDBLoader/lazy_load)

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/4b280287bd55b99b44db2dd849f02d66c89534d5/libs/community/langchain_community/document_loaders/tidb.py#L8)