package caqti

You can search for identifiers within the package.

in-package search v0.2.0

caqti
- Library caqti
  - Caqti_common
  - Caqti_common_priv
    
    Option
    
    Result
    
    List
    
    Alog
  - Caqti_connect
    
    Make_unix
    
    Pool
    
    Stream
    
    CONNECTION
    
    Response
  - Caqti_connect_sig
    
    S
    
    Pool
    
    Stream
    
    CONNECTION
    
    Response
  - Caqti_connection
    
    Make_helpers
    
    Make_convenience
    
    Make_populate
  - Caqti_connection_sig
    
    Base
    
    Response
    
    Convenience
    
    Populate
    
    S
    
    Response
  - Caqti_driver_info
  - Caqti_driver_lib
  - Caqti_driver_sig
    
    System_common
    
    Mvar
    
    Log
    
    Stream
    
    System_unix
    
    Mvar
    
    Log
    
    Stream
    
    Unix
    
    Preemptive
    
    S
    
    CONNECTION
    
    Response
    
    Of_system_unix
    
    CONNECTION
    
    Response
  - Caqti_error
  - Caqti_heap
    
    S
    
    Make
  - Caqti_mult
  - Caqti_pool
    
    Make
  - Caqti_pool_sig
    
    S
  - Caqti_query
  - Caqti_request
  - Caqti_response_sig
    
    S
  - Caqti_sql
  - Caqti_sql_io
    
    MONAD
    
    S
    
    Make
  - Caqti_stream
    
    S
    
    FUTURE
    
    Make
  - Caqti_type
    
    Field
    
    Std
  - Caqti_type_sig
    
    Std
- Library caqti.blocking
  - Caqti_blocking
    
    Pool
    
    Stream
    
    CONNECTION
    
    Response
  - Caqti_blocking_sql_io
- Sources
  - caqti
    
    caqti_common.ml
    
    caqti_common_priv.ml
    
    caqti_connect.ml
    
    caqti_connection.ml
    
    caqti_driver_info.ml
    
    caqti_driver_lib.ml
    
    caqti_error.ml
    
    caqti_heap.ml
    
    caqti_mult.ml
    
    caqti_pool.ml
    
    caqti_query.ml
    
    caqti_request.ml
    
    caqti_sql.ml
    
    caqti_sql_io.ml
    
    caqti_stream.ml
    
    caqti_type.ml
  - caqti.blocking
    
    caqti_blocking.ml
    
    caqti_blocking_sql_io.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Caqti_driver_info`Source

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.

Sourcetype dialect_tag = private [>

| `Mysql
| `Pgsql
| `Sqlite

]

A tag used for easy dispatching between query languages.

Sourcetype sql_dialect_tag = [

| `Mysql
| `Pgsql
| `Sqlite

]

Subtype of the above which includes only known SQL dialects.

Sourcetype parameter_style = private [>

| `None
| `Linear of string
| `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.

Sourcetype t

Source

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.

Sourceval dummy : t

A dummy driver info, useful for instantiating queries for inspection.

Sourceval uri_scheme : t -> string

The URI scheme this backend binds to.

Sourceval 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 identify the language.

Sourceval parameter_style : t -> parameter_style

How to represent parameters in query strings.

Sourceval 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.

Sourceval 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.

Sourceval can_transact : t -> bool

Whether the database and driver supports transactions.

package caqti

Module Caqti_driver_infoSource

Module `Caqti_driver_info`Source