package caqti
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=e2b1d83b54f4583fc1cf4775d006c68cab4ec0b95a359ab724d5305ada737280
md5=7abd1ee41a02eb7483617cbc22b09691
doc/caqti/Caqti_driver_info/index.html
Module Caqti_driver_infoSource
Information about a database, its driver, and its query language.
This module provides descriptions supplied by the driver to aid the application in dealing with differences between database systems.
A tag used for easy dispatching between query languages.
Subtype of the above which includes only known SQL dialects.
How parameters are named. This is useful for SQL since the difference between dialects typically have an intrusive effect on query strings. This may also be useful for non-SQL languages which support some form of variables or placeholders.
`Nonemeans that non of the following parameter styles apply, or that the driver does not support parameters at all.`Linear smeans that occurrences ofsbind to successive parameters.`Indexed fmeans that an occurrence off irepresents parameter numberi, counting from 0.
val create :
uri_scheme:string ->
?dialect_tag:dialect_tag ->
?parameter_style:parameter_style ->
can_pool:bool ->
can_concur:bool ->
can_transact:bool ->
describe_has_typed_params:bool ->
describe_has_typed_fields:bool ->
unit ->
tThe function used by drivers to construct a description of themselves. For an explanation of the parameters, see the corresponding projections.
A variant indicating the SQL dialect or other query language, used for easy dispatching when constructing queries. Can be omitted if non of the cases applies, but this means clients must inspect the backend-info to indentify the language.
How to represent parameters in query strings.
Whether it makes sense to keep connections around for later reuse when using this driver. As hard requirements, the driver must clear any state which could affect subsequent operation, and it must reliably detect whether the connection is still in a usable state. As a further indicator, the overhead of establishing and closing connections should be high enough that it pays of to keep connections around.
Whether the driver supports concurrent operation. This is just a hint; it is up to the driver to serialize connections with locking primitives or other means.