Package

org.mongodb.scala

model

Permalink

package model

The model package containing models and options that help describe MongoCollection operations

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. model
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type BsonField = com.mongodb.client.model.BsonField

    Permalink

    A representation of a BSON document field whose value is another BSON document.

  2. type BulkWriteOptions = com.mongodb.client.model.BulkWriteOptions

    Permalink

    The options to apply to a bulk write.

  3. type CountOptions = com.mongodb.client.model.CountOptions

    Permalink

    The options to apply to a count operation.

  4. type CreateCollectionOptions = com.mongodb.client.model.CreateCollectionOptions

    Permalink

    Options for creating a collection

  5. type DeleteManyModel[TResult] = com.mongodb.client.model.DeleteManyModel[TResult]

    Permalink

    A model describing the removal of all documents matching the query filter.

  6. type DeleteOneModel[TResult] = com.mongodb.client.model.DeleteOneModel[TResult]

    Permalink

    A model describing the removal of at most one document matching the query filter.

  7. type FindOneAndDeleteOptions = com.mongodb.client.model.FindOneAndDeleteOptions

    Permalink

    The options to apply to an operation that atomically finds a document and deletes it.

  8. type FindOneAndReplaceOptions = com.mongodb.client.model.FindOneAndReplaceOptions

    Permalink

    The options to apply to an operation that atomically finds a document and replaces it.

  9. type FindOneAndUpdateOptions = com.mongodb.client.model.FindOneAndUpdateOptions

    Permalink

    The options to apply to an operation that atomically finds a document and updates it.

  10. type FindOptions = com.mongodb.client.model.FindOptions

    Permalink

    The options to apply to a find operation.

  11. type IndexModel = com.mongodb.client.model.IndexModel

    Permalink

    A model describing the creation of a single index.

  12. type IndexOptionDefaults = com.mongodb.client.model.IndexOptionDefaults

    Permalink

    The default options for a collection to apply on the creation of indexes.

    The default options for a collection to apply on the creation of indexes.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

    See also

    Index options

  13. type IndexOptions = com.mongodb.client.model.IndexOptions

    Permalink

    The options to apply to the creation of an index.

  14. type InsertManyOptions = com.mongodb.client.model.InsertManyOptions

    Permalink

    The options to apply to an operation that inserts multiple documents into a collection.

  15. type InsertOneModel[TResult] = com.mongodb.client.model.InsertOneModel[TResult]

    Permalink

    A model describing an insert of a single document.

  16. type InsertOneOptions = com.mongodb.client.model.InsertOneOptions

    Permalink

    The options to apply to an operation that inserts a single document into a collection.

    The options to apply to an operation that inserts a single document into a collection.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  17. type MapReduceAction = com.mongodb.client.model.MapReduceAction

    Permalink

    The map reduce to collection actions.

    The map reduce to collection actions.

    These actions are only available when passing out a collection that already exists. This option is not available on secondary members of replica sets. The Enum values dictate what to do with the output collection if it already exists when the map reduce is run.

  18. type PushOptions = com.mongodb.client.model.PushOptions

    Permalink

    The options to apply to a $push update operator.

  19. type RenameCollectionOptions = com.mongodb.client.model.RenameCollectionOptions

    Permalink

    The options to apply when renaming a collection

  20. type ReplaceOneModel[TResult] = com.mongodb.client.model.ReplaceOneModel[TResult]

    Permalink

    A model describing the replacement of at most one document that matches the query filter.

  21. type ReturnDocument = com.mongodb.client.model.ReturnDocument

    Permalink

    Indicates which document to return, the original document before change or the document after the change

  22. type TextSearchOptions = com.mongodb.client.model.TextSearchOptions

    Permalink

    Text search options for the Filters text helper

    Text search options for the Filters text helper

    Since

    1.1

    See also

    $text

  23. type UnwindOptions = com.mongodb.client.model.UnwindOptions

    Permalink

    The options for an unwind aggregation pipeline stage

    The options for an unwind aggregation pipeline stage

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  24. type UpdateManyModel[TResult] = com.mongodb.client.model.UpdateManyModel[TResult]

    Permalink

    A model describing an update to all documents that matches the query filter.

    A model describing an update to all documents that matches the query filter. The update to apply must include only update operators.

  25. type UpdateOneModel[TResult] = com.mongodb.client.model.UpdateOneModel[TResult]

    Permalink

    A model describing an update to at most one document that matches the query filter.

    A model describing an update to at most one document that matches the query filter. The update to apply must include only update operators.

  26. type UpdateOptions = com.mongodb.client.model.UpdateOptions

    Permalink

    The options to apply when updating documents.

  27. type ValidationAction = com.mongodb.client.model.ValidationAction

    Permalink

    Determines whether to error on invalid documents or just warn about the violations but allow invalid documents.

    Determines whether to error on invalid documents or just warn about the violations but allow invalid documents.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  28. type ValidationLevel = com.mongodb.client.model.ValidationLevel

    Permalink

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  29. type ValidationOptions = com.mongodb.client.model.ValidationOptions

    Permalink

    Validation options for documents being inserted or updated in a collection

    Validation options for documents being inserted or updated in a collection

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  30. type WriteModel[TResult] = com.mongodb.client.model.WriteModel[TResult]

    Permalink

    A base class for models that can be used in a bulk write operations.

Value Members

  1. object Accumulators

    Permalink

    Builders for accumulators used in the group pipeline stage of an aggregation pipeline.

    Builders for accumulators used in the group pipeline stage of an aggregation pipeline.

    Since

    1.0

    See also

    Expressions

    Accumulators

    Aggregation pipeline

  2. object Aggregates

    Permalink

    Builders for aggregation pipeline stages.

    Builders for aggregation pipeline stages.

    Since

    1.0

    See also

    Aggregation pipeline

  3. object BsonField

    Permalink

    A representation of a BSON document field whose value is another BSON document.

  4. object BulkWriteOptions

    Permalink

    The options to apply to a bulk write.

  5. object CountOptions

    Permalink

    The options to apply to a count operation.

  6. object CreateCollectionOptions

    Permalink

    Options for creating a collection

  7. object DeleteManyModel

    Permalink

    A model describing the removal of all documents matching the query filter.

  8. object DeleteOneModel

    Permalink

    A model describing the removal of at most one document matching the query filter.

  9. object Filters

    Permalink

    A factory for query filters.

    A factory for query filters. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find(and(eq("x", 1), lt("y", 3)))

    Since

    1.0

  10. object FindOneAndDeleteOptions

    Permalink

    The options to apply to an operation that atomically finds a document and deletes it.

  11. object FindOneAndReplaceOptions

    Permalink

    The options to apply to an operation that atomically finds a document and replaces it.

  12. object FindOneAndUpdateOptions

    Permalink

    The options to apply to an operation that atomically finds a document and updates it.

  13. object FindOptions

    Permalink

    The options to apply to a find operation.

  14. object IndexModel

    Permalink

    A model describing the creation of a single index.

  15. object IndexOptionDefaults

    Permalink

    Options for creating an index

  16. object IndexOptions

    Permalink

    The options to apply to the creation of an index.

  17. object Indexes

    Permalink

    A factory for defining index keys.

    A factory for defining index keys. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.createIndex(compoundIndex(ascending("x"), descending("y")))
    Since

    1.0

  18. object InsertManyOptions

    Permalink

    The options to apply to an operation that inserts multiple documents into a collection.

  19. object InsertOneModel

    Permalink

    A model describing an insert of a single document.

  20. object InsertOneOptions

    Permalink

    The options to apply to an operation that inserts a single document into a collection.

    The options to apply to an operation that inserts a single document into a collection.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  21. object MapReduceAction

    Permalink

    The map reduce to collection actions.

    The map reduce to collection actions.

    These actions are only available when passing out a collection that already exists. This option is not available on secondary members of replica sets. The Enum values dictate what to do with the output collection if it already exists when the map reduce is run.

    Since

    1.0

  22. object Projections

    Permalink

    A factory for projections.

    A factory for projections. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find().projection(fields(include("x", "y"), excludeId()))

    Since

    1.0

  23. object PushOptions

    Permalink

    The options to apply to a $push update operator.

  24. object RenameCollectionOptions

    Permalink

    The options to apply when renaming a collection

  25. object ReplaceOneModel

    Permalink

    A model describing the replacement of at most one document that matches the query filter.

  26. object ReturnDocument

    Permalink

    Indicates which document to return, the original document before change or the document after the change

    Indicates which document to return, the original document before change or the document after the change

    Since

    1.0

  27. object Sorts

    Permalink

    A factory for sort specifications.

    A factory for sort specifications. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find().sort(orderBy(ascending("x", "y"), descending("z")))

    Since

    1.0

  28. object TextSearchOptions

    Permalink

    Text search options for the Filters text helper

    Text search options for the Filters text helper

    Since

    1.1

  29. object UnwindOptions

    Permalink

    The options for an unwind aggregation pipeline stage

    The options for an unwind aggregation pipeline stage

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  30. object UpdateManyModel

    Permalink

    A model describing an update to all documents that matches the query filter.

    A model describing an update to all documents that matches the query filter. The update to apply must include only update operators.

  31. object UpdateOneModel

    Permalink

    A model describing an update to at most one document that matches the query filter.

    A model describing an update to at most one document that matches the query filter. The update to apply must include only update operators.

  32. object UpdateOptions

    Permalink

    The options to apply when updating documents.

  33. object Updates

    Permalink

    A factory for document updates.

    A factory for document updates. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.updateOne(eq("x", 1), set("x", 2))

    Since

    1.0

  34. object ValidationAction

    Permalink

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  35. object ValidationLevel

    Permalink

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  36. object ValidationOptions

    Permalink

    Validation options for documents being inserted or updated in a collection

    Validation options for documents being inserted or updated in a collection

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

  37. package geojson

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped