Packages

o

org.mongodb.scala.model

SearchIndexModel

object SearchIndexModel

A model describing the creation of a single Atlas Search index.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchIndexModel
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def apply(indexName: Option[String], definition: Bson, indexType: Option[SearchIndexType]): SearchIndexModel

    Construct an instance with the given search index name and definition.

    Construct an instance with the given search index name and definition.

    indexName

    the name of the search index to create.

    definition

    the search index mapping definition.

    indexType

    the search index type.

    returns

    the SearchIndexModel

  2. def apply(indexName: String, definition: Bson): SearchIndexModel

    Construct an instance with the given search index name and definition.

    Construct an instance with the given search index name and definition.

    indexName

    the name of the search index to create.

    definition

    the search index mapping definition.

    returns

    the SearchIndexModel

  3. def apply(definition: Bson): SearchIndexModel

    Construct an instance with the given Atlas Search index mapping definition.

    Construct an instance with the given Atlas Search index mapping definition.

    After calling this constructor, the name field will be null. In that case, when passing this SearchIndexModel to the createSearchIndexes method, the default search index name default will be used to create the search index.

    definition

    the search index mapping definition.

    returns

    the SearchIndexModel