# MyXQL
[](https://travis-ci.org/elixir-ecto/myxql)
MySQL driver for Elixir.
Documentation: <https://hexdocs.pm/myxql>
## 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](https://github.com/elixir-ecto/db_connection)
* Supports MySQL 5.7.10+, 8.0, and MariaDB 10.3
## Usage
Add `:myxql` to your dependencies:
```elixir
def deps() do
[
{:myxql, "~> 0.1.1"}
]
end
```
```elixir
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')")
{:ok, %MyXQL.Result{columns: nil, last_insert_id: 1, num_rows: 1, rows: nil}}
iex> MyXQL.query(pid, "INSERT INTO posts (`title`) VALUES (?), (?)", ["Post 2", "Post 3"])
{:ok, %MyXQL.Result{columns: [], last_insert_id: 3, num_rows: 2, rows: nil}}
iex> MyXQL.query(pid, "SELECT * FROM posts")
{:ok,
%MyXQL.Result{
columns: ["id", "title"],
last_insert_id: nil,
num_rows: 3,
rows: [[1, "Post 1"], [2, "Post 2"], [3, "Post 3"]]
}}
```
It's recommended to start MyXQL under supervision tree:
```elixir
defmodule MyApp.Application do
use Application
def start(_type, _args) do
children = [
{MyXQL, username: "root", name: :myxql}
]
Supervisor.start_link(children, opts)
end
end
```
```elixir
iex> MyXQL.query!(:myxql, "SELECT NOW()").rows
[[~N[2018-12-28 13:42:31]]]
```
## Mariaex Compatibility
See [Mariaex Compatibility](./MARIAEX_COMPATIBILITY.md) page for transition between drivers.
## Data representation
```
MySQL Elixir
----- ------
NULL nil
bool 1 | 0
char "é"
int 42
float 42.0
text "myxql"
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"}
```
\* See [Decimal](https://github.com/ericmj/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](https://github.com/michalmuskala/jason) library. To use it, add `:jason` to your dependencies:
```elixir
{:jason, "~> 1.0"}
```
You can customize it to use another library via the `:json_library` configuration:
```elixir
config :myxql, :json_library, SomeJSONModule
```
## Contributing
Run tests:
```
git clone [email protected]:elixir-ecto/myxql.git
cd myxql
mix deps.get
mix test
```
See [`ci.sh`](ci.sh) for a script 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 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
