https://github.com/jonassyrstad/stardust.paradox
Entity framework'ish tool for developing .net applications using gremlin graph query language with CosmosDb
https://github.com/jonassyrstad/stardust.paradox
cosmosdb dotnet-standard entityframework graph gremlin
Last synced: 3 months ago
JSON representation
Entity framework'ish tool for developing .net applications using gremlin graph query language with CosmosDb
- Host: GitHub
- URL: https://github.com/jonassyrstad/stardust.paradox
- Owner: JonasSyrstad
- License: apache-2.0
- Created: 2018-06-22T19:03:35.000Z (almost 8 years ago)
- Default Branch: Main
- Last Pushed: 2026-03-06T08:13:47.000Z (3 months ago)
- Last Synced: 2026-03-06T11:14:24.275Z (3 months ago)
- Topics: cosmosdb, dotnet-standard, entityframework, graph, gremlin
- Language: C#
- Size: 87.6 MB
- Stars: 8
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Stardust.Paradox
Entity framework'ish tool for developing .net applications using gremlin graph query language with CosmosDb
[](https://sonarcloud.io/dashboard?id=JonasSyrstad_Stardust.Paradox)
[](https://sonarcloud.io/dashboard?id=JonasSyrstad_Stardust.Paradox)
[](https://sonarcloud.io/dashboard?id=JonasSyrstad_Stardust.Paradox)
[](https://sonarcloud.io/dashboard?id=JonasSyrstad_Stardust.Paradox)
[](https://sonarcloud.io/dashboard?id=JonasSyrstad_Stardust.Paradox)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FJonasSyrstad%2FStardust.Paradox?ref=badge_shield)
---
## Stardust Gremlin Studio
**A Modern Query Tool for Gremlin Graph Databases**
| Download | Links |
|----------|-------|
| **Windows Installer** | [Download](https://github.com/JonasSyrstad/Stardust.Paradox/releases/latest) |
| **Source Code** | [View](src/StardustGremlinStudio) |
| **Docs** | [Read More](src/StardustGremlinStudio/README.md) |
**Features:** Connect to Azure Cosmos DB and TinkerPop | Syntax highlighting | Graph visualization | Built-in playground | Scenario export
---
# Usage (asp.net core)
## Startup.cs
### ConfigureServices
Add the generated entity implementations to the IOC container (I will provide an extention method to make this easier)
```cs
services.AddEntityBinding((entityType, entityImplementation) => services.AddTransient(entityType, entityImplementation))
.AddScoped()
.AddScoped(s => new CosmosDbLanguageConnector(DbAccountName, AccessKey, "databaseName","collectionName"));
```
## Defining the model
```cs
[VertexLabel("person")]
public interface IPerson : IVertex
{
string Id {get;}
string FirstName { get; set; }
string LastName { get; set; }
string Email { get; set; }
EpochDateTime Birthday {get;set;}//Wrapper type for DateTime that serializes into unix epoch. Can be used in predicate steps directly.
IEdgeCollection Parents { get; }
IEdgeCollection Children { get; }
IEdgeCollection Siblings { get; }
[InLabel("city")] //pointing to the Residents property in ICity
IEdgeReference HomeCity { get; }//use IEdgeReference to enable task-async operations
IEdgeCollection Employers { get; }
}
[VertexLabel("city")]
public interface ICity : IVertex
{
string Id { get; }
string Name { get; set; }
string ZipCode { get; set; }
[OutLabel("city")] //pointing to the HomCity property in IPerson
IEdgeCollection Residents { get; } //use IEdgeCollection to enable task-async operations on the collection
IEdgeReference Country { get; }
}
[VertexLabel("company")]
public interface ICompany : IVertex
{
string Id { get; }
string Name { get; set; }
IEdgeCollection Employees { get; }
}
[VertexLabel("country")]
public interface ICountry : IVertex
{
string Id { get; }
string Name { get; set; }
string CountryCode { get; set; }
string PhoneNoPrefix { get; set; }
IEdgeCollection Cities { get; }
}
[EdgeLabel("employer")]
public interface IEmployment : IEdge
{
string Id { get; }
EpochDateTime HiredDate { get; set; }
string Manager { get; set; }
}
```
## Defining the entity context and generating the entity implementations
```cs
public class MyEntityContext : Stardust.Paradox.Data.GraphContextBase
{
static MyEntityContext()
{
PartitionKeyName = "pk";//used with partitioned cosmosDb to make sure that ToVerticesAsync uses partitionKey when executing
}
public IGraphSet Persons => GraphSet();
public IGraphSet Cities => GraphSet();
public IGraphSet Countries => GraphSet();
public IGraphSet Companies => GraphSet();
public IGraphSet Employments => EdgeGraphSet();
public MyEntityContext(IGremlinLanguageConnector connector, IServiceProvider resolver) : base(connector, resolver)
{
}
protected override bool InitializeModel(IGraphConfiguration configuration)
{
//Added some fluent configuration of the edges
configuration.ConfigureCollection()
.In(t => t.Parents, "parent").Out(t => t.Children)
.ConfigureCollection()
.ConfigureCollection()
.AddEdge(t=>t.Cities).Reverse(t=>t.Country)
.ConfigureCollection()
.Out(t=>t.Employees, "employer").In(t=>t.Employers)
.ConfigureCollection();;
return true;
}
}
```
## Using the datacontext
```CS
public class DemoController:Controller
{
private MyEntityContext _dataContext;
public DemoController(MyEntityContext dataContext)
{
_dataContext=dataContext;
}
public Task GetDataAsync(string personId)
{
var person=await _dataContext.Persons.GetAsync(persionId);
return new User
{
Id=person.Id,
FirstName=person.FistName,
LastName=person.LastName,
Email=person.Email
}
}
public Task AddEmploymentAsync(string userId, string companyId,DateTime hiredDate, string managerName) //new in V2
{
var user=await await _dataContext.Persons.GetAsync(persionId);
var company=await _dataContext.Companies.GetAsync(companyId);
var e= _dataContext.Employments.Create(user,company);
e.HiredDate=hiredDate.ToEpoch();
e.ManagerName=managerName;
await _dataContext.SaveChangesAsync();
//alternative
}
public Task AddEmploymentAlternativeAsync(string userId, string companyId,DateTime hiredDate, string managerName) //edge property handling in V1
{
var user=await await _dataContext.Persons.GetAsync(persionId);
var company=await _dataContext.Companies.GetAsync(companyId);
user.Employers.Add(company,new Dictionary{
{"hiredDate",hiredDate.ToEpoch()},
{"managerName","managerName"}
})
await _dataContext.SaveChangesAsync();
//alternative
}
}
```
## Dynamic graph entities
In many cases we cannot model our graph as strong typed entities. Paradox supports hybrid entities by adding IDynamicGraphEntity to your edge or vertex definition you can model the well known peroperties on your entities, but at the same time assign and manipulate arbitary properties. These properties enjoy the same treatment as the typed properties with regards to parameterization and change tracking.
```CS
[VertexLabel("person")]
public interface IProfile : IVertex, IDynamicGraphEntity
{
string Id { get; }
string FirstName { get; set; }
string LastName { get; set; }
string Email { get; set; }
bool VerifiedEmail { get; set; }
string Name { get; set; }
string Ocupation { get; set; }
DateTime LastUpdated { get; set; }
//[EdgeLabel("parent")]
IEdgeCollection Parents { get; }
//[ReverseEdgeLabel("parent")]
IEdgeCollection Children { get; }
[ToWayEdgeLabel("spouce")]
IEdgeReference Spouce { get; }
[Eager]
[EdgeLabel("employer")]
ICollection Employers { get; }
[GremlinQuery("g.V('{id}').as('s').in('parent').out('parent').where(without('s')).dedup()")]
IEdgeCollection Siblings { get; }
[InlineSerialization(SerializationType.ClearText)]
ICollection ProgramingLanguages { get; }
IEdgeCollection AllSiblings { get; set; }
bool Adult { get; set; }
string Description { get; set; }
int Number { get; set; }
string Pk { get; set; }
EpochDateTime LastUpdatedEpoch { get; set; }
}
```
### usage
```CS
var profile = await tc.VAsync("myId");
profile.SetProperty("someRandomProp",$"test+:{DateTime.UtcNow.Ticks}");
Console.WriteLine(profile.GetProperty("someRandomProp"));
Console.WriteLine(string.Join(",",profile.DynamicPropertyNames))
```
## Complex properties
Version 2.3.3 introduces the cocept of complex properties. Gremlin in it self does not support this. Complex properties are serialized to json and needs to be implemented using the IComplexProperty abstract class. For the framework to pick up on changes to the object all properties needs to raise a notification about the change (resharper will help with the implementation of these)
```CS
public class MyProp:IComplexProperty
{
private DateTime _timeStamp;
public DateTime TimeStamp
{
get => _timeStamp;
set
{
if (value.Equals(_timeStamp)) return;
_timeStamp = value;
OnPropertyChanged();
}
}
}
```
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2FJonasSyrstad%2FStardust.Paradox?ref=badge_large)