Documentation Home
X DevAPI User Guide
Download this Manual

X DevAPI User Guide  /  Overview

Pre-General Availability Draft: 2017-10-13

Chapter 1 Overview

This guide explains how to use the X DevAPI and provides examples of its functionality. The X DevAPI is implemented by MySQL Shell and MySQL Connectors that support X Protocol. For more background information and instructions on how to install and get started using X DevAPI, see Using MySQL as a Document Store. For quick-start tutorials introducing you to X DevAPI, see Quick-Start Guide: MySQL Shell for JavaScript and Quick-Start Guide: MySQL Shell for Python.

This section introduces the X DevAPI and provides an overview of the features available when using it to develop applications.


The X DevAPI implementation in MySQL Shell can differ from the implementation in the Connector products. This guide provides an overview of using the concepts in all X DevAPI implementations. Consult Additional Documentation for the X DevAPI reference documentation for the implementation you are using to verify exact syntax and usage.

The X DevAPI wraps powerful concepts in a simple API.

  • A new high-level session concept enables you to write code that can transparently scale from single MySQL Server to a multiple server environment. See Chapter 2, Connection and Session Concepts.

  • Read operations are simple and easy to understand.

  • Non-blocking, asynchronous calls follow common host language patterns.

The X DevAPI introduces a new, modern and easy-to-learn way to work with your data.

Additional Documentation

In addition to this guide, which provides examples in many languages, a comprehensive reference manual is available for each language which implements the X DevAPI.

For general information about using MySQL Shell, which provides JavaScript and Python implementations of X DevAPI, see MySQL Shell User Guide.

User Comments
Sign Up Login You must be logged in to post a comment.