1
0
Fork 0

fixed documentation

This commit is contained in:
Jan Steemann 2014-11-06 13:39:35 +01:00
parent 22d2cfd876
commit e93a9a8ce2
2 changed files with 9 additions and 14 deletions

View File

@ -58,7 +58,7 @@ as defined at server startup (*--server.default-language* startup
option). Generally, the word boundary analysis will filter out punctuation but
will not do much more.
Especially no Word normalization, stemming, or similarity analysis will be
Especially no word normalization, stemming, or similarity analysis will be
performed when indexing or searching. If any of these features is required, it
is suggested that the user does the text normalization on the client side, and
provides for each document an extra attribute containing just a comma-separated

View File

@ -2110,28 +2110,23 @@ static v8::Handle<v8::Value> FulltextQuery (SingleCollectionReadOnlyTransaction&
////////////////////////////////////////////////////////////////////////////////
/// @brief queries the fulltext index
/// @startDocuBlock collectionFulltext
/// `collection.fulltext(index-handle, query)`
/// `collection.fulltext(attribute, query)`
///
/// The *FULLTEXT* operator performs a fulltext search using the specified
/// index and the specified *query*.
/// The *FULLTEXT* operator performs a fulltext search on the specified
/// *attribute* and the specified *query*.
///
/// *query* must contain a comma-separated list of words to look for.
/// Each word can optionally be prefixed with one of the following command
/// literals:
/// - *prefix*: perform a prefix-search for the word following
/// - *substring*: perform substring-matching for the word following. This
/// option is only supported for fulltext indexes that have been created with
/// the *indexSubstrings* option
/// - *complete*: only match the complete following word (this is the default)
/// Details about the fulltext query syntax can be found below.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{collectionFulltext}
/// ~ db._drop("emails");
/// ~ db._create("emails");
/// var idx = db.emails.ensureFulltextIndex("content").id;
/// db.emails.ensureFulltextIndex("content").id;
/// db.emails.save({ content: "Hello Alice, how are you doing? Regards, Bob" });
/// db.emails.fulltext(idx.id, "alice,bob").toArray();
/// db.emails.save({ content: "Hello Charlie, do Alice and Bob know about it?" });
/// db.emails.save({ content: "I think they don't know. Regards, Eve" });
/// db.emails.fulltext("content", "charlie,|eve").toArray();
/// ~ db._drop("emails");
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock