- Introduction
- Concepts
- Key Features
- Horizontal Scalability
- MySQL Compatible Syntax
- Replicate from and to MySQL
- Distributed Transactions with Strong Consistency
- Cloud Native Architecture
- Minimize ETL with HTAP
- Fault Tolerance & Recovery with Raft
- Automatic Rebalancing
- Deployment and Orchestration with Ansible, Kubernetes, Docker
- JSON Support
- Spark Integration
- Read Historical Data Without Restoring from Backup
- Fast Import and Restore of Data
- Hybrid of Column and Row Storage
- SQL Plan Management
- Open Source
- Online Schema Changes
- Key Features
- How-to
- Get Started
- Start a Cluster
- Deploy
- From Binary Tarball
- Orchestrated Deployment
- Geographic Redundancy
- Configure
- Secure
- Transport Layer Security (TLS)
- Monitor
- Migrate
- Migrate from MySQL
- Maintain
- Backup and Restore
- Identify Abnormal Queries
- Scale
- Upgrade
- Troubleshoot
- Get Started
- Reference
- SQL
- SQL Language Structure
- Data Types
- Numeric Types
- Date and Time Types
- String Types
- Functions and Operators
- Function and Operator Reference
- Type Conversion in Expression Evaluation
- Operators
- Control Flow Functions
- String Functions
- Numeric Functions and Operators
- Date and Time Functions
- Bit Functions and Operators
- Cast Functions and Operators
- Encryption and Compression Functions
- Information Functions
- JSON Functions
- Aggregate (GROUP BY) Functions
- Window Functions
- Miscellaneous Functions
- Precision Math
- List of Expressions for Pushdown
- SQL Statements
ADD COLUMNADD INDEXADMINADMIN CANCEL DDLADMIN CHECKSUM TABLEADMIN CHECK [TABLE|INDEX]ADMIN SHOW DDL [JOBS|QUERIES]ALTER DATABASEALTER TABLEALTER USERANALYZE TABLEBEGINCHANGE COLUMNCOMMITCREATE DATABASECREATE INDEXCREATE ROLECREATE TABLE LIKECREATE TABLECREATE USERCREATE VIEWDEALLOCATEDELETEDESCDESCRIBEDODROP COLUMNDROP DATABASEDROP INDEXDROP ROLEDROP TABLEDROP USERDROP VIEWEXECUTEEXPLAIN ANALYZEEXPLAINFLUSH PRIVILEGESFLUSH STATUSFLUSH TABLESGRANT <privileges>GRANT <role>INSERTKILL [TIDB]LOAD DATALOAD STATSMODIFY COLUMNPREPARERECOVER TABLERENAME INDEXRENAME TABLEREPLACEREVOKE <privileges>REVOKE <role>ROLLBACKSELECTSET DEFAULT ROLESET [NAMES|CHARACTER SET]SET PASSWORDSET ROLESET TRANSACTIONSET [GLOBAL|SESSION] <variable>SHOW ANALYZE STATUSSHOW CHARACTER SETSHOW COLLATIONSHOW [FULL] COLUMNS FROMSHOW CREATE TABLESHOW CREATE USERSHOW DATABASESSHOW ENGINESSHOW ERRORSSHOW [FULL] FIELDS FROMSHOW GRANTSSHOW INDEXES [FROM|IN]SHOW INDEX [FROM|IN]SHOW KEYS [FROM|IN]SHOW PRIVILEGESSHOW [FULL] PROCESSSLISTSHOW SCHEMASSHOW STATUSSHOW [FULL] TABLESSHOW TABLE REGIONSSHOW TABLE STATUSSHOW [GLOBAL|SESSION] VARIABLESSHOW WARNINGSSPLIT REGIONSTART TRANSACTIONTRACETRUNCATEUPDATEUSE
- Configuration
- tidb-server
- pd-server
- tikv-server
- Security
- Transactions
- System Databases
- Garbage Collection (GC)
- Performance
- Overview
- Understanding the Query Execution Plan
- The Blocklist of Optimization Rules and Expression Pushdown
- Introduction to Statistics
- TopN and Limit Push Down
- Optimizer Hints
- Check the TiDB Cluster Status Using SQL Statements
- Execution Plan Binding
- Statement Summary Table
- Tune TiKV
- Operating System Tuning
- Column Pruning
- Key Monitoring Metrics
- Best Practices
- TiDB Binlog
- Upgrade
- Reparo
- Binlog Consumer Client
- TiDB Binlog Relay Log
- Bidirectional Replication Between TiDB Clusters
- Glossary
- Troubleshoot
- Tools
- TiDB Lightning
- sync-diff-inspector
- SQL
- FAQs
- Support
- Contribute
- Releases
- All Releases
- v3.0
- v2.1
- v2.0
- v1.0
- Glossary
Connectors and APIs
Database Connectors provide connectivity to the TiDB server for client programs. APIs provide low-level access to the MySQL protocol and MySQL resources. Both Connectors and the APIs enable you to connect and execute MySQL statements from another language or environment, including ODBC, Java (JDBC), Perl, Python, PHP, Ruby and C.
TiDB is compatible with all Connectors and APIs of MySQL (5.6, 5.7), including:
- MySQL Connector/C++
- MySQL Connector/J
- MySQL Connector/Net
- MySQL Connector/ODBC
- MySQL Connector/Python
- MySQL C API
- MySQL PHP API
- MySQL Perl API
- MySQL Python API
- MySQL Ruby APIs
- MySQL Tcl API
- MySQL Eiffel Wrapper
- Mysql Go API
Connect to TiDB using MySQL Connectors
Oracle develops the following APIs and TiDB is compatible with all of them:
Note:
- To connect to TiDB using a MySQL Connector from MySQL 8.0, you must explicitly specify
default-auth=mysql_native_password, becausemysql_native_passwordis no longer the default plugin.
- MySQL Connector/C++：to enable C++ applications to connect to MySQL
- MySQL Connector/J：to enable Java applications to connect to MySQL using the standard JDBC API
- MySQL Connector/Net：to enable .Net applications to connect to MySQL; MySQL for Visual Studio uses this; support Microsoft Visual Studio 2012, 2013, 2015 and 2017 versions
- MySQL Connector/ODBC：the standard ODBC API; support Windows, Unix, and OS X platforms
- MySQL Connector/Python：to enable Python applications to connect to MySQL, compliant with the Python DB API version 2.0
Connect to TiDB using MySQL C API
If you use C language programs to connect to TiDB, you can connect to libmysqlclient directly and use the MySQL C API. This is one of the major connection methods using C language, widely used by various clients and APIs, including Connector/C.
Connect to TiDB using third-party MySQL APIs
The third-party APIs are not developed by Oracle. The following table lists the commonly used third-party APIs:
| Environment | API | Type | Notes |
|---|---|---|---|
| Ada | GNU Ada MySQL Bindings | libmysqlclient | See MySQL Bindings for GNU Ada |
| C | C API | libmysqlclient | See Section 27.8, “MySQL C API” |
| C++ | Connector/C++ | libmysqlclient | See MySQL Connector/C++ Developer Guide |
| MySQL++ | libmysqlclient | See MySQL++ Web site | |
| MySQL wrapped | libmysqlclient | See MySQL wrapped | |
| Go | go-sql-driver | Native Driver | See Mysql Go API |
| Cocoa | MySQL-Cocoa | libmysqlclient | Compatible with the Objective-C Cocoa environment. See http://mysql-cocoa.sourceforge.net/ |
| D | MySQL for D | libmysqlclient | See MySQL for D |
| Eiffel | Eiffel MySQL | libmysqlclient | See Section 27.14, “MySQL Eiffel Wrapper” |
| Erlang | erlang-mysql-driver | libmysqlclient | See erlang-mysql-driver |
| Haskell | Haskell MySQL Bindings | Native Driver | See Brian O'Sullivan's pure Haskell MySQL bindings |
hsql-mysql | libmysqlclient | See MySQL driver for Haskell | |
| Java/JDBC | Connector/J | Native Driver | See MySQL Connector/J 5.1 Developer Guide |
| Lua | LuaSQL | libmysqlclient | See LuaSQL |
| .NET/Mono | Connector/Net | Native Driver | See MySQL Connector/Net Developer Guide |
| Objective Caml | OBjective Caml MySQL Bindings | libmysqlclient | See MySQL Bindings for Objective Caml |
| Octave | Database bindings for GNU Octave | libmysqlclient | See Database bindings for GNU Octave |
| ODBC | Connector/ODBC | libmysqlclient | See MySQL Connector/ODBC Developer Guide |
| Perl | DBI/DBD::mysql | libmysqlclient | See Section 27.10, “MySQL Perl API” |
Net::MySQL | Native Driver | See Net::MySQL at CPAN | |
| PHP | mysql, ext/mysqlinterface (deprecated) | libmysqlclient | See Original MySQL API |
mysqli, ext/mysqliinterface | libmysqlclient | See MySQL Improved Extension | |
PDO_MYSQL | libmysqlclient | See MySQL Functions (PDO_MYSQL) | |
| PDO mysqlnd | Native Driver | ||
| Python | Connector/Python | Native Driver | See MySQL Connector/Python Developer Guide |
| Python | Connector/Python C Extension | libmysqlclient | See MySQL Connector/Python Developer Guide |
| MySQLdb | libmysqlclient | See Section 27.11, “MySQL Python API” | |
| Ruby | MySQL/Ruby | libmysqlclient | Uses libmysqlclient. See Section 27.12.1, “The MySQL/Ruby API” |
| Ruby/MySQL | Native Driver | See Section 27.12.2, “The Ruby/MySQL API” | |
| Scheme | Myscsh | libmysqlclient | See Myscsh |
| SPL | sql_mysql | libmysqlclient | See sql_mysql for SPL |
| Tcl | MySQLtcl | libmysqlclient | See Section 27.13, “MySQL Tcl API” |
Connector versions supported by TiDB
| Connector | Connector Version |
|---|---|
| Connector/C | 6.1.0 GA |
| Connector/C++ | 1.0.5 GA |
| Connector/J | 5.1.8 |
| Connector/Net | 6.9.9 GA |
| Connector/Net | 6.8.8 GA |
| Connector/ODBC | 5.1 |
| Connector/ODBC | 3.51 (Unicode not supported) |
| Connector/Python | 2.0 |
| Connector/Python | 1.2 |