freetds 0.6 · OCaml Package

exception End_results

exception End_data

exception Cancelled

exception Cmd_fail

exception Datatype_not_implemented

type binding_buffer

I've added this type to be an opaque "void*" type that will return a sql_t

type context

Identifies the Client-Library context being initialized.

type connection

Contains information about a particular client/server connection.

type status = [

| `CanBeNull
| `Identity
| `NoData
| `Return

]

type column = {

col_name : string;
col_status : status list;
col_buffer : binding_buffer;

}

type sql_t = [

| `Bit of bool
| `Tinyint of int
| `Smallint of int
| `Int of int32
| `Text of string
| `String of string
| `Binary of string
| `Float of float
| `Datetime of string
| `Decimal of string
| `Null

]

val ctx_create : unit -> context

Context

Connection

val con_alloc : context -> connection

type string_property = [

| `Appname
| `Password
| `Username

]

CS_APPNAME, CS_PASSWORD, and CS_USERNAME - there are others but I've never used them... Easy to add on demand; patches welcome

type prop_action = [

| `Clear
| `Get
| `Set

]

CS_CLEAR CS_GET and CS_SET

val con_setstring : connection -> string_property -> string -> unit

val connect : connection -> string -> unit

connect conn servername connect to the server servername.

val close : ?force:bool -> connection -> unit

Command

type command

CS_COMMAND

val cmd_alloc : connection -> command

type cmd_type = [

| `Lang
| `Rpc

]

CS_LANG and CS_RPC - rpc is currently not really implemented

you'll notice no ct_param wrapper

type cmd_option = [

| `NoRecompile
| `Recompile

]

Options for compiling CS_NORECOMPILE and CS_RECOMPILE

val command : command -> cmd_type -> ?option:cmd_option -> string -> unit

val send : command -> unit

Results

type result_type = [

| `Cmd_done
| `Cmd_fail
| `Cmd_succeed
| `Param
| `Row
| `Status

]

Result types; usually we only care about Row

val results : command -> result_type

type resinfo_type = [

| `Cmd_number
| `Numdata
| `Row_count

]

val res_info : command -> resinfo_type -> int

res_info cmd `Cmd_number returns the number of the command that generated the current result set.
res_info cmd `Numdata returns the number of columns in the current result set.
res_info cmd `Row_count returns the number of rows affected by the current command.

val fetch : command -> int

val bind : command -> ?maxlen:int -> int -> column

val buffer_contents : binding_buffer -> sql_t

Inline error handling

type severity =

| Inform
| Api_fail
| Retry_fail
| Resource_fail
| Comm_fail
| Internal_fail
| Fatal

val get_messages : 
  ?client:bool ->
  ?server:bool ->
  connection ->
  (severity * string) list

package freetds

Connection

Command

Results

Inline error handling