kuromukira / universe

A simpler way of querying a CosmosDb Namespace

Universe

A simpler way of querying a CosmosDb Namespace

How-to:

1. Your models / cosmos entities should inherit from the interface

public class MyCosmosEntity : ICosmicEntity
{
  public string FirstName { get; set; }
  
  public string LastName { get; set; }
  
  // The properties below are implementations from ICosmicEntity
  public string id { get; set; }
  public DateTime AddedOn { get; set; }
  public DateTime ModifiedOn { get; set; }

  [JsonIgnore]
  public string PartitionKey => FirstName;
}

2. Create a repository like so:

public class MyRepository : Galaxy<MyModel>
{
    public MyRepository(CosmosClient client, string database, string container, string partitionKey) : base(client, database, container, partitionKey)
    {
    }
}

// If you want to see debug information such as the full Query text executed, use the format below:
public class MyRepository : Galaxy<MyModel>
{
    public MyRepository(CosmosClient client, string database, string container, string partitionKey) : base(client, database, container, partitionKey, true)
    {
    }
}

3. In your Startup.cs / Main method / Program.cs, configure the CosmosClient like so:

_ = services.AddScoped(_ => new CosmosClient(
    System.Environment.GetEnvironmentVariable("CosmosDbUri"),
    System.Environment.GetEnvironmentVariable("CosmosDbPrimaryKey"),
    clientOptions: new()
    {
        Serializer = new UniverseSerializer() // This is from Universe.Options
        AllowBulkExecution = true // This will tell the underlying code to allow async bulk operations
    }
));

4. In your Startup.cs / Main method / Program.cs, configure your CosmosDb repository like so:

_ = services.AddScoped<IGalaxy<MyModel>, MyRepository>(service => new(
    client: service.GetRequiredService<CosmosClient>(),
    database: "database-name",
    container: "container-name",
    partitionKey: "/partitionKey"
));

5. Inject your IGalaxy<MyModel> dependency into your classes and enjoy a simpler way to query CosmosDb

Example Query:

MyModel myModel = await IGalaxy<MyModel>.Get(new Catalyst("LastName", "last name value"));

universe's Issues

README file is not updated

Contents of the README file showing an example usage needs to be updated to use the implementation from v2.0.0

Auto deploy to NuGet.org via GitHub Actions

See https://dzone.com/articles/build-publish-and-deploy-nuget-package-using-githu

Broken links in NuGet page

Project Website and Repository URL points to a non-existing page in GitHub

Column Options does not support SELECT * queries

The new column options introduced during 1.3.0 does not support SELECT *. This can be seen in here

Fix this issue and allow support for SELECT *

Add support for bulk operations

Add support to allow bulk operations for:

• Creating documents
• Modifying documents

Add option to query "top" rows

Add support for scenarios to perform the below query:

SELECT TOP 10 * FROM c

Add debugging capabilities by exposing a list of recently executed queries

Store the recently executed queries per instance of the IGalaxy<T> interface.

It should look like this:
IGalaxy<T>.RecentQueries

This is a RecentQuery array containing the query string and parameters used for the query.
There should also be a property during initialization to set if the instance of the interface will store recent queries in-memory.

Add comments on why this part here is needed

universe/code/DarkMatter/Program.cs

Line 88 in 7144100

Potential comment
You still have to create classes for your repositories. But they should inherit from Galaxy<T>. This gives you an option to use the built-in functionality if Universe Query as well as being able to add your own flavor to your repositories (eg, your project specific code)