caqti index

Library caqti

This is classic API for Caqti, which mirrors the above libray and provides signatures, configurations, and a few other things for other Caqti packages. The plan in to uses wrapped module everywhere and to make some adjustments to the organization of modules. You may continue to use this for now, as deprecation is posponed until the complete replacement is available.

This library exposes the following toplevel modules:

• Caqti_connect_sig Signatures providing functions for establishing database connections.
• Caqti_connection_sig Signature of connection handles.
• Caqti_driver_info Information about a database, its driver, and its query language.
• Caqti_error Error descriptors.
• Caqti_mult Row multiplicity.
• Caqti_pool_config Pool configuration.
• Caqti_pool_sig Resource pool signature.
• Caqti_query Intermediate query string representation.
• Caqti_query_fmt Format-based query construction.
• Caqti_request Request specification.
• Caqti_response_sig Signature of a response from a database.
• Caqti_stream_sig Concurrent stream signature.
• Caqti_switch_sig Switch implementation used where not available.
• Caqti_type Type descriptors for fields and tuples.
• Caqti_type_sig Signatures for Caqti_type.

Preview library caqti.template

For now, this library is provides as a preview only. The interface will change in incompatible ways before it's declared ready for usage in production code.

This library provides the interface to create templates for requests to send to the database. A request template essentially combines a parametrised query string with a parameter encoder and a row decoder, and can often be defined statically. Execution of queries are handled by other packages, depending on your preferred concurrency and OS libraries.

The entry point of this library is the module: Caqti_template

Library caqti.blocking

This library implements the blocking (non-)concurrency using the unix library. Real concurrency support is provided by separate packages.

The entry point of this library is the module: Caqti_blocking.

Library caqti.plugin

This library registers a dynamic linker based on the dune-site.plugin library, which allows Caqti to automatically load driver libraries inferred from the URI when connecting to a new kind of database for the first time. It has entry point; linking aganist it provides all of its functionality.

This library is an experimental drop-in replacement for the caqti-dynload package.

Platform Libraries for Internal Use

The platform libraries are only meant for use in implementing drivers and concurrency support. These APIs are unstable, i.e. they can change between minor versions and without prior deprecation notices.

Library caqti.platform

The entry point of this library is the module: Caqti_platform.

Library caqti.platform.unix

The entry point of this library is the module: Caqti_platform_unix.