{"id":19331982,"url":"https://github.com/tikv/client-java","last_synced_at":"2025-04-05T14:07:07.448Z","repository":{"id":33663418,"uuid":"157680689","full_name":"tikv/client-java","owner":"tikv","description":"TiKV Java Client","archived":false,"fork":false,"pushed_at":"2024-06-04T03:40:53.000Z","size":352747,"stargazers_count":115,"open_issues_count":84,"forks_count":113,"subscribers_count":29,"default_branch":"master","last_synced_at":"2025-03-29T06:53:23.301Z","etag":null,"topics":["client","cncf","grpc","java","tikv"],"latest_commit_sha":null,"homepage":"https://tikv.github.io/client-java/","language":"Java","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/tikv.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-15T08:52:53.000Z","updated_at":"2025-03-17T03:40:26.000Z","dependencies_parsed_at":"2024-03-28T09:29:19.526Z","dependency_job_id":"0fc834c5-96d3-492b-92a1-e87bbb8fe74a","html_url":"https://github.com/tikv/client-java","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikv%2Fclient-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikv%2Fclient-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikv%2Fclient-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tikv%2Fclient-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tikv","download_url":"https://codeload.github.com/tikv/client-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345853,"owners_count":20924102,"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":["client","cncf","grpc","java","tikv"],"created_at":"2024-11-10T02:43:21.497Z","updated_at":"2025-04-05T14:07:07.412Z","avatar_url":"https://github.com/tikv.png","language":"Java","readme":"[![Maven Central](https://img.shields.io/maven-central/v/org.tikv/tikv-client-java.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.tikv%22%20AND%20a:%22tikv-client-java%22)\n[![Slack](https://img.shields.io/badge/chat-on%20Slack-brightgreen.svg)](https://slack.tidb.io/invite?team=tikv-wg\u0026channel=client)\n[![codecov](https://codecov.io/gh/tikv/client-java/branch/master/graph/badge.svg?token=nSAjGaN0EH)](https://codecov.io/gh/tikv/client-java)\n\n## TiKV JAVA Client\n\nA Java client for [TiKV](https://github.com/tikv/tikv).\nIt is supposed to:\n+ Communicate via [gRPC](http://www.grpc.io/)\n+ Talk to Placement Driver searching for a region\n+ Talk to TiKV for reading/writing data\n\n## Quick Start\n\n\u003e TiKV Java Client is designed to communicate with [PD](https://github.com/tikv/pd) and [TiKV](https://github.com/tikv/tikv), please run PD and TiKV in advance.\n\nBuild Java client from source file:\n\n```sh\nmvn clean install -Dmaven.test.skip=true\n```\n\nAdd maven dependency to `pom.xml`:\n\n```xml\n\u003cdependency\u003e\n\t\u003cgroupId\u003eorg.tikv\u003c/groupId\u003e\n\t\u003cartifactId\u003etikv-client-java\u003c/artifactId\u003e\n\t\u003cversion\u003e3.3.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nCreate a transactional `KVClient` and communicates with TiKV:\n\n```java\nimport org.tikv.common.TiConfiguration;\nimport org.tikv.common.TiSession;\nimport org.tikv.txn.KVClient;\n\npublic class Main {\n\tpublic static void main(String[] args) throws Exception {\n\t\tTiConfiguration conf = TiConfiguration.createDefault(YOUR_PD_ADDRESSES);\n\t\tTiSession session = TiSession.create(conf);\n\t\tKVClient client = session.createKVClient();\n\t}\n}\n```\n\nOr create a `RawKVClient` if you don't need the transaction semantic:\n\n```java\nimport org.tikv.common.TiConfiguration;\nimport org.tikv.common.TiSession;\nimport org.tikv.raw.RawKVClient;\n\npublic class Main {\n\tpublic static void main(String[] args) throws Exception {\n\t\tTiConfiguration conf = TiConfiguration.createRawDefault(YOUR_PD_ADDRESSES);\n\t\tTiSession session = TiSession.create(conf);\n\t\tRawKVClient client = session.createRawClient();\n\t}\n}\n```\n\nFind more demo in [TiKV Java Client User Documents](https://tikv.github.io/client-java/examples/introduction.html)\n\n## Documentation\n\nSee [Java Client Documents](/docs/README.md) for references about how to config and monitor Java Client.\n\nA [Maven site](https://tikv.github.io/client-java/site) is also available. It includes:\n1. [API reference](https://tikv.github.io/client-java/site/apidocs/index.html)\n2. [Spotbugs Reports](https://tikv.github.io/client-java/site/spotbugs.html)\n3. [Source Code Xref](https://tikv.github.io/client-java/site/xref/index.html)\n\n## Community\n\n### Forum\n\n- User forum: [AskTUG](https://asktug.com/)\n- Contributor forum: [https://internals.tidb.io/](https://internals.tidb.io/)\n\n### Contribute to TiKV Java Client\n\nSee [Contribution Guide](https://tikv.github.io/client-java/contribution/introduction.html) for references about how to contribute to this project.\n\n## License\n\nApache 2.0 license. See the [LICENSE](./LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftikv%2Fclient-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftikv%2Fclient-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftikv%2Fclient-java/lists"}