kingshard

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #android #machine-learning #rust #macos #awesome #kubernetes #pytorch #security #mcp

(★ 6,402)

A high-performance MySQL proxy

File Explorer

Download Latest Version (.zip)

- backend_conn.go
- backend_conn_test.go
- balancer.go
- db.go
- db_test.go
- node.go
- node_test.go
- stmt.go
- stmt_test.go
- - main.go
- config.go
- config_test.go
- - errors.go
- - filehandler.go
  - handler.go
  - log.go
  - log_test.go
- - hack.go
  - hack_test.go
- - admin_command_introduce.md
  - architecture_of_kingshard_CN.md
  - change_log_CN.md
  - command_help
  - donate.png
  - function_FAQ.md
  - how_to_use_kingshard.md
  - how_to_use_kingshard_EN.md
  - how_to_use_lvs.md
  - keepalived.png
  - kingshard_access_node_arch.jpg
  - kingshard_admin_api.md
  - kingshard_date_sharding.md
  - kingshard_install_document.md
  - kingshard_performance_profiling.md
  - kingshard_performance_test.md
  - kingshard_quick_try.md
  - kingshard_sharding_introduce.md
  - kingshard_support_sql.md
  - lvs.png
  - prometheus.md
  - prometheus.png
  - report.pdf
  - sql_blacklist_introduce.md
  - support.md
  - tech_support.md
  - wechat_pic.png
- - license_kingshard
  - license_mixer
  - license_vitess
- ks.yaml
- unshard.yaml
- prometheus.go
- charset.go
- const.go
- errcode.go
- errname.go
- error.go
- field.go
- packetio.go
- resultset.go
- resultset_sort.go
- resultset_sort_test.go
- sql_fingerprint.go
- sql_fingerprint_test.go
- state.go
- util.go
- util_test.go
- - list_test.go
  - numkey.go
  - planbuilder.go
  - router.go
  - router_test.go
  - shard.go
- - conn.go
  - conn_admin.go
  - conn_preshard.go
  - conn_query.go
  - conn_resultset.go
  - conn_select.go
  - conn_set.go
  - conn_stmt.go
  - conn_stmt_test.go
  - conn_test.go
  - conn_tx.go
  - conn_use.go
  - counter.go
  - server.go
  - server_test.go
  - util.go
  - util_test.go
- analyzer.go
- analyzer_test.go
- ast.go
- sql.go
- sql.y
- sql_test.go
- token.go
- tracked_buffer.go
- sqltypes.go
- sqltypes_test.go
- modules.txt
- api.go
- server.go
.gitignore
.travis.yml
dev.sh
Dockerfile
go.mod
go.sum
Makefile
README.md
README_ZH.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#  kingshard [中文主页](README_ZH.md)

[![Build Status](https://travis-ci.org/flike/kingshard.svg?branch=master)](https://travis-ci.org/flike/kingshard)

## Overview

kingshard is a high-performance proxy for MySQL powered by Go. Just like other mysql proxies, you can use it to split the read/write sqls. Now it supports basic SQL statements (select, insert, update, replace, delete). The most important feature is the sharding function. Kingshard aims to simplify the sharding solution of MySQL. **The Performance of kingshard is about 80% compared to connecting to MySQL directly.**

## Feature

### 1. Basic Function
- Splits reads and writes
- Client's ip ACL control.
- Transaction in single node.
- Support limiting the max count of connections to MySQL database.
- Support setting the backend database online or offline dynamically.
- Supports prepared statement: COM_STMT_PREPARE, COM_STMT_EXECUTE, etc.
- Support multi slaves, and load balancing between slaves.
- Support reading master database forcely.
- Support last_insert_id().
- Support MySQL backends HA.
- Support set the charset of proxy.
- Support SQL blacklist.
- Support dynamically changing the config value of kingshard.

### 2. Sharding Function
- Support hash,range and date sharding across multiple nodes.
- Support sending sql to the specified node.
- Support most commonly used functions, such as `max, min, count, sum`, and also support `join, limit, order by,group by`.

## Install
```
  1. Install Go
  2. git clone https://github.com/flike/kingshard.git $GOPATH/src/github.com/flike/kingshard
  3. cd $GOPATH/src/github.com/flike/kingshard
  4. source ./dev.sh
  5. make
  6. set the config file (etc/ks.yaml)
  7. run kingshard (./bin/kingshard -config=etc/ks.yaml)
```

# Details of kingshard

[1.How to use kingshard building a MySQL cluster](./doc/KingDoc/how_to_use_kingshard_EN.md)

## License

kingshard is under the Apache 2.0 license. See the [LICENSE](./doc/License) directory for details.

kingshard

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

kingshard

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README