package azure-cosmos-db-eio

  1. Overview
  2. Docs

Module Database_as.OfferSource

Sourcemodule Throughput : sig ... end

list () returns all throughput offers in the account. Requires master-key authentication.

get offer_rid returns the offer identified by offer_rid. Requires master-key authentication.

Sourceval replace : ?migrate:[ `To_autoscale | `To_manual ] -> ?timeout:float -> Cosmos.Json_converter_t.offer -> Throughput.t -> (int * Cosmos.Json_converter_t.offer, Database_intf.cosmos_error) result Database_intf.io
Sourceval get_for_collection : ?timeout:float -> string -> string -> (int * Cosmos.Json_converter_t.offer option, Database_intf.cosmos_error) result Database_intf.io
Sourceval get_for_database : ?timeout:float -> string -> (int * Cosmos.Json_converter_t.offer option, Database_intf.cosmos_error) result Database_intf.io
Sourceval get_throughput : ?timeout:float -> string -> string -> (int * Throughput.t option, Database_intf.cosmos_error) result Database_intf.io

get_throughput dbname coll_name returns the collection's provisioned throughput, or None for serverless accounts. Requires master-key authentication.

Sourceval set_throughput : ?migrate:[ `To_autoscale | `To_manual ] -> ?timeout:float -> string -> string -> Throughput.t -> (int * Cosmos.Json_converter_t.offer, Database_intf.cosmos_error) result Database_intf.io

set_throughput dbname coll_name throughput changes the collection's provisioned throughput. Requires master-key authentication and is unavailable for serverless accounts.