package pgocaml

  1. Overview
  2. Docs
Interface to PostgreSQL databases

Install 

dune-project
 Dependency

pgocaml.forge.ocamlcore.org Edit opam file Versions (9)

Authors

  1. R
    Richard W.M. Jones <rich@annexia.org>

Maintainers

  1. D
    Dario Teixeira <dario.teixeira@nleyten.com>

Sources

v2.2.tar.gz
sha256=3027ca823f9f3db24475bd36e5628ee259605d72048d889be3b7e32c3e850d74
md5=37f88b0eb1db2d56e6e241d2cd6476e9

doc/pgocaml/PGOCaml/index.html

Module PGOCaml

module Simple_thread : PGOCaml_generic.THREAD with type 'a t = 'a
include PGOCaml_generic.PGOCAML_GENERIC with type 'a monad = 'a
type 'a t
type 'a monad = 'a
type isolation = [
  1. | `Serializable
  2. | `Repeatable_read
  3. | `Read_committed
  4. | `Read_uncommitted
]
type access = [
  1. | `Read_write
  2. | `Read_only
]
exception Error of string
exception PostgreSQL_Error of string * (char * string) list
val connect : ?host:string -> ?port:int -> ?user:string -> ?password:string -> ?database:string -> ?unix_domain_socket_dir:string -> unit -> 'a t monad
val close : 'a t -> unit monad
val ping : 'a t -> unit monad
val alive : 'a t -> bool monad
val begin_work : ?isolation:isolation -> ?access:access -> ?deferrable:bool -> 'a t -> unit monad
val commit : 'a t -> unit monad
val rollback : 'a t -> unit monad
val transact : 'a t -> ?isolation:isolation -> ?access:access -> ?deferrable:bool -> ('a t -> 'b monad) -> 'b monad
val serial : 'a t -> string -> int64 monad
val serial4 : 'a t -> string -> int32 monad
val serial8 : 'a t -> string -> int64 monad
val max_message_length : int ref
val verbose : int ref
val set_private_data : 'a t -> 'a -> unit
val private_data : 'a t -> 'a
val uuid : 'a t -> string
type pa_pg_data = (string, bool) Hashtbl.t
type oid = int32
type param = string option
type result = string option
type row = result list
val prepare : 'a t -> query:string -> ?name:string -> ?types:oid list -> unit -> unit monad
val execute_rev : 'a t -> ?name:string -> ?portal:string -> params:param list -> unit -> row list monad
val execute : 'a t -> ?name:string -> ?portal:string -> params:param list -> unit -> row list monad
val cursor : 'a t -> ?name:string -> ?portal:string -> params:param list -> (row -> unit monad) -> unit monad
val close_statement : 'a t -> ?name:string -> unit -> unit monad
val close_portal : 'a t -> ?portal:string -> unit -> unit monad
val inject : 'a t -> ?name:string -> string -> row list monad
val alter : 'a t -> ?name:string -> string -> unit monad
type row_description = result_description list
and result_description = {
  1. name : string;
  2. table : oid option;
  3. column : int option;
  4. field_type : oid;
  5. length : int;
  6. modifier : int32;
}
type params_description = param_description list
and param_description = {
  1. param_type : oid;
}
val describe_statement : 'a t -> ?name:string -> unit -> (params_description * row_description option) monad
val describe_portal : 'a t -> ?portal:string -> unit -> row_description option monad
val name_of_type : ?modifier:int32 -> oid -> string
type inet = Unix.inet_addr * int
type int16 = int
type bytea = string
type point = float * float
type hstore = (string * string option) list
type numeric = string
type bool_array = bool option list
type int32_array = int32 option list
type int64_array = int64 option list
type string_array = string option list
type float_array = float option list
val string_of_oid : oid -> string
val string_of_bool : bool -> string
val string_of_int : int -> string
val string_of_int16 : int16 -> string
val string_of_int32 : int32 -> string
val string_of_int64 : int64 -> string
val string_of_float : float -> string
val string_of_point : point -> string
val string_of_hstore : hstore -> string
val string_of_numeric : numeric -> string
val string_of_inet : inet -> string
val string_of_timestamp : CalendarLib.Calendar.t -> string
val string_of_timestamptz : timestamptz -> string
val string_of_date : CalendarLib.Date.t -> string
val string_of_time : CalendarLib.Time.t -> string
val string_of_interval : CalendarLib.Calendar.Period.t -> string
val string_of_bytea : bytea -> string
val string_of_string : string -> string
val string_of_unit : unit -> string
val string_of_bool_array : bool_array -> string
val string_of_int32_array : int32_array -> string
val string_of_int64_array : int64_array -> string
val string_of_string_array : string_array -> string
val string_of_float_array : float_array -> string
val oid_of_string : string -> oid
val bool_of_string : string -> bool
val int_of_string : string -> int
val int16_of_string : string -> int16
val int32_of_string : string -> int32
val int64_of_string : string -> int64
val float_of_string : string -> float
val point_of_string : string -> point
val hstore_of_string : string -> hstore
val numeric_of_string : string -> numeric
val inet_of_string : string -> inet
val timestamp_of_string : string -> CalendarLib.Calendar.t
val timestamptz_of_string : string -> timestamptz
val date_of_string : string -> CalendarLib.Date.t
val time_of_string : string -> CalendarLib.Time.t
val interval_of_string : string -> CalendarLib.Calendar.Period.t
val bytea_of_string : string -> bytea
val unit_of_string : string -> unit
val bool_array_of_string : string -> bool_array
val int32_array_of_string : string -> int32_array
val int64_array_of_string : string -> int64_array
val string_array_of_string : string -> string_array
val float_array_of_string : string -> float_array
val bind : 'a monad -> ('a -> 'b monad) -> 'b monad
val return : 'a -> 'a monad