Error: Can't initialize character set unknown

mysql - MySQL connector for Tarantool

Getting Started

Prerequisites

Tarantool 1.6.5+ with header files (tarantool && tarantool-dev / tarantool-devel packages).
MySQL 5.1 header files (libmysqlclient-dev package).
OpenSSL development package.
libucontext (only for Alpine).

If you prefer to install the connector using a system package manager you don't need to manually install dependencies.

Installation

Build from sources

Clone repository and then build it using CMake:

git clone https://github.com/tarantool/mysql.git tarantool-mysql
cd tarantool-mysql && cmake . -DCMAKE_BUILD_TYPE=RelWithDebInfo
make
make install

Run tests

To run the tests, the following preparatory steps must be completed:

Run mysql instance.
Connect a client to the instance and execute the commands:
- CREATE USER 'test_user' IDENTIFIED WITH mysql_native_password BY 'pass';
- CREATE DATABASE tarantool_mysql_test;
- GRANT ALL PRIVILEGES ON *.* TO 'test_user';
Define MYSQL environment variable using the following format:
ip:port:user:user_pass:db_name:
Example:
export MYSQL=127.0.0.1:3306:test_user:pass:tarantool_mysql_test:

The tests can now be run by make check.

tt rocks

You can also use tt rocks:

tt rocks install mysql

Install a package

Enable tarantool repository and install tarantool-mysql package:

apt-get install tarantool-mysql # Debian or Ubuntu
yum install tarantool-mysql     # CentOS
dnf install tarantool-mysql     # Fedora

Usage

local mysql = require('mysql')
local pool = mysql.pool_create({ host = '127.0.0.1', user = 'user', password = 'password', db = 'db', size = 5 })
local conn = pool:get()
local tuples, status  = conn:execute("SELECT ? AS a, 'xx' AS b, NULL as c", 42))
conn:begin()
conn:execute("INSERT INTO test VALUES(1, 2, 3)")
conn:commit()
pool:put(conn)

API Documentation

`conn = mysql.connect(opts)`

Connect to a database.

Options:

host - hostname to connect to
port - port number to connect to
user - username
password - password
db - database name
use_numeric_result - provide result of the "conn:execute" as ordered list (true/false); default value: false
keep_null - provide printing null fields in the result of the "conn:execute" (true/false); default value: false

Throws an error on failure.

Returns:

connection ~= nil on success

`conn:execute(statement, ...)`

Execute a statement with arguments in the current transaction.

Throws an error on failure.

Returns:

results, true on success, where results is in the following form:

(when use_numeric_result = false or is not set on a pool/connection creation)

{
    { -- result set
        {column1 = r1c1val, column2 = r1c2val, ...}, -- row
        {column1 = r2c1val, column2 = r2c2val, ...}, -- row
        ...
    },
    ...
}

(when use_numeric_result = true on a pool/connection creation)

{
    { -- result set
        rows = {
            {r1c1val, r1c2val, ...}, -- row
            {r2c1val, r2c2val, ...}, -- row
            ...
        },
        metadata = {
            {type = 'long', name = 'col1'}, -- column meta
            {type = 'long', name = 'col2'}, -- column meta
            ...
        },
    },
    ...
}

Example:

(when keep_null = false or is not set on a pool/connection creation)

tarantool> conn:execute("SELECT ? AS a, 'xx' AS b", NULL AS c , 42)
---
- - - a: 42
      b: xx
- true
...

(when keep_null = true on a pool/connection creation)

tarantool> conn:execute("SELECT ? AS a, 'xx' AS b", NULL AS c, 42)
---
- - - a: 42
      b: xx
      c: null
- true
...

`conn:begin()`

Begin a transaction.

Returns: true

`conn:commit()`

Commit current transaction.

Returns: true

`conn:rollback()`

Rollback current transaction.

Returns: true

`conn:ping()`

Execute a dummy statement to check that connection is alive.

Returns:

true on success
false on failure

`conn:quote()`

Quote a query string.

Throws an error on failure.

Returns:

quoted_string on success

`conn:reset(user, pass, db)`

Update the connection authentication settings.

Options:

user - username
pass - password
db - database name

Throws an error on failure.

`conn:close()`

Close the individual connection or return it to a pool.

Throws an error on failure.

Returns: true

`pool = mysql.pool_create(opts)`

Create a connection pool with count of size established connections.

Options:

host - hostname to connect to
port - port number to connect to
user - username
password - password
db - database name
size - count of connections in pool
use_numeric_result - provide result of the "conn:execute" as ordered list (true/false); default value: false
keep_null - provide printing null fields in the result of the "conn:execute" (true/false); default value: false

Throws an error on failure.

Returns

pool ~= nil on success

`conn = pool:get(opts)`

Get a connection from pool. Reset connection before returning it. If connection is broken then it will be reestablished. If there is no free connections and timeout is not specified then calling fiber will sleep until another fiber returns some connection to pool. If timeout is specified, and there is no free connections for the duration of the timeout, then the return value is nil.

Options:

timeout - maximum number of seconds to wait for a connection

Returns:

conn ~= nil on success
conn == nil on there is no free connections when timeout option is specified

`pool:put(conn)`

Return a connection to connection pool.

Options

conn - a connection

`pool:close()`

Close all connections in pool.

Returns: true

Comments

All calls to connections api will be serialized, so it should to be safe to use one connection from some count of fibers. But you should understand, that you can have some unwanted behavior across db calls, for example if another fiber 'injects' some sql between two your calls.

	-- Case: the same, but for broken connection.
	test:test('loss a broken connection', function(test)
	test:plan(2)

	assert(pool.size >= 1, 'test case precondition fails')

	-- Get a connection, make a bad query and loss the
	-- connection.
	local conn = pool:get()
	local ok = pcall(conn.execute, conn, 'bad query')
	test:ok(not ok, 'a query actually fails')
	conn = nil -- luacheck: no unused

	-- Collect the lost connection.
	collectgarbage('collect')

	-- Verify that a pool is aware of collected connections.
	test:is(pool.queue:count(), pool.size, 'all connections are put back')
	end)

	-- Case: get a connection, broke it and put back.
	test:test('get, broke and put a connection', function(test)
	test:plan(2)

	assert(pool.size >= 1, 'test case precondition fails')

	-- Get a connection and make a bad query.
	local conn = pool:get()
	local ok = pcall(conn.execute, conn, 'bad query')
	test:ok(not ok, 'a query actually fails')

	-- Put the connection back and verify that the pool is full.
	pool:put(conn)
	test:ok(pool.queue:is_full(), 'a broken connection was given back')
	end)

	-- Case: the same, but loss and collect a connection after
	-- put.
	test:test('get, broke, put and loss a connection', function(test)
	test:plan(3)

	assert(pool.size >= 1, 'test case precondition fails')

	-- Get a connection and make a bad query.
	local conn = pool:get()
	local ok = pcall(conn.execute, conn, 'bad query')
	test:ok(not ok, 'a query actually fails')

	-- Put the connection back, loss it and trigger GC.
	pool:put(conn)
	conn = nil -- luacheck: no unused
	collectgarbage('collect')

	-- Verify that the pool is full
	test:ok(pool.queue:is_full(), 'a broken connection was given back')

	-- Verify the pool will not be populated by a connection's
	-- GC callback. Otherwise :put() will hang.
	local item = pool.queue:get()
	pool.queue:put(item)
	test:ok(true, 'GC callback does not put back a connection that was ' ..
	'put manually')
	end)

	int err = mysql_errno(raw_conn);
	switch (err) {
	case CR_SERVER_LOST:
	case CR_SERVER_GONE_ERROR:
	lua_pushnumber(L, -1);
	break;
	default:
	lua_pushnumber(L, 1);
	}

	if status ~= 0 then
	self.queue:put(status > 0)
	return error(datas)
	end

	-- get connection from pool
	local function conn_get(pool, timeout)
	local mysql_conn = pool.queue:get(timeout)

	-- A timeout was reached.
	if mysql_conn == nil then return nil end

	local status
	if mysql_conn == POOL_EMPTY_SLOT then
	status, mysql_conn = driver.connect(pool.host, pool.port or 0,
	pool.user, pool.pass,
	pool.db, pool.use_numeric_result)
	if status < 0 then
	return error(mysql_conn)
	end
	end

tarantool / mysql Goto Github PK

mysql's Introduction

mysql - MySQL connector for Tarantool

Getting Started

Prerequisites

Installation

Build from sources

Run tests

tt rocks

Install a package

Usage

API Documentation

conn = mysql.connect(opts)

conn:execute(statement, ...)

conn:begin()

conn:commit()

conn:rollback()

conn:ping()

conn:quote()

conn:reset(user, pass, db)

conn:close()

pool = mysql.pool_create(opts)

conn = pool:get(opts)

pool:put(conn)

pool:close()

Comments

See Also

mysql's People

Contributors

Stargazers

Watchers

Forkers

mysql's Issues

Reproduce case:

working cases

First, several facts

The problem

Proposed solution

Recommend Projects

Recommend Topics

Recommend Org

`conn = mysql.connect(opts)`

`conn:execute(statement, ...)`

`conn:begin()`

`conn:commit()`

`conn:rollback()`

`conn:ping()`

`conn:quote()`

`conn:reset(user, pass, db)`

`conn:close()`

`pool = mysql.pool_create(opts)`

`conn = pool:get(opts)`

`pool:put(conn)`

`pool:close()`