README.md

What is MYPROXY

• A proxy application that provides:
  1. management on backend MYSQL databse tables
  2. shardings on these tables
  3. SQL proxy abilities
• User may access backend tables through myproxy by normal MYSQL client tools

Features

• supports native MYSQL server/client communication protocols v4.1
• supports 10k+ clients concurrency
• supports dynamic scalability of MYSQL databases
• supports the commonly used SQLs
• supports SQL proxy functionalities, for example, ORACLE SQL -> MYSQL SQL
• supports 2 sharding modes: horizontal and vertical

Structure

Here the diagram consist of 3 parts:

• MYSQL clients: sending requests and fetching datas from myproxy
• MYPROXY:
  1. accepting and processing client requests
  2. forwarding and routing them to backend MYSQL servers
  3. fetching responses from backend and forwarding them to clients
• MYSQL servers: storing real datas and processing requests from myproxy

Process Flow

Case A:

In this case, the client A sends "local" commands that need not to be processed at backend, such as login, show XXX, desc XXX, use XXX etc, myproxy executes them and returns to client immediately.

Case B:

• In this case, client B sends a "query mode" request, task 1 in myproxy will do:

  1. parsing the SQL into syntax tree
  2. hooking to modify the tree
  3. fetching route informations
  4. calculating routes
  5. forwarding request to every destination MYSQL server(s)

• on the other hand, the task 2 or(and) task X will do:

  1. reading the response stream from MYSQL server(s)
  2. assabling streams into MYSQL response packets
  3. if there're more than 1 MYSQL server(s), caching responses

• at last, task X+1 will merge responses in cache and returning to client

Case C:

• In this case, client C sends a "prepare" request in "prepare" mode , task 1 in myproxy will do:

  1. parsing the SQL into syntax tree
  2. hooking to modify the tree
  3. collecting routing informations
  4. forwarding request to all MYSQL server(s) at backend

• on the other hand, the task 2 or(and) task X will do:

  1. reading the response stream from MYSQL server(s)
  2. assabling streams into MYSQL response packets

• at last, task X+1 will filter the responses and returning to client

Case D:

• In this case, client C sends a "execute" request in "prepare" mode, task 1 in myproxy will do:

  1. calculating routes by infos from Case C
  2. forwarding request to every destination MYSQL server(s)

• on the other hand, the task 2 or(and) task X will do:

  1. reading the response stream from MYSQL server(s)
  2. assabling streams into MYSQL response packets
  3. if there're more than 1 MYSQL server(s), caching responses

• at last, task X+1 will merge responses in cache and returning to client

Shardings

• In my thought, sharding is how a database proxy organises table datas of real database at its backend. In myproxy, there're 2 kinds of shardings:
  1. Vertical sharding is the ability of managing lots of unique tables in different database servers, see diagram below:

• in this case, tables are located completely in a unique server, table A B C in server 0, and table D and E in server 1
• while requesting for table B, myproxy will calculate and then route only to database 0, while for table D, the path is to database 1

2. horizontal sharding is to manage tables that are scattered partially in many database servers, see diagram below:

• in this case, table A is scattered into 3 parts and locates in 3 servers
• while requesting for table A, myproxy will route to these 3 servers respectively for all parts of data

Dynamic Scalability

The Dynamic Scalability for myproxy is that table(s) may be added into or be removed from backend without restarting myproxy which will update its backend informations by modifying configure file and sending a SIGUSER2 by the admin manually, see diagram below:

• in case 1, table A is added into backend DB 0, in order to notify myproxy the admin may add table A's settings into config file and send a SIGUSER2 to it
• in case 2, table B is removed from backend DB 1, the admin should update the config file's settings and send a SIGUSER2 to force a backend information update in myproxy

SQL Proxy

In my thought, a SQL PROXY functionality is that myproxy will translate the SQL language which is stranged to the backend database from client to a backend-familiarity-form, for example, the client requests for 'select nvl(col0) from table1' in ORACLE syntax, then myproxy will translate it to MYSQL syntax like 'select ifnull(col0,0) from table1' and pass to backend databases, see diagram below:

myproxy employs ZAS 's SQL syntax engine to implement this functionnality and provides 30+ 'ORACLE to MYSQL' translations.

The Cache Modules

• In myproxy, there're 2 scenarios of key-value storage:
  1. the key - response packet pairs from multiple backends should be firstly stored in cache before sending to client
  2. the values in global column - value pairs from incoming SQL should be increse by 1 and stored persistently for the next fetch
• To implement the cache functionality, some open source caches are employed , such as bdb, leveldb, unqlite, sqlite, multimap of stdc++ library, and a wrapper module named dbwrapper that provides simple consistent and abstract interface is used to help managing these various caches, see diagram below:

The dbwrapper chooses which cache module to use depending on configurations.

HOWTO

• To compile myproxy, do the following steps:

  1. build ZAS
  2. build external cache module like bdb, leveldb
  3. build myproxy with linkage to ZAS and cache modules

• To access myproxy, just use any MYSQL client applications with the correct address and port like this:

enjoy!