docs: add collections usage#875
Open
lmeyerov wants to merge 21 commits intofeat/collections-supportfrom
Open
Conversation
lmeyerov
force-pushed
the
docs/collections-support
branch
4 times, most recently
from
8bee706 to
dff95a0
Compare
lmeyerov
force-pushed
the
docs/collections-support
branch
4 times, most recently
from
531a661 to
017e7f8
Compare
lmeyerov
force-pushed
the
feat/collections-support
branch
from
3cf9e9d to
41a33c4
Compare
lmeyerov
force-pushed
the
docs/collections-support
branch
from
099d19c to
ad9cb69
Compare
lmeyerov
force-pushed
the
docs/collections-support
branch
from
ad9cb69 to
fb58c44
Compare
mj3cheun
reviewed
Apr 7, 2026
| "import graphistry\n", | ||
| "from graphistry import collection_set, collection_intersection, n, e_forward, Chain\n", | ||
| "\n", | ||
| "edges = pd.read_csv(Path('demos/data/honeypot.csv'))\n", |
Contributor
There was a problem hiding this comment.
this file is not included in the repo, probably should be or a way to download the data should be provided?
mj3cheun
reviewed
Apr 7, 2026
Comment on lines
43
to
54
| ## Message Structure | ||
|
|
||
| All GFQL wire protocol messages are JSON objects with a `type` field that identifies the message type. The protocol uses discriminated unions for polymorphic types. | ||
|
|
||
| ### Type Identification | ||
|
|
||
| Each object includes a `type` field: | ||
| - Operations: `"Node"`, `"Edge"`, `"Chain"`, `"Let"`, `"ChainRef"`, `"RemoteGraph"`, `"Call"` | ||
| - Predicates: `"GT"`, `"LT"`, `"IsIn"`, etc. | ||
| - Temporal values: `"datetime"`, `"date"`, `"time"` | ||
|
|
||
| This enables unambiguous deserialization and validation. |
Contributor
There was a problem hiding this comment.
this is not related to added changes:
im a little confused about what messages are? the message types above Chain, Let, Call seem to suggest these are top level but then why are deeper level Node and Edge or even predicates also messages?
also why is there a Protocol Overview section and then a Message Structure section just below it?
mj3cheun
reviewed
Apr 7, 2026
Comment on lines
+20
to
+23
| .. note:: | ||
| Collections are visualization URL settings; apply them after GFQL results | ||
| (for example, ``g2.collections(...)``). The GFQL remote/upload APIs do not | ||
| accept collections payloads yet. |
Contributor
There was a problem hiding this comment.
not sure why this note was needed but i dont see an issue in having it either
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
RTD Preview
Testing