Packages

trait ArangoIndexes[F[_]] extends AnyRef

Arango indexes API

F

effect

See also

https://www.arangodb.com/docs/stable/http/indexes-working-with.html

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

Abstract Value Members

  1. abstract def createFullText(fields: List[String], minLength: Option[Int] = None, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a fulltext index for the collection collection-name, if it does not already exist.

    Creates a fulltext index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.

    fields

    an array of attribute names. Currently, the array is limited to exactly one attribute

    minLength

    Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.

  2. abstract def createGeo(fields: List[String], geoJson: Boolean = false, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a geo-spatial index in the collection collection-name, if it does not already exist.

    Creates a geo-spatial index in the collection collection-name, if it does not already exist. Expects an object containing the index details.

    Geo indexes are always sparse, meaning that documents that do not contain the index attributes or have non-numeric values in the index attributes will not be indexed.

    fields

    An array with one or two attribute paths. If it is an array with one attribute path location, then a geo-spatial index on all documents is created using location as path to the coordinates. The value of the attribute must be an array with at least two double values. The array must contain the latitude (first value) and the longitude (second value). All documents, which do not have the attribute path or with value that are not suitable, are ignored. If it is an array with two attribute paths latitude and longitude, then a geo-spatial index on all documents is created using latitude and longitude as paths the latitude and the longitude. The value of the attribute latitude and of the attribute longitude must a double. All documents, which do not have the attribute paths or which values are not suitable, are ignored.

    geoJson

    If a geo-spatial index on a location is constructed and geoJson is true, then the order within the array is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions

  3. abstract def createHash(fields: List[String], unique: Boolean = false, sparse: Boolean = false, deduplicate: Boolean = false, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a hash index for the collection collection-name if it does not already exist.

    Creates a hash index for the collection collection-name if it does not already exist. The call expects an object containing the index details.

    In a sparse index all documents will be excluded from the index that do not contain at least one of the specified index attributes (i.e. fields) or that have a value of null in any of the specified index attributes. Such documents will not be indexed, and not be taken into account for uniqueness checks if the unique flag is set.

    In a non-sparse index, these documents will be indexed (for non-present indexed attributes, a value of null will be used) and will be taken into account for uniqueness checks if the unique flag is set.

    Note: unique indexes on non-shard keys are not supported in a cluster.

    fields

    an array of attribute paths

    unique

    if true, then create a unique index

    sparse

    if true, then create a sparse index

    deduplicate

    if false, the deduplication of array values is turned off

  4. abstract def createPersistent(fields: List[String], unique: Boolean = false, sparse: Boolean = false, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a persistent index for the collection collection-name, if it does not already exist.

    Creates a persistent index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.

    In a sparse index all documents will be excluded from the index that do not contain at least one of the specified index attributes (i.e. fields) or that have a value of null in any of the specified index attributes. Such documents will not be indexed, and not be taken into account for uniqueness checks if the unique flag is set.

    In a non-sparse index, these documents will be indexed (for non-present indexed attributes, a value of null will be used) and will be taken into account for uniqueness checks if the unique flag is set.

    Note: unique indexes on non-shard keys are not supported in a cluster.

    fields

    an array of attribute paths

    unique

    if true, then create a unique index

    sparse

    if true, then create a sparse index

  5. abstract def createSkipList(fields: List[String], unique: Boolean = false, sparse: Boolean = false, deduplicate: Boolean = false, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a skip-list index for the collection collection-name, if it does not already exist.

    Creates a skip-list index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.

    In a sparse index all documents will be excluded from the index that do not contain at least one of the specified index attributes (i.e. fields) or that have a value of null in any of the specified index attributes. Such documents will not be indexed, and not be taken into account for uniqueness checks if the unique flag is set.

    In a non-sparse index, these documents will be indexed (for non-present indexed attributes, a value of null will be used) and will be taken into account for uniqueness checks if the unique flag is set.

    Note: unique indexes on non-shard keys are not supported in a cluster.

    fields

    an array of attribute paths

    unique

    if true, then create a unique index

    sparse

    if true, then create a sparse index

    deduplicate

    if false, the deduplication of array values is turned off

  6. abstract def createTtl(fields: List[String], expireAfter: Int, name: Option[String] = None): F[ArangoResponse[Index]]

    Creates a TTL index for the collection collection-name if it does not already exist.

    Creates a TTL index for the collection collection-name if it does not already exist. The call expects an object containing the index details.

    fields

    an array with exactly one attribute path

    expireAfter

    The time (in seconds) after a document’s creation after which the documents count as “expired”.

  7. abstract def list(): F[ArangoResponse[IndexList]]

    Returns an object with an attribute indexes containing an array of all index descriptions for the given collection.

    Returns an object with an attribute indexes containing an array of all index descriptions for the given collection. The same information is also available in the identifiers as an object with the index handles as keys.

    returns

    all indexes of a collection

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped