111 lines
3.1 KiB
Erlang
111 lines
3.1 KiB
Erlang
%% @author Maas-Maarten Zeeman <mmzeeman@xs4all.nl>
|
|
%% @copyright 2011 Maas-Maarten Zeeman
|
|
|
|
%% @doc Low level erlang API for sqlite3 databases
|
|
|
|
%% Copyright 2011 Maas-Maarten Zeeman
|
|
%%
|
|
%% 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.
|
|
|
|
-module(esqlite3_nif).
|
|
-author("Maas-Maarten Zeeman <mmzeeman@xs4all.nl>").
|
|
|
|
%% low-level exports
|
|
-export([start/0,
|
|
open/4,
|
|
exec/4,
|
|
prepare/4,
|
|
step/3,
|
|
finalize/3,
|
|
bind/4,
|
|
column_names/3,
|
|
close/3
|
|
]).
|
|
|
|
-on_load(init/0).
|
|
|
|
init() ->
|
|
PrivDir = case code:priv_dir(esqlite) of
|
|
{error, bad_name} -> "./priv";
|
|
Dir -> Dir
|
|
end,
|
|
ok = erlang:load_nif(PrivDir ++ "/esqlite3_nif", 0).
|
|
|
|
%% @doc Start a low level thread which will can handle sqlite3 calls.
|
|
%%
|
|
%% @spec start() -> {ok, connection()} | {error, msg()}
|
|
start() ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc Open the specified sqlite3 database.
|
|
%%
|
|
%% Sends an asynchronous open command over the connection and returns
|
|
%% ok immediately. When the database is opened
|
|
%%
|
|
%% @spec open(connection(), reference(), pid(), string()) -> ok | {error, message()}
|
|
open(_Db, _Ref, _Dest, _Filename) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc Exec the query.
|
|
%%
|
|
%% Sends an asynchronous exec command over the connection and returns
|
|
%% ok immediately.
|
|
%%
|
|
%% When the statement is executed Dest will receive message {Ref, answer()}
|
|
%% with answer() integer | {error, reason()}
|
|
%%
|
|
%% @spec exec(connection(), Ref::reference(), Dest::pid(), string()) -> ok | {error, message()}
|
|
exec(_Db, _Ref, _Dest, _Sql) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc
|
|
%%
|
|
%% @spec prepare(connection(), reference(), pid(), string()) -> ok | {error, message()}
|
|
prepare(_Db, _Ref, _Dest, _Sql) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc
|
|
%%
|
|
%% @spec step(statement(), reference(), pid()) -> ok | {error, message()}
|
|
step(_Stmt, _Ref, _Dest) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc
|
|
%%
|
|
%%
|
|
finalize(_Stmt, _Ref, _Dest) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc Bind parameters to a prepared statement.
|
|
%%
|
|
%% @spec bind(statement(), reference(), pid(), []) -> ok | {error, message()}
|
|
bind(_Stmt, _Ref, _Dest, _Args) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc Retrieve the column names of the prepared statement
|
|
%%
|
|
%% @spec column_names(statement(), reference(), pid()) -> {ok, tuple()} | {error, message()}
|
|
column_names(_Stmt, _Ref, _Dest) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
%% @doc Close the connection.
|
|
%%
|
|
%% @spec close(connection(), reference(), pid()) -> ok | {error, message()}
|
|
close(_Db, _Ref, _Dest) ->
|
|
exit(nif_library_not_loaded).
|
|
|
|
|
|
|
|
|
|
|