/
mkdocs.yml
186 lines (176 loc) · 8.25 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# Copyright 2019 JanusGraph Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
site_name: JanusGraph
repo_name: 'JanusGraph'
repo_url: 'https://github.com/janusgraph/janusgraph'
copyright: 'Copyright © 2023 JanusGraph Authors. All rights reserved.<br> The Linux Foundation has registered trademarks and uses trademarks. For a list of<br> trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage">Trademark Usage</a> page.<br> Cassandra, Groovy, HBase, Hadoop, Lucene, Solr, and TinkerPop are trademarks of the Apache Software Foundation.<br> Berkeley DB and Berkeley DB Java Edition are trademarks of Oracle.'
plugins:
- search
- macros
- include-markdown
- redirects:
redirect_maps:
basics/common-questions.md: common-questions.md
basics/cache.md: operations/cache.md
basics/technical-limitations.md: advanced-topics/technical-limitations.md
basics/transaction-log.md: advanced-topics/transaction-log.md
basics/configuration.md: configs/index.md
basics/schema.md: schema/index.md
basics/gremlin.md: getting-started/gremlin.md
basics/server.md: operations/server.md
basics/deployment.md: operations/deployment.md
basics/configured-graph-factory.md: operations/configured-graph-factory.md
basics/multi-node.md: operations/dynamic-graphs.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: 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
advanced-topics/migrating-titan.md: operations/migrating-titan.md
advanced-topics/migrating-thrift.md: operations/migrating-thrift.md
advanced-topics/recovery.md: operations/recovery.md
appendices.md: operations/management.md
theme:
language: 'en'
name: 'material'
features:
- navigation.footer
- navigation.sections
palette:
primary: 'green'
accent: 'teal'
font: false
logo: 'janusgraph-logomark.svg'
favicon: 'favicon.ico'
extra_css:
- 'theme/extra.css'
extra_javascript:
- 'theme/js/structor-menu.js'
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/janusgraph
- icon: fontawesome/brands/discord
link: https://discord.gg/5n4fjv4QAf
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/janusgraph
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/janusgraph
- icon: fontawesome/solid/envelope
link: https://lists.lfaidata.foundation/g/janusgraph-users
- icon: fontawesome/solid/envelope
link: https://lists.lfaidata.foundation/g/janusgraph-dev
latest_version: 1.0.0
snapshot_version: 1.1.0-SNAPSHOT
tinkerpop_version: 3.7.2
hadoop_version: 3.3.5
markdown_extensions:
- pymdownx.superfences
- pymdownx.blocks.details
- pymdownx.blocks.tab:
alternate_style: true
- markdown.extensions.admonition
- markdown.extensions.codehilite:
linenums: True
- codehilite
- attr_list
- def_list
nav:
- Introduction: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Basic Usage: getting-started/basic-usage.md
- Gremlin Query Language: getting-started/gremlin.md
- Architectural Overview: getting-started/architecture.md
- JanusGraph Basics:
- Transactions: basics/transactions.md
- Search Predicates and Mixed Index Data Types: basics/search-predicates.md
- Connecting to JanusGraph:
- 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
- Config Example: configs/example-config.md
- Schema Management:
- Schema and Data Modeling: schema/index.md
- Advanced Schema: schema/advschema.md
- Index Management:
- Indexing for Better Performance: schema/index-management/index-performance.md
- Index Lifecycle: schema/index-management/index-lifecycle.md
- Reindexing: schema/index-management/index-reindexing.md
- Removal: schema/index-management/index-removal.md
- Operations:
- JanusGraph Server: operations/server.md
- Deployment Scenarios: operations/deployment.md
- JanusGraph Container: operations/container.md
- ConfiguredGraphFactory: operations/configured-graph-factory.md
- Dynamic Graphs: operations/dynamic-graphs.md
- Batch Processing: operations/batch-processing.md
- Bulk Loading: operations/bulk-loading.md
- JanusGraph Cache: operations/cache.md
- Monitoring: operations/monitoring.md
- Migrating from Titan: operations/migrating-titan.md
- Migrating from Thrift: operations/migrating-thrift.md
- Failure & Recovery: operations/recovery.md
- Management System: operations/management.md
- Storage Backends:
- Introduction: storage-backend/index.md
- Apache Cassandra: storage-backend/cassandra.md
- Apache HBase: storage-backend/hbase.md
- Google Cloud Bigtable: storage-backend/bigtable.md
- ScyllaDB: storage-backend/scylladb.md
- Oracle Berkeley DB Java Edition: storage-backend/bdb.md
- InMemory Storage Backend: storage-backend/inmemorybackend.md
- Mixed Index Backends:
- Introduction: index-backend/index.md
- Index Parameters and Full-Text Search: index-backend/text-search.md
- Field Mapping: index-backend/field-mapping.md
- Direct Index Query: index-backend/direct-index-query.md
- Elasticsearch: index-backend/elasticsearch.md
- Apache Solr: index-backend/solr.md
- Apache Lucene: index-backend/lucene.md
- Advanced Topics:
- Eventually-Consistent Storage Backends: advanced-topics/eventual-consistency.md
- Custom Vertex ID: advanced-topics/custom-vertex-id.md
- Graph Partitioning: advanced-topics/partitioning.md
- Datatype and Attribute Serializer Configuration: advanced-topics/serializer.md
- JanusGraph with TinkerPop’s Hadoop-Gremlin: advanced-topics/hadoop.md
- Transaction Log: advanced-topics/transaction-log.md
- JanusGraph Data model: advanced-topics/data-model.md
- JanusGraph Bus: advanced-topics/janusgraph-bus.md
- ExecutorService: advanced-topics/executor-service.md
- Permanent stale index inconsistency: advanced-topics/stale-index.md
- Technical Limitations: advanced-topics/technical-limitations.md
- Snapshot Releases: advanced-topics/commit-releases.md
- Common Questions: common-questions.md
- Development: development.md
- Changelog: changelog.md