class connection :Class of connections.?host:string -> ?hostaddr:string -> ?port:string -> ?dbname:string -> ?user:string -> ?password:string -> ?options:string -> ?tty:string -> ?requiressl:string -> ?conninfo:string -> unit ->
object
..end
When conninfo
is given, it will be used instead of all other
optional arguments.
method finish : unit
#finish
closes the connection.Error
if there is a connection error.method try_reset : unit
#try_reset
tries to reset the connection if it is bad. If
resetting fails, the error
exception will be raised with
Connection_failure
.Error
if there is a connection error.method reset : unit
#reset
resets the connection.Error
if there is a connection error.method notifies : (string * int) option
#notifies
Error
if there is a connection error.Some (name, pid)
if available (None
otherwise), where name
is the name the of relation containing
data, pid
the process id of the backend.method set_notice_processor : (string -> unit) -> unit
#set_notice_processor
controls reporting of notice and warning
messages generated by a connection.Error
if there is a connection error.method db : string
#db
Error
if there is a connection error.method user : string
#user
Error
if there is a connection error.method pass : string
#pass
Error
if there is a connection error.method host : string
#host
Error
if there is a connection error.method port : string
#port
Error
if there is a connection error.method tty : string
#tty
Error
if there is a connection error.method options : string
#options
Error
if there is a connection error.method status : connection_status
#status
Error
if there is a connection error.method error_message : string
#error_message
Error
if there is a connection error.method backend_pid : int
#backend
Error
if there is a connection error.method empty_result : result_status -> result
empty_result stat
Error
if there is a connection error.stat
.method exec : ?expect:result_status list -> string -> result
exec ?expect query
synchronous execution of query or command
query
. The result status will be checked against all elements
in expect
. If expect
is not empty and if there is no match,
the exception Unexpected_status
will be raised.Error
if there is a connection error.Error
if there is an unexpected result status.expect
: default = []method send_query : string -> unit
send_query query
asynchronous execution of query or command
query
.Error
if there is a connection error.method get_result : result option
get_result
Error
if there is a connection error.Some result
of an asynchronous query if
available or None
.method getline : ?pos:int -> ?len:int -> string -> getline_result
getline ?pos ?len buf
reads a newline-terminated line of at most
len
characters into buf
starting at position pos
.Invalid_argument
if the buffer parameters are invalid.Error
if there is a connection error.pos
: default = 0len
: default = String.length buf - posmethod getline_async : ?pos:int -> ?len:int -> string -> getline_async_result
getline_async ?pos ?len buf
reads a newline-terminated line of
at most len
characters into buf
starting at position pos
(asynchronously). No need to call endcopy
after receiving
EndOfData
.Invalid_argument
if the buffer parameters are invalid.Error
if there is a connection error.pos
: default = 0len
: default = String.length buf - posmethod putline : string -> unit
putline str
sends str
to backend server. Don't use this method
for binary data, use putnbytes instead!Error
if there is a connection error.method putnbytes : ?pos:int -> ?len:int -> string -> unit
putnbytes ?pos ?len buf
sends the substring of buf
of length
len
starting at pos
to backend server (use this method for
binary data).Invalid_argument
if the buffer parameters are invalid.Error
if there is a connection error.pos
: default = 0len
: default = String.length buf - posmethod endcopy : unit
endcopy
synchronizes with the backend.Error
if there is a connection error.method copy_out : (string -> unit) -> unit
copy_out f
applies f
to each line returned by backend server.Error
if there is a connection error.method copy_out_channel : Pervasives.out_channel -> unit
copy_out_channel ch
sends each line returned by backend server
to output channel ch
.Error
if there is a connection error.method copy_in_channel : Pervasives.in_channel -> unit
copy_in_channel ch
sends each line in input channel ch
to
backend server.Error
if there is a connection error.method set_nonblocking : bool -> unit
set_nonblocking b
sets state of the connection to nonblocking if
b
is true and to blocking otherwise.Error
if there is a connection error.method is_nonblocking : bool
is_nonblocking
Error
if there is a connection error.method consume_input : unit
consume_input
consume any available input from backend.Error
if there is a connection error.method is_busy : bool
is_busy
Error
if there is a connection error.method flush : unit
flush
attempts to flush any data queued to the backend.Error
if there is a connection error.method socket : Unix.file_descr
socket
obtains the file descriptor for the backend connection
socket.Error
if there is a connection error.method request_cancel : unit
request_cancel
requests that PostgreSQL abandon processing of
the current command.Error
if there is a connection error.method lo_creat : oid
lo_creat
creates a new large object and returns its oid.Error
if there is a connection error.method lo_import : string -> oid
lo_import filename
imports an operating system file given by
filename
as a large object.Error
if there is a connection error.method lo_export : oid -> string -> unit
lo_export oid filename
exports the large object given by oid
to an operating system file given by filename
.Error
if there is a connection error.method lo_open : oid -> large_object
lo_open oid
opens the large object given by oid
for reading and
writing.Error
if there is a connection error.method lo_write : ?pos:int -> ?len:int -> string -> large_object -> unit
lo_write ?pos ?len buf lo
writes len
bytes of buffer buf
starting at position pos
to large object lo
.Invalid_argument
if the buffer parameters are invalid.Error
if len
bytes could not be written.Error
if there is a connection error.pos
: default = 0len
: default = String.length buf - posmethod lo_read : large_object -> ?pos:int -> ?len:int -> string -> int
lo_read lo ?pos ?len buf
reads len
bytes from large object lo
to buffer buf
starting at position pos
.Invalid_argument
if the buffer parameters are invalid.Error
if len
bytes could not be read.Error
if there is a connection error.pos
: default = 0len
: default = String.length buf - posmethod lo_seek : ?pos:int -> ?whence:seek_cmd -> large_object -> unit
lo_seek ?pos ?whence lo
seeks read/write position pos
in
large object lo
relative to the start, current read/write
position, or end of the object (whence
is SEEK_SET, SEEK_CUR,
SEEK_END respectively).Error
if there is a connection error.pos
: default = 0whence
: default = SEEK_SET
method lo_tell : large_object -> int
lo_tell lo
Error
if there is a connection error.lo
.method lo_close : large_object -> unit
lo_close lo
closes large object lo
.Error
if there is a connection error.method lo_unlink : oid -> unit
lo_unlink oid
removes the large object specified by oid
from the
database.Error
if there is a connection error.method escape_bytea : ?pos:int -> ?len:int -> string -> string
escape_bytea ?pos ?len str
escapes binary substring str
of length len
starting at position pos
for use within SQL.pos
: default = 0len
: default = String.length str - pos