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

Commit 6311518

Browse files
committed
Merge branch 'main' of https://github.com/arangodb/docs into DOC-347
2 parents 47cf061 + ed2bef1 commit 6311518

File tree

1,352 files changed

+112781
-109664
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,352 files changed

+112781
-109664
lines changed

3.10/analyzers.md

+41-8
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,9 @@ token, i.e. case conversion and accent removal.
331331
The *properties* allowed for this Analyzer are an object with the following
332332
attributes:
333333

334-
- `locale` (string): a locale in the format `language[_COUNTRY]`
335-
(square brackets denote optional parts), e.g. `"de"` or `"en_US"`. See the
336-
[ICU Documentation](https://unicode-org.github.io/icu/userguide/locale/){:target="_blank"}
334+
- `locale` (string): a locale in the format `language[_COUNTRY][_VARIANT]`
335+
(square brackets denote optional parts), e.g. `"de"`, `"en_US"`, or `"es__TRADITIONAL"`.
336+
See the [ICU Documentation](https://unicode-org.github.io/icu/userguide/locale/){:target="_blank"}
337337
for details. The locale is forwarded to ICU without checks.
338338
An invalid locale does not prevent the creation of the Analyzer.
339339
Also see [Supported Languages](#supported-languages).
@@ -496,9 +496,9 @@ case conversion and accent removal.
496496
The *properties* allowed for this Analyzer are an object with the following
497497
attributes:
498498

499-
- `locale` (string): a locale in the format `language[_COUNTRY]`
500-
(square brackets denote optional parts), e.g. `"de"` or `"en_US"`. See the
501-
[ICU Documentation](https://unicode-org.github.io/icu/userguide/locale/){:target="_blank"}
499+
- `locale` (string): a locale in the format `language[_COUNTRY][_VARIANT]`
500+
(square brackets denote optional parts), e.g. `"de"`, `"en_US"`, or `"es__TRADITIONAL"`.
501+
See the [ICU Documentation](https://unicode-org.github.io/icu/userguide/locale/){:target="_blank"}
502502
for details. The locale is forwarded to ICU without checks.
503503
An invalid locale does not prevent the creation of the Analyzer.
504504
Also see [Supported Languages](#supported-languages).
@@ -635,8 +635,8 @@ The *properties* allowed for this Analyzer are an object with the following
635635
attributes:
636636

637637
- `locale` (string): a locale in the format
638-
`language[_COUNTRY][_VARIANT][@keywords]` (square brackets denote optional
639-
parts), e.g. `"de"`, `"en_US"`, or `fr@collation=phonebook`. See the
638+
`language[_COUNTRY][_VARIANT][@keywords]` (square brackets denote optional parts),
639+
e.g. `"de"`, `"en_US"`, `"es__TRADITIONAL"`, or `fr@collation=phonebook`. See the
640640
[ICU Documentation](https://unicode-org.github.io/icu/userguide/locale/){:target="_blank"}
641641
for details. The locale is forwarded to ICU without checks.
642642
An invalid locale does not prevent the creation of the Analyzer.
@@ -1267,6 +1267,39 @@ attributes:
12671267
- `maxCells` (number, _optional_): maximum number of S2 cells (default: 20)
12681268
- `minLevel` (number, _optional_): the least precise S2 level (default: 4)
12691269
- `maxLevel` (number, _optional_): the most precise S2 level (default: 23)
1270+
- `legacy` (boolean, _optional_):
1271+
This option controls how GeoJSON Polygons are interpreted (introduced in v3.10.5).
1272+
Also see [Legacy Polygons](indexing-geo.html#legacy-polygons) and
1273+
[GeoJSON interpretation](indexing-geo.html#geojson-interpretation).
1274+
1275+
- If `legacy` is `true`, the smaller of the two regions defined by a
1276+
linear ring is interpreted as the interior of the ring and a ring can at most
1277+
enclose half the Earth's surface.
1278+
- If `legacy` is `false`, the area to the left of the boundary ring's
1279+
path is considered to be the interior and a ring can enclose the entire
1280+
surface of the Earth.
1281+
1282+
The default is `false`.
1283+
1284+
{% hint 'warning' %}
1285+
If you use `geojson` Analyzers and upgrade from a version below 3.10 to a
1286+
version of 3.10 or higher, the interpretation of GeoJSON Polygons changes.
1287+
1288+
If you have polygons in your data that mean to refer to a relatively small
1289+
region but have the boundary running clockwise around the intended interior,
1290+
they are interpreted as intended prior to 3.10, but from 3.10 onward, they are
1291+
interpreted as "the other side" of the boundary.
1292+
1293+
Whether a clockwise boundary specifies the complement of the small region
1294+
intentionally or not cannot be determined automatically. Please test the new
1295+
behavior manually.
1296+
1297+
If you require the old behavior, upgrade to at least 3.10.5, drop your
1298+
`geojson` Analyzers, and create new ones with `legacy` set to `true`.
1299+
If these Analyzers are used in `arangosearch` Views, then they need to be
1300+
dropped as well before dropping the Analyzers, and recreated after creating
1301+
the new Analyzers.
1302+
{% endhint %}
12701303

12711304
**Examples**
12721305

3.10/aql/examples-combining-graph-traversals.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We use [the city graph](../graphs.html#the-city-graph) and its geo indexes:
1616
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
1717
@startDocuBlockInline COMBINING_GRAPH_01_create_graph
1818
@EXAMPLE_ARANGOSH_OUTPUT{COMBINING_GRAPH_01_create_graph}
19-
var examples = require("@arangodb/graph-examples/example-graph.js");
19+
var examples = require("@arangodb/graph-examples/example-graph");
2020
var g = examples.loadGraph("routeplanner");
2121
~examples.dropGraph("routeplanner");
2222
@END_EXAMPLE_ARANGOSH_OUTPUT
@@ -112,7 +112,7 @@ Finally, we clean up again:
112112
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
113113
@startDocuBlockInline COMBINING_GRAPH_06_cleanup
114114
@EXAMPLE_ARANGOSH_OUTPUT{COMBINING_GRAPH_06_cleanup}
115-
~var examples = require("@arangodb/graph-examples/example-graph.js");
115+
~var examples = require("@arangodb/graph-examples/example-graph");
116116
~var g = examples.loadGraph("routeplanner");
117117
examples.dropGraph("routeplanner");
118118
@END_EXAMPLE_ARANGOSH_OUTPUT

0 commit comments

Comments
 (0)