package azure-cosmos-db-eio

Azure cosmos db

Provides an interface to Microsoft Azure Cosmos db.

Documentation

Microsoft documentation

API documentation

Quick start

module MyAuthKeys : Auth_key = struct
  let master_key = "key guid found in azure portal"
  let endpoint = "endpoint found in azure portal (e.g. endpoint.documents.azure.com)"
end

module D = Database (MyAuthKeys)
D.list_databases ()

Resource tokens

A resource token minted through User/Permission can be used instead of the master key. The token is sent as-is in the authorization header, so only the resources it was granted access to are reachable:

module D_token =
  Database_as ((val credentials_of_token ~endpoint "type=resource&ver=1&sig=..."))

(* Refresh the token on every request, e.g. from a token broker: *)
module D_refreshing =
  Database_as ((val credentials_of_token_provider ~endpoint fetch_token))

Permission tokens expire after about an hour by default; pass ?expiry_seconds (1..18000) to Permission.create, Permission.get, or Permission.replace to choose the lifetime.

Change feed

The pull-model change feed returns the latest version of changed documents. Treat 304 Not Modified as the normal idle result, and persist the returned ETag checkpoint in the application:

let%lwt first = D.Collection.Change_feed.read
  ~start_from:D.Collection.Change_feed.Start_from.Now
  "my-database" "my-collection"
in
match first with
| Ok (304, _headers, None) -> Lwt.return_unit
| Ok (200, _headers, Some page) ->
    (* Process [page.documents], then persist [page.continuation]. *)
    let%lwt next = D.Collection.Change_feed.read
      ~start_from:
        (D.Collection.Change_feed.Start_from.Continuation page.continuation)
      "my-database" "my-collection"
    in
    ignore next;
    Lwt.return_unit
| Error _error -> Lwt.fail_with "Change feed request failed"

The checkpoint is the caller's responsibility. Ordering is guaranteed only within a partition key. For independent partition-range checkpoints, enumerate the ranges and fan out explicitly with the backend's IO.parallel_map:

let%lwt ranges = D.Collection.Partition_key_range.ids
  "my-database" "my-collection"
in
(* Keep one checkpoint per range while polling each range independently. *)

Latest-version mode does not surface deletes. If deletions must be represented in the feed, use a soft-delete flag and TTL instead.

Throughput management

Offers expose provisioned throughput for databases and collections:

let%lwt throughput =
  D.Offer.get_throughput "my-database" "my-collection"
in
let%lwt updated =
  D.Offer.set_throughput "my-database" "my-collection"
    (D.Offer.Throughput.Manual 500)
in
match (throughput, updated) with
| Ok (_, current), Ok (_, offer) -> Lwt.return (current, offer)
| Error _error, _ | _, Error _error -> Lwt.fail_with "Cosmos request failed"

Offer operations require master-key authentication. Serverless accounts do not expose provisioned-throughput offers, so lookup functions return None.