mysql_protocol 1.1 · OCaml Package

type client_error = {

client_error_errno : int;
client_error_sqlstate : string;
client_error_message : string;

}

exception Error of client_error

exception Fetch_no_more_rows

type configuration = {

sockaddr : Unix.sockaddr;
capabilities : Mp_capabilities.capabilities list;
max_packet_size : Int64.t;
charset_number : int;
user : string;
password : string;
databasename : string;

}

type connection = {

configuration : configuration;
mutable channel : (Pervasives.in_channel * Pervasives.out_channel) option;
mutable handshake : Mp_handshake.handshake option;

}

type dml_dcl_result = {

affected_rows : Int64.t;
insert_id : Int64.t;
server_status : int;
warning_count : int;
message : string;

}

type prepare_result = {

prepare_handler : Int64.t;
prepare_nb_columns : int;
prepare_nb_parameters : int;
prepare_warning_count : int;
prepare_parameters_fields : Mp_field_packet.field_packet list;
prepare_parameters_names : Mp_field.field_name list;
prepare_columns_fields : Mp_field_packet.field_packet list;
prepare_columns_names : Mp_field.field_name list;

}

type result = private

| Result_set of Mp_result_set_packet.result_select
| Result_ok of dml_dcl_result
| Result_multiple of result list

type executable_statement = private

| Created_statement of string
| Prepared_statement of string * prepare_result

type execute_result = private

| Executed_statement of string * result
| Executed_prepared_statement of string * prepare_result * result
| Executed_prepared_statement_with_cursor of string * prepare_result

val error_exception_to_string : client_error -> string

val dml_dcl_result_to_string : dml_dcl_result -> string

val configuration : 
  user:string ->
  password:string ->
  sockaddr:Unix.sockaddr ->
  ?databasename:string ->
  ?max_packet_size:Int64.t ->
  ?charset:(Mp_charset.charset_name * Mp_charset.collation_name) ->
  ?capabilities:Mp_capabilities.capabilities list ->
  unit ->
  configuration

val connect : configuration:configuration -> ?force:bool -> unit -> connection

val reset_session : connection:connection -> unit

val use_database : connection:connection -> databasename:string -> unit

val ping : connection:connection -> unit

val create_statement_from_string : string -> executable_statement

val prepare : 
  connection:connection ->
  statement:executable_statement ->
  executable_statement

val execute : 
  connection:connection ->
  statement:executable_statement ->
  ?filter:((string * int) list -> Mp_data.native_data list -> bool) option ->
  ?iter:((string * int) list -> Mp_data.native_data list -> unit) option ->
  ?return_all_raw_mysql_data:bool ->
  ?params:Mp_data.native_data list ->
  ?bind:Mp_execute.bind ->
  ?flag:Mp_execute.flag ->
  unit ->
  execute_result

val get_result : execute_result -> result

val get_result_set : execute_result -> Mp_result_set_packet.result_select

val get_result_multiple : execute_result -> result list

val get_result_ok : execute_result -> dml_dcl_result

val fetch : 
  connection:connection ->
  statement:execute_result ->
  ?nb_rows:int64 ->
  ?filter:((string * int) list -> Mp_data.native_data list -> bool) option ->
  ?iter:((string * int) list -> Mp_data.native_data list -> unit) option ->
  ?return_all_raw_mysql_data:bool ->
  unit ->
  result

val get_fetch_result_set : result -> Mp_result_set_packet.result_select

val close_statement : 
  connection:connection ->
  statement:executable_statement ->
  unit

val disconnect : connection:connection -> unit

package mysql_protocol