OceanBase Log Client
--------------------

English | [简体中文](README_CN.md)

[![Build Status](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml/badge.svg?branch=master)](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml)
[![Release](https://img.shields.io/github/release/oceanbase/oblogclient.svg)](https://github.com/oceanbase/oblogclient/releases)
[![License](https://img.shields.io/badge/license-Mulan%20PSL%20v2-green.svg)](LICENSE)

OceanBase Log Client is a library for obtaining the commit log of [OceanBase](https://github.com/oceanbase/oceanbase).

Getting Started
---------------

### Work with LogProxy

You can use this project with [oblogproxy](https://github.com/oceanbase/oblogproxy) to get the commit log of OceanBase. See the [LogProxy client tutorial](docs/quickstart/logproxy-client-tutorial.md) for more details.

### Connect to OceanBase Directly

Coming soon.

Communication
---------------
* [GitHub Issues](https://github.com/oceanbase/oblogclient/issues) (Bug reports, feature requests)
* [Official Forum](https://ask.oceanbase.com/) (Q&A, ideas, general discussion)
* DingTalk Group (Q&A, general discussion): 33254054

License
-------
Mulan Permissive Software License, Version 2 (Mulan PSL v2). See the [LICENSE](LICENSE) file for details.