[![Build Status](](

MySQL driver for Elixir.

Documentation: <>

## Features

  * Automatic decoding and encoding of Elixir values to and from MySQL text and binary protocols
  * Supports transactions, prepared queries, streaming, pooling and more via [DBConnection](
  * Supports MySQL 5.5+, 8.0, and MariaDB 10.3
  * Supports `mysql_native_password`, `sha256_password` (\*), and `caching_sha256_password` (\*)
    authentication plugins

\* Requires either SSL connection or the server must exchange it's public key during handshake.

## Usage

Add `:myxql` to your dependencies:

def deps() do
    {:myxql, "~> 0.2.0"}

iex> {:ok, pid} = MyXQL.start_link(username: "root")
iex> MyXQL.query!(pid, "CREATE DATABASE IF NOT EXISTS blog")

iex> {:ok, pid} = MyXQL.start_link(username: "root", database: "blog")
iex> MyXQL.query!(pid, "CREATE TABLE posts IF NOT EXISTS (id serial primary key, title text)")

iex> MyXQL.query!(pid, "INSERT INTO posts (`title`) VALUES ('Post 1')")
%MyXQL.Result{columns: nil, connection_id: 11204,, last_insert_id: 1, num_rows: 1, num_warnings: 0, rows: nil}

iex> MyXQL.query(pid, "INSERT INTO posts (`title`) VALUES (?), (?)", ["Post 2", "Post 3"])
%MyXQL.Result{columns: nil, connection_id: 11204, last_insert_id: 2, num_rows: 2, num_warnings: 0, rows: nil}

iex> MyXQL.query(pid, "SELECT * FROM posts")
   columns: ["id", "title"],
   connection_id: 11204,
   last_insert_id: nil,
   num_rows: 3,
   num_warnings: 0,
   rows: [[1, "Post 1"], [2, "Post 2"], [3, "Post 3"]]

It's recommended to start MyXQL under supervision tree:

defmodule MyApp.Application do
  use Application

  def start(_type, _args) do
    children = [
      {MyXQL, username: "root", name: :myxql}

    Supervisor.start_link(children, opts)

and then we can refer to it by it's `:name`:

iex> MyXQL.query!(:myxql, "SELECT NOW()").rows
[[~N[2018-12-28 13:42:31]]]

## Mariaex Compatibility

See [Mariaex Compatibility]( page for transition between drivers.

## Data representation

MySQL           Elixir
-----           ------
NULL            nil
bool            1 | 0
int             42
float           42.0
decimal         #Decimal<42.0> *
date            ~D[2013-10-12]
time            ~T[00:37:14]
datetime        ~N[2013-10-12 00:37:14] **
timestamp       #DateTime<2013-10-12 00:37:14Z>
json            %{"foo" => "bar"}
char            "é"
text            "myxql"
binary          <<1, 2, 3>>
bit             <<1::size(1), 0::size(1)>>

\* See [Decimal](

\*\* datetime fields are represented as `NaiveDateTime`, however a UTC `DateTime` can be used for encoding as well

## JSON support

MyXQL comes with JSON support out of the box via the [Jason]( library. To use it, add `:jason` to your dependencies:

{:jason, "~> 1.0"}

You can customize it to use another library via the `:json_library` configuration:

config :myxql, :json_library, SomeJSONModule

## Contributing

Run tests:

git clone
cd myxql
mix deps.get
mix test

See [`scripts/`](scripts/ and [`scripts/`](scripts/ for scripts used to test against different server versions.

## License

The source code is under Apache License 2.0.

Copyright (c) 2018 Plataformatec

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at [](

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.