Welcome to MySQL Connector/Python X DevAPI Reference Documentation

The Connector/Python provides a client library for the X DevAPI protocol that was introduced in MySQL 8.0.

MySQL 8.0 is an open-source relational database that is secure, high performing, and easy to use. The X DevAPI supports relational tables and JSON documents making it possible to use both tables and collections at the same time.

For general information about the X DevAPI, please refer to documentation on http://dev.mysql.com/doc/x-devapi-userguide/en/

Contents:

• License
• Requirements
• Installation
  • Installing Connector/Python with pip
  • Installing Connector/Python on Linux Using the MySQL Yum Repository
  • Installing Connector/Python on Linux Using an RPM Package
  • Installing Connector/Python on Linux Using a Debian Package
  • Installing Connector/Python from source
    • Prerequisites
    • Installing Connector/Python from source on Unix and Unix-Like Systems
• Tutorials
  • Getting started
    • Resolving DNS SRV records
    • Specifying which TLS versions to use
  • Collections
    • Creating collections
      • Schema validation
    • Modifying collections
    • Using Collection patch (mysqlx.ModifyStatement.patch())
  • Connection Routers
  • Connection Pooling
  • Transactions
    • Savepoints
      • Get the collection object
      • Set and rollback to a named transaction savepoint
      • Set and rollback to an unnamed transaction savepoint
      • Releasing a transaction savepoint
  • Creating Indexes
    • Arguments for mysqlx.Collection.create_index()
    • Using mysqlx.Collection.create_index()
  • Locking
    • Shared and Exclusive Locks
      • Examples
    • Locking with NOWAIT and SKIP_LOCKED
  • Handling Connection Attributes (mysqlx.get_session())
• Reference
  • Connection
    • mysqlx.get_client
      • get_client()
    • mysqlx.get_session
      • get_session()
    • mysqlx.Client
      • Client
    • mysqlx.Session
      • Session
  • CRUD
    • mysqlx.Schema
      • Schema
    • mysqlx.Collection
      • Collection
    • mysqlx.Table
      • Table
    • mysqlx.View
      • View
    • mysqlx.expr
      • expr()
  • Result
    • mysqlx.Column
      • Column
    • mysqlx.Row
      • Row
    • mysqlx.Result
      • Result
    • mysqlx.BufferingResult
      • BufferingResult
    • mysqlx.RowResult
      • RowResult
    • mysqlx.SqlResult
      • SqlResult
  • Statement
    • mysqlx.DbDoc
      • DbDoc
    • mysqlx.Statement
      • Statement
    • mysqlx.FilterableStatement
      • FilterableStatement
    • mysqlx.SqlStatement
      • SqlStatement
    • mysqlx.FindStatement
      • FindStatement
    • mysqlx.AddStatement
      • AddStatement
    • mysqlx.RemoveStatement
      • RemoveStatement
    • mysqlx.ModifyStatement
      • ModifyStatement
    • mysqlx.SelectStatement
      • SelectStatement
    • mysqlx.InsertStatement
      • InsertStatement
    • mysqlx.DeleteStatement
      • DeleteStatement
    • mysqlx.UpdateStatement
      • UpdateStatement
    • mysqlx.CreateCollectionIndexStatement
      • CreateCollectionIndexStatement
    • mysqlx.ReadStatement
      • ReadStatement
    • mysqlx.WriteStatement
      • WriteStatement
  • Errors
    • mysqlx.DataError
      • DataError
    • mysqlx.DatabaseError
      • DatabaseError
    • mysqlx.Error
      • Error
    • mysqlx.IntegrityError
      • IntegrityError
    • mysqlx.InterfaceError
      • InterfaceError
    • mysqlx.InternalError
      • InternalError
    • mysqlx.NotSupportedError
      • NotSupportedError
    • mysqlx.OperationalError
      • OperationalError
    • mysqlx.PoolError
      • PoolError
    • mysqlx.ProgrammingError
      • ProgrammingError
    • mysqlx.TimeoutError
      • TimeoutError

Indices and tables

• Index

• Search Page