com.foursquare.index

MongoIndexChecker

object MongoIndexChecker

A utility object which provides the capability to verify if the set of indexes that actually exist for a MongoDB collection match the indexes that are expected by a query.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MongoIndexChecker
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def flattenCondition(condition: AndCondition): List[List[QueryClause[_]]]

    Flattens an arbitrary query into DNF - that is, into a list of query alternatives implicitly joined by logical "or", where each of alternatives consists of a list of query clauses implicitly joined by "and".

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def getIndexes(query: Query[_, _, _]): Option[List[MongoIndex[_]]]

    Retrieves the list of indexes declared for the record type associated with a query.

    Retrieves the list of indexes declared for the record type associated with a query. If the record type doesn't declare any indexes, then returns None.

    query

    the query

    returns

    the list of indexes, or an empty list.

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def normalizeCondition(condition: AndCondition): List[List[QueryClause[_]]]

  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. def validateIndexExpectations(query: Query[_, _, _], indexes: List[MongoIndex[_]]): Boolean

    Verifies that the indexes expected for a query actually exist in the mongo database.

    Verifies that the indexes expected for a query actually exist in the mongo database. Signals an error if the indexes don't fulfull the expectations. ({@see #throwErrors}) This version of validaateIndexExpectations is intended for use in cases where the indexes are not explicitly declared in the class, but the caller knows what set of indexes are actually available.

    query

    the query being validated.

    indexes

    a list of the indexes

    returns

    true if the required indexes are found, false otherwise.

  23. def validateIndexExpectations(query: Query[_, _, _]): Boolean

    Verifies that the indexes expected for a query actually exist in the mongo database.

    Verifies that the indexes expected for a query actually exist in the mongo database. Logs an error via QueryLogger#logIndexMismatch if there is no matching index. Clients may choose to signal errors by overriding logIndexMismatch.

    query

    the query being validated.

    returns

    true if the required indexes are found, false otherwise.

  24. def validateQueryMatchesSomeIndex(query: Query[_, _, _], indexes: List[MongoIndex[_]]): Boolean

    Verifies that the index expected by a query both exists, and will be used by MongoDB to execute that query.

    Verifies that the index expected by a query both exists, and will be used by MongoDB to execute that query. (Due to vagaries of the MongoDB implementation, sometimes a conceptually usable index won't be found.)

    query

    the query

    indexes

    the list of indexes that exist in the database

  25. def validateQueryMatchesSomeIndex(query: Query[_, _, _]): Boolean

    Verifies that the index expected by a query both exists, and will be used by MongoDB to execute that query.

    Verifies that the index expected by a query both exists, and will be used by MongoDB to execute that query. (Due to vagaries of the MongoDB implementation, sometimes a conceptually usable index won't be found.)

    query

    the query

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped