From 77436c22028162dc7c0f35f41891c0fd39672fa4 Mon Sep 17 00:00:00 2001 From: cn337131 <141730190+cn337131@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:27:42 +0000 Subject: [PATCH 1/2] small changes noticed recently --- docs/administration-guide/named-views.md | 18 +++++++++--------- docs/reference/glossary.md | 4 ++-- docs/reference/gremlin-guide/gaffer-options.md | 8 ++++---- docs/user-guide/query/gremlin/gremlin.md | 1 + 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/administration-guide/named-views.md b/docs/administration-guide/named-views.md index 0e414dca82..8b5bec9336 100644 --- a/docs/administration-guide/named-views.md +++ b/docs/administration-guide/named-views.md @@ -2,7 +2,7 @@ This guide walks through configuring Gaffer to use Named Views and how to run them. -Named Views allow users to store a [View](../user-guide/query/gaffer-syntax/filtering.md) +Named Views allow users to store a [View](../user-guide/query/gaffer-syntax/filtering.md) in the cache, this can then be called on in OperationChains or in NamedOperations. The benefit of using Named Views is that it allows you to store lengthy or complex Views @@ -18,7 +18,7 @@ For details on potential caches and how to configure them, see the [Stores Guide Named Views are enabled by default. To disable this feature the [store property](../administration-guide/gaffer-stores/store-guide.md#all-general-store-properties) `gaffer.store.namedview.enabled` should be set to false. -There are [three operations](../reference/operations-guide/named.md#addnamedview) which manage Named Views. +There are [three operations](../reference/operations-guide/named.md#addnamedview) which manage Named Views. These are `AddNamedView`, `GetAllNamedViews` and `DeleteNamedView`. The examples below use the following graph: @@ -70,7 +70,7 @@ graph LR ``` json { - "class" : "AddNamedVieww", + "class" : "AddNamedView", "name" : "exampleNamedView", "description" : "Example Named View", "view": { @@ -100,7 +100,7 @@ graph LR === "Python" ``` python - g.AddNamedView( + g.AddNamedView( view = g.View( edges = [ g.ElementDefinition( @@ -117,7 +117,7 @@ graph LR ) ] ), - overwrite_flag=True + overwrite_flag=True ) ``` @@ -139,7 +139,7 @@ graph LR === "JSON" - ```json + ```json { "class": "GetElements", "input": [ @@ -149,7 +149,7 @@ graph LR } ], "view": { - "class": "NamedView", + "class": "NamedView", "name": "exampleNamedView" } } @@ -171,8 +171,8 @@ graph LR ``` !!! example "Delete a NamedView" - This removes the NamedView from the cache. Note that if you delete a Named View - any Operation Chains or Named Operations which reference it will fail. + This removes the NamedView from the cache. Note that if you delete a Named View + any Operation Chains or Named Operations which reference it will fail. === "Java" diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index cdd8e85e3e..f0a8a0783f 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -8,8 +8,8 @@ hide: | Term | Description | | :---------------- | :----------------------------------- | | Entity | An entity represents a point in a graph | -| Edge | An edge is a connection between two entities | -| Vertex | In Gaffer, a vertex is the id of an entity | +| Edge | An edge is a connection between two vertices | +| Vertex | In Gaffer, a vertex is the id of an entity. Note that a vertex can exist on an edge without an associated entity. Any querying will only show these vertices on their associated edges | | Node | A node is what Gaffer calls an entity | | Properties | A property is a key/value pair that stores data on both edges and entities | | Element | The word is used to describe edges or entities | diff --git a/docs/reference/gremlin-guide/gaffer-options.md b/docs/reference/gremlin-guide/gaffer-options.md index 5d965f13f4..335201cdcc 100644 --- a/docs/reference/gremlin-guide/gaffer-options.md +++ b/docs/reference/gremlin-guide/gaffer-options.md @@ -33,11 +33,11 @@ Note that any options should be passed as a list or dictionary. g.with_("operationOptions", {"gaffer.federatedstore.operation.graphIds": "graphA"}).V().to_list() ``` -## GetAllElements Limit +## GetElements Limit -Key `getAllElementsLimit` +Key `getElementsLimit` -Limits the amount of elements returned if performing an unseeded query e.g. a +Limits the amount of elements returned if performing a query which returns a large amount of elements e.g. a `GetAllElements` operation. This will override the default for the current query, see the [admin guide](../../administration-guide/gaffer-deployment/gremlin.md#configuring-the-gafferpop-library) for more detail on setting up defaults. @@ -45,7 +45,7 @@ for more detail on setting up defaults. !!! example ```groovy - g.with("getAllElementsLimit", 100).V().toList() + g.with("getElementsLimit", 100).V().toList() ``` ## Has Step Filter Stage diff --git a/docs/user-guide/query/gremlin/gremlin.md b/docs/user-guide/query/gremlin/gremlin.md index bd1da189ff..000a7a2595 100644 --- a/docs/user-guide/query/gremlin/gremlin.md +++ b/docs/user-guide/query/gremlin/gremlin.md @@ -208,3 +208,4 @@ a table of how different parts are mapped is as follows: | Vertex | Vertex with default label of `id` | | Entity | Vertex | | Edge | Edge | +| Orphan Vertex | Vertex that exists only on an edge, has no associated entity | From b9921f0f27a6e5fb1cce1ee249c9de3e8e72fb07 Mon Sep 17 00:00:00 2001 From: cn337131 <141730190+cn337131@users.noreply.github.com> Date: Mon, 14 Oct 2024 14:46:45 +0000 Subject: [PATCH 2/2] add missing link --- docs/reference/properties-guide/type.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/properties-guide/type.md b/docs/reference/properties-guide/type.md index 154ee29e34..8cf9301fa3 100644 --- a/docs/reference/properties-guide/type.md +++ b/docs/reference/properties-guide/type.md @@ -1,6 +1,6 @@ # Type Properties -The `TypeValue` ([Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/types/TypeValue.html)) and `TypeSubTypeValue` ([Javadoc]()) are special properties which are similar to `String`, but also store a secondary string ('type') or secondary and tertiary strings ('type' & 'subtype'). +The `TypeValue` ([Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/types/TypeValue.html)) and `TypeSubTypeValue` ([Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/types/TypeSubTypeValue.html)) are special properties which are similar to `String`, but also store a secondary string ('type') or secondary and tertiary strings ('type' & 'subtype'). ## Predicate Support