package caqti

  1. Overview
  2. Docs
Abstraction over multiple database libraries

Install 

dune-project
 Dependency

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

Authors

  1. P
    Petter A. Urkedal

Maintainers

  1. P
    paurkedal@gmail.com

Sources

caqti-0.9.0.tbz
sha256=4c84a16d983d0fed2786f536a3fa4d8fa113b8b30b4deea4a74772582d5489b2
md5=42a2e2d3b73d7fbaecc618549aad2865

doc/caqti.v1/Caqti1_query/index.html

Module Caqti1_querySource

(v1) One-shot and prepared queries.

  • deprecated

    Don't use this in new code.

Sourceexception Missing_query_string

The exception to raise in a callback passed to the various query functions below, to indicate that a query language is unsupported.

Sourcetype oneshot_query = Caqti_driver_info.t -> string

The type of one-shot queries.

Sourcetype prepared_query = private {
  1. pq_index : int;
    (*

    A relatively small integer unique to each query, made available to backends for efficient caching of language dependent data.

    *)
  2. pq_name : string;
    (*

    A name to use for the prepared query.

    *)
  3. pq_encode : Caqti_driver_info.t -> string;
    (*

    The SQL for each query language.

    *)
}

The type of prepared queries.

Sourcetype query =
  1. | Oneshot of oneshot_query
    (*

    A one-shot query.

    *)
  2. | Prepared of prepared_query
    (*

    A prepared query.

    *)

The type of queries accepted by the CONNECTION API.

Sourceval oneshot_full : (Caqti_driver_info.t -> string) -> query

Create a one-shot family of query strings indexed by full query language descriptors.

Sourceval oneshot_fun : (Caqti_driver_info.dialect_tag -> string) -> query

Create a one-shot family of query strings indexed by language tags.

Sourceval oneshot_any : string -> query

Create a one-shot query string indiscriminately passed to any backend.

Sourceval oneshot_sql : string -> query

Create a one-shot query string expected to work with any SQL dialect.

Sourceval oneshot_sql_p : ?env:(Caqti_driver_info.dialect_tag -> string -> string) -> string -> query

Create a one-shot query string expected to work with any SQL dialect after conversion of parameters.

  • parameter env

    If provided, parameters in the form accepted by Buffer.add_substitute will be substituted using this environment.

Sourceval prepare_full : ?name:string -> (Caqti_driver_info.t -> string) -> query

Create a prepared statement dispatching on the full query language descriptor.

  • parameter name

    A fixed name for the query.

Sourceval prepare_fun : ?name:string -> (Caqti_driver_info.dialect_tag -> string) -> query

Create a prepared statement dispatching on the language tag.

  • parameter name

    A fixed name for the query.

Sourceval prepare_any : ?name:string -> string -> query

Create a prepared statement accepted by any backend. This only makes sense if backend are known to be restricted to a set sharing a common query string. Consider using prepare_sql or oneshot instead.

  • parameter name

    A fixed name for the query.

Sourceval prepare_sql : ?name:string -> string -> query

Create a prepared statement expected to work with any SQL dialect.

  • parameter name

    A fixed name for the query.

Sourceval prepare_sql_p : ?name:string -> ?env:(Caqti_driver_info.dialect_tag -> string -> string) -> string -> query

Create a prepared statement expected to work with any SQL dialect after conversion of parameters.

  • parameter name

    A fixed name for the query.

  • parameter env

    If provided, parameters in the form accepted by Buffer.add_substitute will be substituted using this environment.

Sourcetype query_info = [
  1. | `Oneshot of string
  2. | `Prepared of string * string
]

An informative analogue of query, used for error reporting. For prepared queries, the first constructor argument is the name of the query.

Sourceval make_query_info : Caqti_driver_info.t -> query -> query_info

make_query_info backend query extracts the query string from query as seen by backend, for use in logging and error reporting.