Constellation

What is Constellation?

Constellation is a wrapper library around parts of the CosmosDB SDK, mainly CRUD operations, to make use with F# more friendly and straight-forward.

Motivation

The reason why I decided to make this package came from FSharp.CosmosDb (a package by @aaronpowell), this section of the Microsoft Performance Tips for CosmosDB, a little bit of the context syntax sugar from Entity Framework, and a personal project that I am working on at the date of writing.

The library that Aaron created is great, but I needed something a little too specific for my use case. So I've decided to create something that can be a little more friendly with DI Frameworks, like ASP.NET's default one, and that does not instantiate multiple instances of the CosmosClient, as suggested in the Tips from Microsoft.

Goal

The goal is to provide F# syntax to CosmosDB SDK while also allowing to use all the options provided by the SDK.

How does it work?

It has two wrappers around CosmosDB SDK v3, since v4 is still preview. One around CosmosClient, named Constellation.CosmosContext and another one around the Container named Constellation.Container. These wrappers are just a proxy to provide you with a more F# friendly syntax to communicate with CosmosDB.

Attributes

There are only three attributes you might need to use when interacting with this library. They are on the module Constellation.Attributes

Id

This attribute marks the property as an id field and will be used to represent an id when needed. Keep in mind that the id field must be a string.

open Constellation.Attributes

type User =
  { [<Id>] Id: string }

PartitionKey

For almost all operations the PartitionKey is needed. Fields marked with this attribute can only be of type string, bool, double or float:

open Constellation.Attributes

type User =
  { [<Id>] Id: string
    [<PartitionKey>] Username: string }

Or your PartitionKey can be inside a property on your root class. The example below sets the PartitionKey to one level below (I.e.: In a reference type property of the root class) but it can be as deep as you need it to. Just keep in mind that reflection is used to navigate into these properties and get the value; if performance is a concern you might not want to use this convenience.

open Constellation.Attributes

type ContactInfo =
  { [<PartitionKey>] Email: string }

type User =
  { [<Id>] Id: string
    Username: string
    ContactInformation: ContactInfo }

If your data is partitioned by id, for example, a user is it's own partition, then you can do:

open Constellation.Attributes

type User =
  { [<Id; PartitionKey>] Id: string
    Username: string }

Container

This attributes allow you the specify the id of the container right in the model.

open Constellation.Attributes

[<Container("Users")>]
type User =
  { [<Id; PartitionKey>] Id: string
    Username: string }

Builders

This library exposes some builders for the SDK option models. For the sake of brevity, I won't be going through all the builder methods (there is plenty since the models have lots of properties as well), but be sure that you'll be able to find practically all the method you need by being following the naming convention; that is, every method name corresponds to a option model's property but with words separated by underscores (snake_case), I.e. If a model has a property SomeProperty the builder exposes the method some_property that takes an input of the same type as the property.

There are currently builder for the following SDK option models:

ChangeFeedRequestOptions with name ChangeFeedRequestOptionsBuilder; instantiate with changeFeedRequestOptions
ContainerRequestOptions with name ContainerRequestOptionsBuilder; instantiate with containerRequestOptions
CosmosClientOptions with name CosmosClientOptionsBuilder; instantiate with cosmosClientOptions
CosmosSerializationOptions with name CosmosSerializationOptionsBuilder; instantiate with cosmosSerializationOptions
ItemRequestOptions with name ItemRequestOptionsBuilder; instantiate with itemRequestOptions
PatchItemRequestOptions with PatchItemRequestOptionsBuilder; instantiate with patchItemRequestOptions
QueryRequestOptions with name QueryRequestOptionsBuilder; instantiate with queryRequestOptions
ReadManyRequestOptions with name ReadManyRequestOptionsBuilder; instantiate with readManyRequestOptions
RequestOptions with name RequestOptionsBuilder; instantiate with requestOptions
StorageProcedureRequestOptions with name StorageProcedureRequestOptionsBuilder; instantiate with storageProcedureRequestOptions
TransactionalBatchItemRequestOptions with name TransactionalBatchItemRequestOptionsBuilder; instantiate with transactionalBatchItemRequestOptions
TransactionalBatchPatchItemRequestOptions with name TransactionalBatchPatchItemRequestOptionsBuilder; instantiate with transactionalBatchPatchItemRequestOptions
TransactionalBatchRequestOptions with name TransactionalBatchRequestOptionsBuilder; instantiate with transactionalBatchRequestOptions

Example Usage

open Constellation.TypeBuilders

let itemOption =
  itemRequestOptions {
    if_match_etag "SomeTag"
    enable_content_response_on_write
  }

//Is the same as doing

let itemOption =
  ItemRequestOptions(
    IfMatchEtag = "SomeTag",
    EnableContentResponseOnWrite = true
  )

CosmosContext

The wrapper around CosmosClient, holds a reference to a CosmosClient instance.

By default, this library replaces the default SDK JSON Serializer, for something that better handles F# types; FSharp.SystemTextJson, is used with union encoding set to JsonUnionEncoding.FSharpLuLike ||| JsonUnionEncoding.NamedFields. Please, refer to that project if you have any questions about how it works.

To override this behavior, on the constructor send the optional third parameter with your custom serializer set, or send clientOptions=null and you'll use the default SDK serializer (Not really recommended with F#).

Instantiating the Context - Using the base class

open Constellation.Context


let context = new CosmosContext("connectionString", "databaseId") //Disposable

//Or

let endpointInfo = { Endpoint = "End/point"; AccountKey = "Key" }
let context = new CosmosContext(endpointInfo, "databaseId") //Disposable

(* Gets the underlying SDK client if you need to do something not yet covered by this library *)
let client = context.Client

Using the Context - Inheriting from the base class

open Constellation.Attributes

[<Container("Users")>]
type User = 
  { Name: string }

type MyContext(ConnString: string, DatabaseId: string) =
  inherit CosmosContext(ConnString, DatabaseId)
  
  member this.Users = this.GetContainer<User>()
  
//Or

type MyContext(ConnString: string, DatabaseId: string) =
  inherit CosmosContext(ConnString, DatabaseId)
  
  member this.Users = this.GetContainer<User> "Users"

From this example, we see we can achieve some kind of "DbContext". Register this class in your DI container or Composition Root and you should be good to go.

Notice that, the type CosmosContext exposes a method GetContainer<'from> where you can either send the target ContainerId or a type that uses the attribute Container(string). But note that the type is necessary since it is used on that ConstellationContainer instance to map from/to the type specified during interactions with the database.

ConstellationContainer

This is actually just a wrapper around the SDK Container class. As of now, it exposes the main CRUD operations in fluent syntax. Also, the methods exposes a version accepting a SDK option model, that has the suffix WithOption, for example, the method getItem has a version getItemWithOptions. The methods that accepts the models options also accepts a CancellationToken. So basically, their signatures are: OptionModel -> CancellationToken -> arg1 -> argN -> ConstellationContainer<'a> -> PendingOperation<'a>.

What is `PendingOperation<'a>`?

As the name might suggest it is an operation yet to be executed, it represent a function that returns an AsyncSeq<CosmosResponse<'a>> where CosmosReponse<'a> is an union type that maps on the SDK to either a default Response<T> or FeedResponse<T> in the case of queries or operations that supports continuation, for example, the insert operation returns the type ItemResponse<'a>; you can see it in more detail in the SDK documentation.

This module Constellation.Container exposes two methods for dealing with PendingOperation<'a>.

Container.execAsync with signature PendingOperation<'a> -> AsyncSeq<'a>
Container.execAsyncWrapped with signature PendingOperation<'a> -> AsyncSeq<CosmosResponse<'a>>

As said before, every operation returns AsyncSeq<'WrapperType>, if you want to you can iter through each item as it is used with AsyncSeq.iter, or do AsyncSeq.toListSynchronously to get list of the objects used in the operation. See below usage examples.

KeyParam

Some methods exposed by this library contain a parameter of type KeyParam, it is an union case of:

SameIdPartition: that is a convenience for when you container is partitioned by the documents id.
IdAndKey: That represents an id that is different from the partition key.

IdAndKey Take a string * PartitionKeys where PartitionKeys is an union type of:

StringKey of string: A partition key of string type.
BooleanKey of bool: A partition key of a boolean value.
NumericKey of double: A partition key of numeric value.
NoKey: Maps to PartitionKey.None and represents a key that allows for operations providing no partition key.
Null: Maps to PartitionKey.Null and represents a key that allows for operations providing a null partition key.

Get

Returns a single result. Even though its return type is an AsyncSeq, this sequence will only contain either one item or nothing in it.

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let getResults = //AsyncSeq<User>
  container
  |> Container.getItem (SameIdPartition "itemId")
  |> Container.execAsync
  
// or specifying a different response resource type.  

let getResults = //AsyncSeq<AdminUser>
  container
  |> Container.getItemAs<_, AdminUser> (SameIdPartition "itemId")
  |> Container.execAsync

// or wrapped
  
let getResults = //AsyncSeq<CosmosResponse<User>>
  container 
  |> Container.getItem (SameIdPartition "itemId")
  |> Container.execAsyncWrapped

Query

Returns a collection of results of the container type that may contain none, one or more items.

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let queryResult = //AsyncSeq<User>
  container
  |> Container.query "SELECT u.Id, u.UserName FROM User u WHERE u.Id LIKE @someId"
  |> Container.withParameters [ ("@someId", "userId") ]
  |> Container.execAsync
  
//Or parameterless

let queryResult = //AsyncSeq<User>
  container
  |> Container.parameterlessQuery "SELECT u.Id, u.UserName FROM User u"
  |> Container.execAsync
  
// Or wrapped
  
let queryResult = //AsyncSeq<CosmosResponse<User>>
  container
  |> Container.query "SELECT u.Id, u.UserName FROM User u WHERE u.Id LIKE @someId"
  |> Container.withParameters [ ("@someId", box <| "userId") ]
  |> Container.execQueryWrapped

Insert

Inserts the given collection in the database.

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let user = { Id = "SomeId"; Username = "User_Name" }

let insertResult = //AsyncSeq<User>
  container
  |> Container.insertItem [ user ]
  |> Container.execAsync
  
// Or wrapped
  
let insertResult = //AsyncSeq<ItemResponse<User>>
  container
  |> Container.insertItem [ user ]
  |> Container.execAsyncWrapped

Update (Patch)

Updates (patches) the documents with the specified keys by applying the provided operations to them.

Supported operations are described here. Description is also provided on code documentation.

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let update = {| Permission = "Write" |}

container
|> Container.updateItems
  [ Add <@@ update.Permission @@> ]
  [ SameIdPartition "userId" ]
|> Container.execAsync

Replace

Replaces an item with the same Id and PartitionKey from the Database

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let replaceForThis = { Id = "SomeId"; Username = "UpdatedUserName" }

let updateResult = //AsyncSeq<User>
  container
  |> Container.changeItem replaceForThis
  |> Container.execAsync
  
//Or

let updateResult = //AsyncSeq<ItemResponse<User>>
  container
  |> Container.changeItem replaceForThis
  |> Container.execAsyncWrapped

Delete

Removes an item from the database. Note that, if you want to get the resource from the wrapped response, you can't; it is not returned by the database since it has been deleted.

//Gets the container from a model with the attribute Container
let container = ctx |> Context.getContainer<User>

let deleteThis = { Id = "SomeId"; Username = "UpdatedUserName" }

let deleteResult = //AsyncSeq<User>
  container
  |> Container.deleteItem [ deleteThis ] 
  |> Container.execAsync
  
//Or

let deleteResult = //AsyncSeq<ItemResponse<User>>
  container
  |> Container.deleteItem [ deleteThis ]
  |> Container.execAsyncWrapped

Note:

When available, all methods above also provide a version with suffix Of and type parameters <'a, 'b> whose usage is similar to how it was showcases in the Get section above. Usually, you'll want to keep the first parameter the inferred default in the first argument but specifying the expected resource type with an actual type, i.e <_, AdminUser>.

Be mindful that 'b is the types used for deserialization, so if a field is expected but is missing from the response, depending on how you configured your serializer to handle those cases, an exception might be thrown.

Request Logging

If need to log the requests as they go you can add a request handler, like below:

let loggingHandler =
  { new RequestHandler() with
    member this.SendAsync(request: RequestMessage, token: CancellationToken) =
      let content =
        match request.Content |> Option.ofObj with
        | None -> Array.zeroCreate 0
        | Some c -> c.AsyncRead (int request.Content.Length) |> Async.RunSynchronously
        
      printfn $"Sending {request.Method.Method}: %A{System.Text.Encoding.UTF8.GetString(content)}"
      this.InnerHandler.SendAsync(request, token)}

let cosmosOptions = cosmosClientOptions {
  serializer defaultCosmosSerializer
  custom_handler loggingHandler
}

type PlanetContext(connString: string, databaseId: string, options: CosmosClientOptions Option) =
  inherit CosmosContext(connString, databaseId, Option.toObj options)

In this example we log every single request content body, if any.

Planned Future Features

Give support to Transactional Batches
Give support to Batch operations (Insert, Change, Delete, etc...)
Update to CosmosDb SDK v4 when it's released

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Constellation

What is Constellation?

Motivation

Goal

How does it work?

Attributes

Id

PartitionKey

Container

Builders

Example Usage

CosmosContext

Instantiating the Context - Using the base class

Using the Context - Inheriting from the base class

ConstellationContainer

What is `PendingOperation<'a>`?

KeyParam

Get

Query

Insert

Update (Patch)

Replace

Delete

Note:

Request Logging

Planned Future Features

Files

README.md

Latest commit

History

README.md

File metadata and controls

Constellation

What is Constellation?

Motivation

Goal

How does it work?

Attributes

Id

PartitionKey

Container

Builders

Example Usage

CosmosContext

Instantiating the Context - Using the base class

Using the Context - Inheriting from the base class

ConstellationContainer

What is PendingOperation<'a>?

KeyParam

Get

Query

Insert

Update (Patch)

Replace

Delete

Note:

Request Logging

Planned Future Features

What is `PendingOperation<'a>`?