8000 Feature Hybrid SmartGraphs by hkernbach · Pull Request #742 · arangodb/docs · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Feature Hybrid SmartGraphs #742

Merged
merged 25 commits into from
Oct 12, 2021
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
73efc64
added general docu about hybrid smart graphs
hkernbach Aug 3, 2021
5b3ffd8
added options to _extendEdgeDefinitions
hkernbach Aug 3, 2021
b90e97f
added options to _editEdgeDefinitions
hkernbach Aug 3, 2021
f59db21
added release notes api changes 39
hkernbach Aug 4, 2021
41b293a
docu for new vertex, new/modify edge
hkernbach Aug 4, 2021
8e052b7
readded already existing doumentation
hkernbach Aug 4, 2021
fee86c2
restructure
hkernbach Aug 4, 2021
6066b49
add vertex collection api
hkernbach Aug 4, 2021
61f7878
Merge branch 'main' of github.com:arangodb/docs into feature/hybrid-s…
hkernbach Aug 4, 2021
0ff4c4f
adding examples
hkernbach Aug 4, 2021
0cd6969
cleanup duplicate
hkernbach Aug 4, 2021
1edf615
Update 3.9/graphs-smart-graphs.md
hkernbach Aug 9, 2021
eacb5d2
added documentation for Hybrid (Disjoint) SmartGraphs to release node…
hkernbach Aug 10, 2021
678001f
Merge branch 'feature/hybrid-smart-graphs' of github.com:arangodb/doc…
hkernbach Aug 10, 2021
ebc0740
added description for edge definition object properties
hkernbach Aug 10, 2021
4d5e061
added note about use case of hybrid smart graph
hkernbach Aug 10, 2021
e6b33ff
Revert "adding examples"
Simran-B Sep 28, 2021
c9bf712
Partial review, some links broken on purpose
Simran-B Sep 28, 2021
9d99229
Fixed Links
santanu82021 Sep 28, 2021
fbc7e30
Merge branch 'main' of https://github.com/arangodb/docs into feature/…
santanu82021 Sep 28, 2021
29f0c0d
Merge remote-tracking branch 'origin/main' into feature/hybrid-smart-…
mchacki Oct 7, 2021
c3c102c
Removed illegally added Merge Conflict marker
mchacki Oct 7, 2021
114b7cb
Review, add JS API examples
Simran-B Oct 11, 2021
cc1c7f3
Fix examples, add generated files for preview
Simran-B Oct 11, 2021
44e9c7d
Add satellites option to SmartGraph management
Simran-B Oct 12, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
restructure
  • Loading branch information
hkernbach committed Aug 4, 2021
commit fee86c29eec40ec4a25959724e0d7013074ed17d
49 changes: 49 additions & 0 deletions 3.9/release-notes-api-changes39.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,53 @@ This document summarizes the HTTP API changes and other API changes in ArangoDB
The target audience for this document are developers who maintain drivers and
integrations for ArangoDB 3.9.

## HTTP RESTful API

### GRAPH API (Gharial)

The following changes affect the behavior of the RESTful graph APIs at
endpoints starting with path `/_api/gharial/`:

The options object now supports a new field: `satellites`, when creating a graph (POST).
The value of satellites is optional. In case it is defined, it needs to be an array
of collection names. Each defined collection name must be a string. This value is
only valid in case of SmartGraphs (Enterprise-Only). In a community based graph it
will be ignored.

Using `satellites` during SmartGraph creation will result in a Hybrid Smart Graph.
Using `satellites` during Disjoint SmartGraph creation will result in a Hybrid
Disjoint SmartGraph.

Hybrid (Disjoint) SmartGraphs are capable of having Satellite collections in their
graph definitions. If a collection is found in `satellites` and they are also being
used in the graph definition itself (e.g. EdgeDefinition), this collection will be
created as a satellite collection. Hybrid (Disjoint) Smart Graphs are then capable
of executing all type of graph queries between the regular SmartCollections and
Satellite collections.

The following changes affect the behavior of the RESTful graph APIs at
endpoints starting with path `/_api/gharial/{graph}/edge`:

Creating and modifying a new edge definition (POST / PUT):
Added new optional options object. This was not available in previous ArangoDB 83A7
versions. The options object currently can contain a field called `satellites`.
The field must be an array and contain collection name(s) written down as strings.
If an EdgeDefinition does contain a collection name, which is also defined in
the satellites option entry, it will be created as a Satellite collection.
Otherwise, it will be ignored. This option only takes effect using SmartGraphs.

The following changes affect the behavior of the RESTful graph APIs at
endpoints starting with path `/_api/gharial/{graph}/vertex`:

Creating a new vertex collection (POST):
Added new optional options object. This was not available in previous ArangoDB
versions. The options object currently can contain a field called `satellites`.
The field must be an array and contain collection name(s) written down as strings.
If the vertex to add is also defined in the satellites option entry, it will be
created as a Satellite collection. Otherwise, it will be ignored. This option
only takes effect using SmartGraphs.


### Privilege changes

### Endpoint return value changes
Expand Down Expand Up @@ -107,3 +154,5 @@ The field must be an array and contain collection name(s) written down as string
If the vertex to add is also defined in the satellites option entry, it will be
created as a Satellite collection. Otherwise, it will be ignored. This option
only takes effect using SmartGraphs.

## JavaScript API
0