Jq/overhaul2 (#94)

* Overhaul the package to modernize the API, provide better type conversion support, and fix several outstanding issues. Also ensures CI-testing works for OSX.

Author: quinnj

.travis.yml

@@ -1,19 +1,20 @@
 # Documentation: http://docs.travis-ci.com/user/languages/julia/
 language: julia
+
 services:
   - mysql
+
 os:
   - linux
   - osx
+
 julia:
   - 0.6
   - nightly
+
 notifications:
   email: false
-# uncomment the following lines to override the default test script
-#script:
-#  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-#  - julia -e 'Pkg.clone(pwd()); Pkg.build("MySQL"); Pkg.test("MySQL"; coverage=true)'
+
 after_success:
   # push coverage results to Coveralls
   - julia -e 'cd(Pkg.dir("MySQL")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
@@ -22,6 +23,9 @@ after_success:
 before_script:
   - export OLD_PATH=$LD_LIBRARY_PATH
   - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`mysql_config --libs | cut -d ' ' -f1 | sed 's/-L//'`
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install mysql          ; fi
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then mysql.server start          ; fi
+
 after_script:
   - export LD_LIBRARY_PATH=$OLD_PATH
   - unset OLD_PATH

REQUIRE

@@ -1,3 +1,5 @@
 julia 0.6
-DataFrames 0.11
+DataStreams
 Compat 0.39.0
+Missings
+DecFP

src/MySQL.jl

@@ -1,16 +1,129 @@
 __precompile__(true)
 module MySQL
-    using Compat
-    using DataFrames
-    using Missings
-    using Compat.Dates
-
-    include("config.jl")
-    include("consts.jl")
-    include("types.jl")
-    include("datetime.jl")
-    include("api.jl")
-    include("results.jl")
-    include("iterators.jl")
-    include("handy.jl")
+using Compat, Compat.Dates
+using DataStreams, Missings
+
+export Data
+
+@static if isdefined(Core, :NamedTuple)
+    macro NT(args...)
+        return esc(:(($(args...),)))
+    end
+else
+    using NamedTuples
 end
+
+abstract type MySQLError end
+# For errors that happen in MySQL.jl
+mutable struct MySQLInterfaceError <: MySQLError
+    msg::String
+end
+Base.showerror(io::IO, e::MySQLInterfaceError) = print(io, e.msg)
+
+include("api.jl")
+using .API
+
+include("types.jl")
+
+function setoptions!(ptr, opts)
+    ptr == C_NULL && throw(MySQLInterfaceError("`MySQL.setoptions!` called with NULL connection."))
+    for (k, v) in opts
+        val = API.mysql_options(ptr, k, v)
+        val != 0 && throw(MySQLInternalError(ptr))
+    end
+    nothing
+end
+
+"""
+    MySQL.connect(host::String, user::String, passwd::String; db::String = "", port = "3306", socket::String = MySQL.API.MYSQL_DEFAULT_SOCKET, opts = Dict())
+
+Connect to a MySQL database.
+"""
+function connect(host::String, user::String, passwd::String; db::String="", port::Integer=3306, unix_socket::String=API.MYSQL_DEFAULT_SOCKET, client_flag=API.CLIENT_MULTI_STATEMENTS, opts = Dict())
+    _ptr = C_NULL
+    _ptr = API.mysql_init(_ptr)
+    _ptr == C_NULL && throw(MySQLInterfaceError("Failed to initialize MySQL database"))
+    setoptions!(_ptr, opts)
+    ptr = API.mysql_real_connect(_ptr, host, user, passwd,
+                                  db, UInt32(port), unix_socket, client_flag)
+    ptr == C_NULL && throw(MySQLInternalError(_ptr))
+    return Connection(ptr, host, string(port), user, db)
+end
+
+"""
+    MySQL.disconnect(conn::MySQL.Connection)
+
+Close a handle to a MySQL database opened by `MySQL.connect`.
+"""
+function disconnect(conn::Connection)
+    conn.ptr == C_NULL && throw(MySQLInterfaceError("Method called with NULL connection."))
+    API.mysql_close(conn.ptr)
+    conn.ptr = C_NULL
+    conn.host = ""
+    conn.user = ""
+    conn.db = ""
+    return nothing
+end
+
+function insertid(conn::Connection)
+    conn.ptr == C_NULL && throw(MySQLInterfaceError("MySQL.insertid called with NULL connection."))
+    return API.mysql_insert_id(conn.ptr)
+end
+
+"""
+    MySQL.escape(conn::MySQL.Connection, str::String) -> String
+
+Escapes a string using `mysql_real_escape_string()`, returns the escaped string.
+"""
+function escape(conn::MySQL.Connection, str::String)
+    output = Vector{UInt8}(uninitialized, length(str) * 2 + 1)
+    output_len = API.mysql_real_escape_string(conn.ptr, output, str, Culong(length(str)))
+    if output_len == typemax(Cuint)
+        throw(MySQLInternalError(conn))
+    end
+    return String(output[1:output_len])
+end
+
+"""
+    MySQL.execute!(conn, sql) => Void
+
+execute an sql statement without returning results (useful for DDL statements, update, delete, etc.)
+"""
+function execute!(conn::Connection, sql::String)
+    conn.ptr == C_NULL && throw(MySQLInterfaceError("`MySQL.execute!` called with NULL connection."))
+    API.mysql_query(conn.ptr, sql) == 0 || throw(MySQLInternalError(conn))
+    return API.mysql_affected_rows(conn.ptr)
+end
+
+"""
+    MySQL.query(conn, sql, sink=Data.Table; append::Bool=false) => sink
+
+execute an sql statement and return the results in `sink`, which can be any valid `Data.Sink` (interface from DataStreams.jl). By default, a NamedTuple of Vectors are returned.
+
+Passing `append=true` as a keyword argument will cause the resultset to be _appended_ to the sink instead of replacing.
+"""
+function query end
+
+function query(conn::Connection, sql::String, sink::Type=Data.Table, args...; append::Bool=false, kwargs...)
+    source = Query(conn, sql; kwargs...)
+    sink = Data.stream!(source, sink, args...; append=append)
+    return Data.close!(sink)
+end
+
+function query(conn::Connection, sql::String, sink::T; append::Bool=false, kwargs...) where {T}
+    source = Query(conn, sql; kwargs...)
+    sink = Data.stream!(source, sink; append=append)
+    return Data.close!(sink)
+end
+
+query(source::Query, sink=Data.Table, args...; append::Bool=false, transforms::Dict=Dict{Int,Function}()) = (sink = Data.stream!(source, sink, args...; append=append, transforms=transforms); return Data.close!(sink))
+query(source::Query, sink::T; append::Bool=false, transforms::Dict=Dict{Int,Function}()) where {T} = (sink = Data.stream!(source, sink; append=append, transforms=transforms); return Data.close!(sink))
+
+include("prepared.jl")
+
+Base.@deprecate mysql_options MySQL.setoptions!
+Base.@deprecate mysql_connect MySQL.connect
+Base.@deprecate mysql_disconnect MySQL.disconnect
+Base.@deprecate mysql_insert_id MySQL.insertid
+
+end # module