MyXQL
MySQL driver for Elixir.
Documentation: http://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
- Supports MySQL 5.5+, 8.0, and MariaDB 10.3
- Supports
mysql_native_password
,sha256_password
, andcaching_sha2_password
authentication plugins
Usage
Add :myxql
to your dependencies:
def deps() do
[
{:myxql, "~> 0.6.0"}
]
end
Make sure you are using the latest version!
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")
{:ok,
%MyXQL.Result{
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)
end
end
and then we can refer to it by its :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> # (1)
date ~D[2013-10-12] # (2)
time ~T[00:37:14] # (3)
datetime ~N[2013-10-12 00:37:14] # (2), (4)
timestamp ~U[2013-10-12 00:37:14Z] # (2), (4)
json %{"foo" => "bar"} # (5)
char "é"
text "myxql"
binary <<1, 2, 3>>
bit <<1::size(1), 0::size(1)>>
point, polygon, ... %Geo.Point{coordinates: {0.0, 1.0}}, ... # (6)
Notes:
-
See Decimal
-
When using SQL mode that allows them, MySQL "zero" dates and datetimes are represented as
:zero_date
and:zero_datetime
respectively. -
Values that are negative or greater than
24:00:00
cannot be decoded -
Datetime fields are represented as
NaiveDateTime
, however a UTCDateTime
can be used for encoding as well -
MySQL added a native JSON type in version 5.7.8, if you're using earlier versions, remember to use TEXT column for your JSON field.
-
See "Geometry support" section below
JSON support
MyXQL comes with JSON support 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
Geometry support
MyXQL comes with Geometry types support via the Geo package.
To use it, add :geo
to your dependencies:
{:geo, "~> 3.3"}
Note, some structs like %Geo.PointZ{}
does not have equivalent on the MySQL server side and thus
shouldn't be used.
If you're using MyXQL geometry types with Ecto and need to for example accept a WKT format as user input, consider implementing an custom Ecto type.
Contributing
Run tests:
git clone [email protected]:elixir-ecto/myxql.git
cd myxql
mix deps.get
mix test
See scripts/test-versions.sh
for scripts used to test against different server versions.
License
The source code is under Apache License 2.0.
Copyright (c) 2018 Plataformatec
Copyright (c) 2020 Dashbit
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 http://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.