mirror of https://gitee.com/bigwinds/arangodb
101 lines
3.5 KiB
Plaintext
101 lines
3.5 KiB
Plaintext
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief indexes
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2012 triagens GmbH, Cologne, Germany
|
|
///
|
|
/// 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.
|
|
///
|
|
/// Copyright holder is triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Jan Steemann
|
|
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexFulltextTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref IndexFulltext
|
|
/// <ul>
|
|
/// <li>@ref IndexFulltextIntro
|
|
/// </li>
|
|
/// <li>@ref IndexFulltextShell
|
|
/// <ul>
|
|
/// <li>@ref IndexFulltextShellEnsureFulltextIndex "collection.ensureFulltextIndex"</li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexFulltext Fulltext indexes
|
|
///
|
|
/// This is an introduction to ArangoDB's fulltext indexes.
|
|
///
|
|
/// @EMBEDTOC{IndexFulltextTOC}
|
|
///
|
|
/// @section IndexFulltextIntro Fulltext Indexes
|
|
////////////////////////////////////////////////
|
|
///
|
|
/// It is possible to define a fulltext index on one textual attribute of a
|
|
/// collection of documents. The fulltext index can then be used to efficiently
|
|
/// find exact words or prefixes of words contained in these documents.
|
|
///
|
|
/// @section IndexFulltextShell Accessing Fulltext Indexes from the Shell
|
|
/////////////////////////////////////////////////////////////////////////
|
|
///
|
|
/// @anchor IndexFulltextShellEnsureFulltextIndex
|
|
/// @copydetails JS_EnsureFulltextIndexVocbaseCol
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexFulltextHttpTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref IndexFulltextHttp
|
|
/// <ul>
|
|
/// <li>@ref IndexFulltextHttpEnsureFulltextIndex "POST /_api/index"</li>
|
|
/// <li>@ref IndexFulltextHttpFulltext "POST /_api/simple/fulltext"</li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexFulltextHttp Accessing Fulltext Indexes via Http
|
|
///
|
|
/// If a fulltext index exists, then @ref HttpSimpleFulltext
|
|
/// "/_api/simple/fulltext" will use this index to execute the specified fulltext
|
|
/// query.
|
|
///
|
|
/// @EMBEDTOC{IndexFulltextHttpTOC}
|
|
///
|
|
/// @anchor IndexFulltextHttpEnsureFulltextIndex
|
|
/// @copydetails JSF_POST_api_index_fulltext
|
|
///
|
|
/// @anchor IndexFulltextHttpFulltext
|
|
/// @copydetails JSA_PUT_api_simple_fulltext
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: c++
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
|
// End:
|