mirror of https://gitee.com/bigwinds/arangodb
Try to circumvent markdown parser quirks
This commit is contained in:
parent
913cbab632
commit
55ae5b4bb6
|
@ -176,12 +176,14 @@ comparison with the next example until there are no more examples left.
|
||||||
The *examples* can be an array of 1..n example documents or a single document,
|
The *examples* can be an array of 1..n example documents or a single document,
|
||||||
with any number of attributes each.
|
with any number of attributes each.
|
||||||
|
|
||||||
|
Note that *MATCHES()* can not utilize indexes.
|
||||||
|
|
||||||
- **document** (object): document to determine whether it matches any example
|
- **document** (object): document to determine whether it matches any example
|
||||||
- **examples** (object|array): a single document, or an array of documents to compare
|
- **examples** (object|array): a single document, or an array of documents to compare
|
||||||
against. Specifying an empty array is not allowed.
|
against. Specifying an empty array is not allowed.
|
||||||
- **returnIndex** (bool): by setting this flag to *true*, the index of the example that
|
- **returnIndex** (bool): by setting this flag to *true*, the index of the example that
|
||||||
matched will be returned (starting at offset 0), or *-1* if there was no match.
|
matched will be returned (starting at offset 0), or *-1* if there was no match.
|
||||||
The default is **false** and makes the function return a boolean.
|
The default is *false* and makes the function return a boolean.
|
||||||
- returns **match** (bool|number): if *document* matches one of the examples, *true* is
|
- returns **match** (bool|number): if *document* matches one of the examples, *true* is
|
||||||
returned, otherwise *false*. A number is returned instead if *returnIndex* is used.
|
returned, otherwise *false*. A number is returned instead if *returnIndex* is used.
|
||||||
|
|
||||||
|
@ -194,7 +196,7 @@ LET doc = {
|
||||||
RETURN MATCHES(doc, { age: 27, active: true } )
|
RETURN MATCHES(doc, { age: 27, active: true } )
|
||||||
```
|
```
|
||||||
|
|
||||||
This will return **true**, because all attributes of the example are present in the document.
|
This will return *true*, because all attributes of the example are present in the document.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
RETURN MATCHES(
|
RETURN MATCHES(
|
||||||
|
@ -206,8 +208,8 @@ RETURN MATCHES(
|
||||||
], true)
|
], true)
|
||||||
```
|
```
|
||||||
|
|
||||||
This will return *2*, because the third example matches, and because the
|
This will return *2*, because the third example matches, and because the
|
||||||
*returnIndex* flag is set to *true*.
|
*returnIndex* flag is set to *true*.
|
||||||
|
|
||||||
!SUBSECTION MERGE()
|
!SUBSECTION MERGE()
|
||||||
|
|
||||||
|
|
|
@ -303,7 +303,7 @@ characters and sequences:
|
||||||
- `(xyz)` – defines and matches a pattern group
|
- `(xyz)` – defines and matches a pattern group
|
||||||
- `(x|y)` – matches either *x* or *y*
|
- `(x|y)` – matches either *x* or *y*
|
||||||
- `^` – matches the beginning of the string (e.g. `^xyz`)
|
- `^` – matches the beginning of the string (e.g. `^xyz`)
|
||||||
- `$` – matches the end of the string (e.g. `xyz$`)
|
- <code>$</code> – matches the end of the string (e.g. <code>xyz$</code>)
|
||||||
|
|
||||||
Note that the characters `.`, `*`, `?`, `[`, `]`, `(`, `)`, `{`, `}`, `^`,
|
Note that the characters `.`, `*`, `?`, `[`, `]`, `(`, `)`, `{`, `}`, `^`,
|
||||||
and `$` have a special meaning in regular expressions and may need to be
|
and `$` have a special meaning in regular expressions and may need to be
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
@RESTHEADER{DELETE /_api/gharial/{graph-name}, Drop a graph}
|
@RESTHEADER{DELETE /_api/gharial/{graph-name}, Drop a graph}
|
||||||
|
|
||||||
@RESTDESCRIPTION
|
@RESTDESCRIPTION
|
||||||
Removes a graph from the collection *\_graphs*.
|
Removes a graph from the collection *_graphs*.
|
||||||
|
|
||||||
@RESTURLPARAMETERS
|
@RESTURLPARAMETERS
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
|
|
||||||
@RESTDESCRIPTION
|
@RESTDESCRIPTION
|
||||||
Creates a new edge in the collection.
|
Creates a new edge in the collection.
|
||||||
Within the body the has to contain a *\_from* and *\_to* value referencing to valid vertices in the graph.
|
Within the body the has to contain a *_from* and *_to* value referencing to valid vertices in the graph.
|
||||||
Furthermore the edge has to be valid in the definition of this
|
Furthermore the edge has to be valid in the definition of this
|
||||||
[edge collection](../../Manual/Appendix/Glossary.html#edge-collection).
|
[edge collection](../../Manual/Appendix/Glossary.html#edge-collection).
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
@RESTHEADER{GET /_api/gharial/{graph-name}, Get a graph}
|
@RESTHEADER{GET /_api/gharial/{graph-name}, Get a graph}
|
||||||
|
|
||||||
@RESTDESCRIPTION
|
@RESTDESCRIPTION
|
||||||
Gets a graph from the collection *\_graphs*.
|
Gets a graph from the collection *_graphs*.
|
||||||
Returns the definition content of this graph.
|
Returns the definition content of this graph.
|
||||||
|
|
||||||
@RESTURLPARAMETERS
|
@RESTURLPARAMETERS
|
||||||
|
|
Loading…
Reference in New Issue