Skip to content

Commit 0842b5d

Browse files
authored
Enhance README with API reference and documentation
Added API reference and documentation link to README.
1 parent a15a364 commit 0842b5d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22
---
33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/blob/main/LICENSE)
44
[![PyPI version](https://badge.fury.io/py/ydb-sqlalchemy.svg)](https://badge.fury.io/py/ydb-sqlalchemy)
5+
[![API Reference](https://img.shields.io/badge/API-Reference-lightgreen.svg)](https://ydb-platform.github.io/ydb-sqlalchemy/api/index.html)
56
[![Functional tests](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/tests.yml/badge.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/tests.yml)
67
[![Style checks](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/style.yml/badge.svg)](https://github.com/ydb-platform/ydb-sqlalchemy/actions/workflows/style.yml)
78

89
This repository contains YQL dialect for SqlAlchemy 2.0.
910

11+
---
12+
13+
**Documentation**: <a href="https://ydb-platform.github.io/ydb-sqlalchemy" target="_blank">https://ydb-platform.github.io/ydb-sqlalchemy</a>
14+
15+
---
16+
1017
**Note**: Dialect also works with SqlAlchemy 1.4, but it is not fully tested.
1118

1219

@@ -168,4 +175,4 @@ It is possible to use YDB SA engine with `pandas` fuctions [to_sql()](https://pa
168175

169176
* `to_sql` is not fully optimized to load huge datasets. It is recommended to use `method="multi"` and avoid setting a very large `chunksize`.
170177

171-
* `read_sql` is not fully optimized to load huge datasets and could lead to significant memory consumptions.
178+
* `read_sql` is not fully optimized to load huge datasets and could lead to significant memory consumptions.

0 commit comments

Comments
 (0)