korczis/README.md

Last active October 27, 2024 00:14

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/korczis/74eec936e3a10fed7991ed9c62b63677.js"></script>
Save korczis/74eec936e3a10fed7991ed9c62b63677 to your computer and use it in GitHub Desktop.

Download ZIP

NetworkGraph - KuzuDB DSL Real World Example

Raw

README.md

Kuzu.App.NetworkGraph

The Kuzu.App.NetworkGraph module defines a network schema using Kuzu.Graph.Schema. This schema models social and professional relationships between individuals, companies, posts, and comments, allowing for robust querying and data modeling for network-based applications.

Overview

The module is designed to represent social and professional connections in a network graph. Key entities include Person, Company, Post, and Comment, each with specific attributes. Relationships define how these entities interact within the network, including social relationships (friendships, follows), professional relationships (employment, management), and content interactions (authorship, likes, comments).

Example Use Cases

Social Networks: Represent friendships, followers, and authored posts.
Professional Networks: Model employment, roles within a company, and reporting lines.
Content Sharing: Track authored posts, likes, and comments.

Installation

To use Kuzu.App.SocialNetwork, you must first have the Kuzu.Graph library installed:

def deps do
  [
    {:kuzu_ex, ">= 0.0.0"} # Add the correct version here
  ]
end

Raw

social-network.md

Graph Structure

1. Person Node

Represents individuals in the network, with both social and professional attributes:

Attribute	Type	Options	Description
`id`	`:uuid`	`[primary_key: true]`	Unique identifier for each person.
`name`	`:string`	`[null: false]`	Name of the person.
`email`	`:string`	`[null: false]`	Email address, unique per person.
`age`	`:integer`	`[]`	Age of the person.
`job_title`	`:string`	`[]`	Job title, relevant in professional context.
`joined_at`	`:datetime`	`[null: false]`	Date the person joined the network.
`bio`	`:string`	`[]`	Short biography of the person.

2. Company Node

Models companies or organizations within the network, focusing on professional relationships.

Attribute	Type	Options	Description
`id`	`:uuid`	`[primary_key: true]`	Unique identifier for each company.
`name`	`:string`	`[null: false]`	Name of the company.
`industry`	`:string`	`[]`	Industry sector of the company.
`founded_year`	`:integer`	`[]`	Year the company was founded.
`location`	`:string`	`[]`	Physical location of the company.
`website`	`:string`	`[]`	Official website URL for the company.

3. Post Node

Represents posts or content shared by users, typically for social or professional engagement.

Attribute	Type	Options	Description
`id`	`:uuid`	`[primary_key: true]`	Unique identifier for each post.
`content`	`:string`	`[null: false]`	Main content of the post.
`created_at`	`:datetime`	`[null: false]`	Timestamp when the post was created.
`type`	`:string`	`[]`	Type of post, e.g., "personal" or "professional".
`visibility`	`:string`	`[null: false, default: "public"]`	Post visibility (e.g., "public", "private").

4. Comment Node

Represents comments associated with posts.

Attribute	Type	Options	Description
`id`	`:uuid`	`[primary_key: true]`	Unique identifier for each comment.
`content`	`:string`	`[null: false]`	Content of the comment.
`created_at`	`:datetime`	`[null: false]`	Date and time the comment was made.

Relationships

Social Relationships

FRIEND
- Between: Person - Person
- Type: many_to_many
- Properties:
  - connected_at (:datetime, [null: false]) - Date when the friendship was established.
FOLLOWS
- Between: Person - Person
- Type: many_to_many
- Properties:
  - followed_at (:datetime, [null: false]) - Date when one person started following the other.

Professional Relationships

WORKS_AT
- Between: Person - Company
- Type: many_to_one
- Properties:
  - started_at (:datetime, [null: false]) - Date the person began working at the company.
  - role (:string, [null: false]) - Role or position within the company.
  - department (:string, []) - Department within the company.
MANAGES
- Between: Person - Person
- Type: many_to_one
- Properties:
  - started_at (:datetime, [null: false]) - Date when the management relationship began.

Content Relationships

AUTHORED
- Between: Person - Post
- Type: one_to_many
- Properties:
  - created_at (:datetime, [null: false]) - Date when the person authored the post.
LIKES
- Between: Person - Post
- Type: many_to_many
- Properties:
  - liked_at (:datetime, [null: false]) - Date when the post was liked.
WROTE
- Between: Person - Comment
- Type: one_to_many
ON
- Between: Comment - Post
- Type: many_to_one

Company Relationships

SUBSIDIARY_OF
- Between: Company - Company
- Type: many_to_one
- Properties:
  - acquired_date (:datetime, []) - Date when the subsidiary relationship was established.

Additional Notes

Primary Keys: Each node has a unique primary key (id), allowing efficient lookups and unique identity for every node.
Nullability and Defaults: Some attributes are required ([null: false]) to ensure data integrity. The visibility field in Post has a default value of "public", enabling predictable access without explicitly setting it.
Cardinality: Cardinality defines the relationship type (e.g., many_to_one for WORKS_AT, where many Person entities can work at one Company).

This structure supports complex queries across social, professional, and content-based relationships and enables real-time data interactions for use cases like social network analysis, employee management, or content curation.