Module Caqti_driver_info

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.

type dialect_tag = private [>
  1. | `Mysql
  2. | `Pgsql
  3. | `Sqlite
]

A tag used for easy dispatching between query languages.

type sql_dialect_tag = [
  1. | `Mysql
  2. | `Pgsql
  3. | `Sqlite
]

Subtype of the above which includes only known SQL dialects.

type parameter_style = private [>
  1. | `None
  2. | `Linear of string
  3. | `Indexed of int -> string
]

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.

  • `None means that non of the following parameter styles apply, or that the driver does not support parameters at all.
  • `Linear s means that occurrences of s bind to successive parameters.
  • `Indexed f means that an occurrence of f i represents parameter number i, counting from 0.
type t
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 -> t

The function used by drivers to construct a description of themselves. For an explanation of the parameters, see the corresponding projections.

val uri_scheme : t -> string

The URI scheme this backend binds to.

val dialect_tag : t -> dialect_tag

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.

val parameter_style : t -> parameter_style

How to represent parameters in query strings.

val can_pool : t -> bool

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.

val can_concur : t -> bool

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.

val can_transact : t -> bool

Whether the database and driver supports transactions.