Skip to content
This repository was archived by the owner on Aug 29, 2020. It is now read-only.

Aliasing and subgraphs #110

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Aliasing and subgraphs #110

wants to merge 8 commits into from

Conversation

jayrbolton
Copy link
Contributor

@jayrbolton jayrbolton commented Oct 3, 2019

  • Add an aliases.yaml file that maps an alias name to collection names. This could be used by the RE API to abstract the collection names. We'll have to figure out how exactly we can use this in queries
  • Add "subgraph" configuration files. This adds another set of names that group collections together into a set of vertices and edges connecting those vertices. Examples are GO, ENVO, ncbi_taxonomy, and GTDB

Expansion (not in this PR)

  • I would like to also add a concept for types on top of subgraphs, which I'd call something like "blueprints". These would define a set of blueprint JSON schemas, collection aliases, and edge connections that a subgraph can conform to. This would allow queries, UI, and apps to work across multiple subgraphs.
  • For example, you might have a blueprint called "taxonomy". Both ncbi_taxonomy and gtdb would conform to this blueprint. It would define some common document properties in schemas for the "taxon" and "child_of" edges, as well as the required edge connections for the subgraph.

@jayrbolton jayrbolton requested a review from MrCreosote October 3, 2019 23:43
Copy link
Collaborator

@MrCreosote MrCreosote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems reasonable without spending an hour or two thinking about it, but I suspect as you start using these files in code things may need to evolve

@@ -0,0 +1,62 @@
# Aliases from custom name to an array of collection names
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why an array?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I imagine it could be useful an alias to expand out into multiple collections in a query

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants