Skip to content

Commit

Permalink
[Doc] Rename 'Interactions with JanusGraph' section to 'JanusGraph Ba…
Browse files Browse the repository at this point in the history
…sics'

The JanusGraph Basics section was split into a few sections in v0.6, one of which was
'Interactions with JanusGraph'. This section contains 3 things: transactions, predicates,
and drivers. It's hard to find a common topic among them, and 'interactions' is a very vague
word that is not straight-forward to understand. This renames the section back to 'JanusGraph
Basics', because transactions, predicates, and drivers are the necessary basic staff one has
to learn about in order to use JanusGraph.

Signed-off-by: Boxuan Li <liboxuan@connect.hku.hk>
  • Loading branch information
li-boxuan committed Oct 9, 2023
1 parent bef739e commit 41f727d
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/advanced-topics/eventual-consistency.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ The following strategies can be used to mitigate this issue:

**Existence checks**
Configure transactions to (double) check for the existence of vertices
prior to returning them. Please see [Transaction Configuration](../interactions/transactions.md#transaction-configuration) for more
prior to returning them. Please see [Transaction Configuration](../basics/transactions.md#transaction-configuration) for more
information and note that this can significantly decrease performance.
Note, that this does not fix the inconsistencies but hides some of them
from the user.
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/technical-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ JanusGraph.
### Limited Mixed Index Support

Mixed indexes only support a subset of the data types that JanusGraph
supports. See [Mixed Index Data Types](../interactions/search-predicates.md#data-type-support) for a current
supports. See [Mixed Index Data Types](../basics/search-predicates.md#data-type-support) for a current
listing. Also, mixed indexes do not currently support property keys with
SET or LIST cardinality.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ after the keyword `serializers`. This will add the support on the server site.
```
!!! note
The java driver is the only driver that currently supports GraphBinary,
see [Connecting to JanusGraph using Java](interactions/connecting/java.md).
see [Connecting to JanusGraph using Java](basics/connecting/java.md).
!!! note
Version 1.0.0 moves everything under `org.apache.tinkerpop.gremlin.driver.ser` package to
Expand Down
2 changes: 1 addition & 1 deletion docs/common-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ is to allow ghost vertices temporarily and clearing them out in regular
time intervals.

Another option is to detect them at read-time using the option
`checkInternalVertexExistence()` documented in [Transaction Configuration](interactions/transactions.md#transaction-configuration).
`checkInternalVertexExistence()` documented in [Transaction Configuration](basics/transactions.md#transaction-configuration).

## Debug-level Logging Slows Execution

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/gremlin.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ information on Gremlin, refer to the following resources:
- [Gremlin for SQL developers](http://sql2gremlin.com): Learn Gremlin
using typical patterns found when querying data with SQL.

In addition to these resources, [Connecting to JanusGraph](../interactions/connecting/index.md) explains how Gremlin
In addition to these resources, [Connecting to JanusGraph](../basics/connecting/index.md) explains how Gremlin
can be used in different programming languages to query a JanusGraph
Server.

Expand Down Expand Up @@ -163,7 +163,7 @@ traversal above is correct.
!!! note
The Gremlin overview presented in this section focused on the
Gremlin-Groovy language implementation used in the Gremlin Console.
Refer to [Connecting to JanusGraph](../interactions/connecting/index.md) for information about connecting to
Refer to [Connecting to JanusGraph](../basics/connecting/index.md) for information about connecting to
JanusGraph with other languages than Groovy and independent of the
Gremlin Console.

Expand Down
2 changes: 1 addition & 1 deletion docs/operations/configured-graph-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ It is recommended to use a sessioned connection when creating a
Configured Graph Factory template. If a sessioned connection is not used
the Configured Graph Factory Template creation must be sent to the
server as a single line using semi-colons. See details on sessions can
be found in [Connecting to Gremlin Server](../interactions/connecting/index.md).
be found in [Connecting to Gremlin Server](../basics/connecting/index.md).

```groovy
gremlin> :remote connect tinkerpop.server conf/remote.yaml session
Expand Down
2 changes: 1 addition & 1 deletion docs/operations/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ When the container is started it will execute files with the extension
Gremlin Console.
These scripts are only executed after the JanusGraph Server instance was
started.
So, they can [connect to it](../interactions/connecting/index.md) and execute Gremlin traversals.
So, they can [connect to it](../basics/connecting/index.md) and execute Gremlin traversals.

For example, to add a vertex to the graph, create a file
`/docker-entrypoint-initdb.d/add-vertex.groovy` with the following content:
Expand Down
2 changes: 1 addition & 1 deletion docs/operations/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ against one or more JanusGraph instances hosted within it. This section
will describe how to use the WebSocket configuration, as well as
describe how to configure JanusGraph Server to handle HTTP endpoint
interactions. For information about how to connect to a JanusGraph
Server from different languages refer to [Connecting to JanusGraph](../interactions/connecting/index.md).
Server from different languages refer to [Connecting to JanusGraph](../basics/connecting/index.md).

## Starting a JanusGraph Server

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/index-management/index-performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ g.V().or(__.has('name', textContains('hercules')), __.has('age', inside(20, 50))
```

Mixed indexes support full-text search, range search, geo search and
others. Refer to [Search Predicates and Data Types](../../interactions/search-predicates.md) for a list of predicates
others. Refer to [Search Predicates and Data Types](../../basics/search-predicates.md) for a list of predicates
supported by a particular indexing backend.

!!! note
Expand Down
31 changes: 18 additions & 13 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,23 @@ plugins:
basics/deployment.md: operations/deployment.md
basics/configured-graph-factory.md: operations/configured-graph-factory.md
basics/multi-node.md: operations/dynamic-graphs.md
basics/transactions.md: interactions/transactions.md
interactions/transactions.md: basics/transactions.md
basics/configuration-reference.md: configs/configuration-reference.md
basics/example-config.md: configs/example-config.md
index-management/index-performance.md: schema/index-management/index-performance.md
index-management/index-lifecycle.md: schema/index-management/index-lifecycle.md
index-management/index-reindexing.md: schema/index-management/index-reindexing.md
index-management/index-removal.md: schema/index-management/index-removal.md
index-backend/search-predicates.md: interactions/search-predicates.md
connecting/index.md: interactions/connecting/index.md
connecting/java.md: interactions/connecting/java.md
connecting/python.md: interactions/connecting/python.md
connecting/dotnet.md: interactions/connecting/dotnet.md
index-backend/search-predicates.md: basics/search-predicates.md
connecting/index.md: basics/connecting/index.md
connecting/java.md: basics/connecting/java.md
connecting/python.md: basics/connecting/python.md
connecting/dotnet.md: basics/connecting/dotnet.md
interactions/search-predicates.md: basics/search-predicates.md
interactions/connecting/index.md: basics/connecting/index.md
interactions/connecting/java.md: basics/connecting/java.md
interactions/connecting/python.md: basics/connecting/python.md
interactions/connecting/dotnet.md: basics/connecting/dotnet.md
advanced-topics/bulk-loading.md: operations/bulk-loading.md
advanced-topics/advschema.md: schema/advschema.md
advanced-topics/monitoring.md: operations/monitoring.md
Expand Down Expand Up @@ -104,14 +109,14 @@ nav:
- Basic Usage: getting-started/basic-usage.md
- Gremlin Query Language: getting-started/gremlin.md
- Architectural Overview: getting-started/architecture.md
- Interactions with JanusGraph:
- Transactions: interactions/transactions.md
- Search Predicates and Mixed Index Data Types: interactions/search-predicates.md
- JanusGraph Basics:
- Transactions: basics/transactions.md
- Search Predicates and Mixed Index Data Types: basics/search-predicates.md
- Connecting to JanusGraph:
- Introduction: interactions/connecting/index.md
- Using Java: interactions/connecting/java.md
- Using Python: interactions/connecting/python.md
- Using .NET: interactions/connecting/dotnet.md
- Introduction: basics/connecting/index.md
- Using Java: basics/connecting/java.md
- Using Python: basics/connecting/python.md
- Using .NET: basics/connecting/dotnet.md
- Configuration:
- Introduction: configs/index.md
- Configuration Reference: configs/configuration-reference.md
Expand Down

1 comment on commit 41f727d

@github-actions
Copy link

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: 41f727d Previous: 68f49a1 Ratio
org.janusgraph.JanusGraphSpeedBenchmark.basicAddAndDelete 17840.745494109255 ms/op 14750.912757292574 ms/op 1.21
org.janusgraph.GraphCentricQueryBenchmark.getVertices 1566.9696737237446 ms/op 1346.1948471823591 ms/op 1.16
org.janusgraph.MgmtOlapJobBenchmark.runClearIndex 222.71365755652178 ms/op 221.0470166869565 ms/op 1.01
org.janusgraph.MgmtOlapJobBenchmark.runReindex 521.3984999551515 ms/op 463.2053476121212 ms/op 1.13
org.janusgraph.JanusGraphSpeedBenchmark.basicCount 571.9008658332933 ms/op 473.90261975756744 ms/op 1.21
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesAllPropertiesWithAllMultiQuerySlicesUnderMaxRequestsPerConnection 11249.40320668773 ms/op 8776.908210320456 ms/op 1.28
org.janusgraph.CQLMultiQueryBenchmark.getElementsWithUsingEmitRepeatSteps 39219.79748624762 ms/op 29926.15626700794 ms/op 1.31
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesMultiplePropertiesWithSmallBatch 40153.560033160946 ms/op 32526.844515654997 ms/op 1.23
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.vertexCentricPropertiesFetching 79480.36009070001 ms/op 59550.41166966667 ms/op 1.33
org.janusgraph.CQLMultiQueryBenchmark.getAllElementsTraversedFromOuterVertex 19621.21975319043 ms/op 15006.601503888596 ms/op 1.31
org.janusgraph.CQLMultiQueryBenchmark.getVerticesWithDoubleUnion 722.8162182377931 ms/op 610.4456304918209 ms/op 1.18
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesAllPropertiesWithUnlimitedBatch 9877.518705580715 ms/op 8351.21971247489 ms/op 1.18
org.janusgraph.CQLMultiQueryBenchmark.getNames 18822.34286307711 ms/op 14737.422644903432 ms/op 1.28
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesThreePropertiesWithAllMultiQuerySlicesUnderMaxRequestsPerConnection 13025.68249600176 ms/op 10903.708326936881 ms/op 1.19
org.janusgraph.CQLMultiQueryBenchmark.getLabels 16572.650981078583 ms/op 13305.68422999396 ms/op 1.25
org.janusgraph.CQLMultiQueryBenchmark.getVerticesFilteredByAndStep 773.2017139496096 ms/op 672.9530191288869 ms/op 1.15
org.janusgraph.CQLMultiQueryBenchmark.getVerticesFromMultiNestedRepeatStepStartingFromSingleVertex 24971.30053531786 ms/op 21151.69997790227 ms/op 1.18
org.janusgraph.CQLMultiQueryBenchmark.getVerticesWithCoalesceUsage 675.1765107414409 ms/op 566.2220666199714 ms/op 1.19
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesMultiplePropertiesWithAllMultiQuerySlicesUnderMaxRequestsPerConnection 32321.409106038096 ms/op 25822.55861829052 ms/op 1.25
org.janusgraph.CQLMultiQueryBenchmark.getIdToOutVerticesProjection 491.8143980045891 ms/op 411.4887692411499 ms/op 1.20
org.janusgraph.CQLMultiQueryMultiSlicesBenchmark.getValuesMultiplePropertiesWithUnlimitedBatch 36628.96436664363 ms/op 29794.881563733332 ms/op 1.23
org.janusgraph.CQLMultiQueryBenchmark.getNeighborNames 19573.475777154934 ms/op 14451.119747276667 ms/op 1.35
org.janusgraph.CQLMultiQueryBenchmark.getElementsWithUsingRepeatUntilSteps 20265.417587701668 ms/op 16086.213028835715 ms/op 1.26
org.janusgraph.CQLMultiQueryBenchmark.getAdjacentVerticesLocalCounts 20329.913062059208 ms/op 14981.480702516508 ms/op 1.36

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.