{"id":18408380,"url":"https://github.com/pingcap/sqlalchemy-tidb","last_synced_at":"2025-04-07T09:32:52.893Z","repository":{"id":46765564,"uuid":"395190459","full_name":"pingcap/sqlalchemy-tidb","owner":"pingcap","description":null,"archived":true,"fork":false,"pushed_at":"2024-10-30T02:50:42.000Z","size":65,"stargazers_count":6,"open_issues_count":2,"forks_count":7,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-04-06T23:14:47.591Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pingcap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-12T04:08:02.000Z","updated_at":"2025-04-04T04:34:21.000Z","dependencies_parsed_at":"2022-08-26T03:32:41.849Z","dependency_job_id":null,"html_url":"https://github.com/pingcap/sqlalchemy-tidb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Fsqlalchemy-tidb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Fsqlalchemy-tidb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Fsqlalchemy-tidb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Fsqlalchemy-tidb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pingcap","download_url":"https://codeload.github.com/pingcap/sqlalchemy-tidb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247626458,"owners_count":20969307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T03:18:52.361Z","updated_at":"2025-04-07T09:32:52.537Z","avatar_url":"https://github.com/pingcap.png","language":"Python","readme":"# sqlalchemy-tidb\n\n[![.github/workflows/ci.yml](https://github.com/pingcap/sqlalchemy-tidb/actions/workflows/ci.yml/badge.svg)](https://github.com/pingcap/sqlalchemy-tidb/actions/workflows/ci.yml)\n\nThis adds compatibility for [TiDB](https://github.com/pingcap/tidb) to SQLAlchemy.\n\n## Supported versions\n\n- TiDB 4.x and newer\n- SQLAlchemy 1.4.x\n- Python 3.8 and newer\n\n## Installation\n\n```bash\npip install git+https://github.com/pingcap/sqlalchemy-tidb.git@main\n```\n\n## Getting Started\n\nIn your Python app, you can connect to the database via:\n\n```python\nfrom sqlalchemy import create_engine\nengine = create_engine(\"tidb://username:password@ip:port/database_name?charset=utf8mb4\")\n```\n\n## Known issues\n\n- TiDB only support `FOREIGN KEY` constraints since v6.6.0([#18209](https://github.com/pingcap/tidb/issues/18209)).\n- TiDB only support `SAVEPOINT` since v6.2.0([#6840](https://github.com/pingcap/tidb/issues/6840)).\n\n## Testing this dialect with SQLAlchemy and Alembic\n\nBootstrap your environment with virtualenv and requirements installed\n\n```bash\nmake bootstrap\n```\n\nYou can run the tests using the following command:\n\n```bash\nmake all\n# Or running test with `tox` for a specified python version\ntox -e py39\n# Or running test directly using `pytest`\npytest \"test/test_suite.py::DateTest\"\n```\n\nTo know more about developing the TiDB dialect, checkout the guide on sqlalchemy:\n\n* https://github.com/sqlalchemy/sqlalchemy/blob/rel_1_4/README.dialects.rst\n* https://github.com/sqlalchemy/sqlalchemy/blob/rel_1_4/README.unittests.rst\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Fsqlalchemy-tidb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpingcap%2Fsqlalchemy-tidb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Fsqlalchemy-tidb/lists"}