package caqti

You can search for identifiers within the package.

in-package search v0.2.0

Unified interface to relational database libraries

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (21)

Authors

P

Petter A. Urkedal

Maintainers

P

paurkedal@gmail.com

Sources

caqti-0.10.2.tbz

sha256=d688bd22f6fde5be5a755900545fade0d5fdce6dbcb0b85770d02dad87c41e7c

md5=d18745a703da336054c0d27e78f8be8a

doc/caqti.v1/Caqti1_describe/index.html

Module `Caqti1_describe`Source

(v1) Types and utility functions for query descriptions.

deprecated
Don't use this in new code.

Sourcetype typedesc = [

| `Bool
| `Int
| `Float
| `String
| `Bytes
| `Date
| `Utc
| `Other of string
| `Unknown

]

Identification of a remote type. These correspond to the types described in Caqti_sigs.CONNECTION.Param. `Other s represents an backend-specific type s. The additional `Unknown tag is used by backends which are unable to determine parameter types.

Sourcetype querydesc = {

querydesc_params : typedesc array;
(*
The types of the expected parameters for a query. The number of parameters should always correspond to the length of the array, but the parameters may be `Unknown in case the backend is unable to determine them.
*)
querydesc_fields : (string * typedesc) array;
(*
The names and types of components of tuples returned by the query.
*)

}

The result of Caqti_sigs.CONNECTION.describe.

Sourceval string_of_typedesc : typedesc -> string

An informative textual representation of a type.

Sourceval string_of_querydesc : querydesc -> string

An informative textual description of query parameters and results.