[TOC] > [github](https://github.com/flike/kingshard/blob/master/doc/KingDoc/how_to_use_kingshard.md) ## 概述 為了解決一下痛點,在調用層與數據庫層添加中間層,可方便實現對一下功能的實現 1. 讀寫分離問題 2. 單表容量問題 3. 數據庫的運維問題 4. 連接池 5. SQL日志 ## 教程 ### 設置配置文件 <details> <summary>ks.yaml</summary> ``` # kingshard的地址和端口 addr : 0.0.0.0:9696 # 連接kingshard的用戶名和密碼的用戶列表 -user_list: - user : kingshard password : kingshard #kingshard的web API 端口 web_addr : 0.0.0.0:9797 #調用API的用戶名和密碼 web_user : admin web_password : admin # log級別，[debug|info|warn|error],默認是error log_level : debug # 打開SQL日志，設置為on;關閉SQL日志，設置為off log_sql : on #如果設置了該項，則只輸出SQL執行時間超過slow_log_time(ms)的SQL日志，不設置則輸出全部SQL日志 slow_log_time : 100 #日志文件路徑，如果不配置則會輸出到終端。 log_path : /Users/flike/log # sql黑名單文件路徑 # 所有在該文件中的sql都會被kingshard拒絕轉發 #blacklist_sql_file: /Users/flike/blacklist # 只允許下面的IP列表連接kingshard，如果不配置則對連接kingshard的IP不做限制。 allow_ips: 127.0.0.1 # kingshard使用的字符集，如果不設置該選項，則kingshard使用utf8作為默認字符集 #proxy_charset: utf8mb4 # 一個node節點表示mysql集群的一個數據分片，包括一主多從（可以不配置從庫） nodes : - #node節點名字 name : node1 # 連接池中最大的空閑連接數，也就是kingshard最多與后端DB建立max_conns_limit個連接 max_conns_limit : 16 # kingshard連接該node中mysql的用戶名和密碼，master和slave的用戶名和密碼必須一致 user : kingshard password : kingshard # master的地址和端口 master : 127.0.0.1:3306 # slave的地址和端口，可不配置 #slave : 192.168.0.12@2,192.168.0.13@3 #kingshard在300秒內都連接不上mysql，kingshard則會下線該mysql down_after_noalive : 300 - name : node2 max_conns_limit : 16 user : kingshard password : kingshard master : 192.168.59.103:3307 slave : down_after_noalive: 100 # 各用戶的分表規則 schema_list : - #schema的所屬用戶名 user: kingshard #分表分布的node名字 nodes: [node1,node2] #所有未分表的SQL，都會發往默認node。 default: node1 shard: - #分表使用的db db : kingshard #分表名字 table: test_shard_hash #分表字段 key: id #分表分布的node nodes: [node1, node2] #分表類型 type: hash #子表個數分布，表示node1有4個子表， #node2有4個子表。 locations: [4,4] - #分表使用的db db : kingshard #分表名字 table: test_shard_range #分表字段 key: id #分表類型 type: range #分表分布的node nodes: [node1, node2] #子表個數分布，表示node1有4個子表， #node2有4個子表。 locations: [4,4] #表示每個子表包含的最大記錄數，也就是說每 #個子表最多包好10000條記錄。即子表1對應的id為[0,10000),子表2[10000,20000).... table_row_limit: 10000 ``` </details> <br /> 1. kingshard支持兩種類型的分表規則：hash和range。 2. kingshard分表涉及到的子表，需要用戶在各個db手動創建好，并且格式是:`table_name_%4d`,也就是說子表下標由4位數組成。例如:`table_name_0000,table_name_0102`。 3. 所有操作未分表的SQL語句都將發送到默認節點。 ### 安裝和啟動kingshard ``` git clone https://github.com/flike/kingshard.git src/github.com/flike/kingshard cd src/github.com/flike/kingshard source ./dev.sh make 設置配置文件 運行kingshard。./bin/kingshard -config=etc/ks.yaml ``` 注意：kingshard會響應SIGINT,SIGTERM,SIGQUIT這三個信號，平滑退出。在部署kingshard機器上應避免產生這三個信號，以免造成kingshard非正常退出！后臺運行kingshard建議使用supervisor工具