Packages

trait ArangoCollection[F[_]] extends AnyRef

ArangoDB collection API

F

effect

See also

https://www.arangodb.com/docs/stable/http/collection.html

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

Abstract Value Members

  1. abstract def all: ArangoQuery[F, VObject]

    Query all documents in collection

    Query all documents in collection

    returns

    query

  2. abstract def checksum(withRevisions: Boolean = false, withData: Boolean = false): F[ArangoResponse[CollectionChecksum]]

    Will calculate a checksum of the meta-data (keys and optionally revision ids) and optionally the document data in the collection.

    Will calculate a checksum of the meta-data (keys and optionally revision ids) and optionally the document data in the collection.

    The checksum can be used to compare if two collections on different ArangoDB instances contain the same contents. The current revision of the collection is returned too so one can make sure the checksums are calculated for the same state of data.

    By default, the checksum will only be calculated on the _key system attribute of the documents contained in the collection. For edge collections, the system attributes _from and _to will also be included in the calculation.

    withRevisions

    include document revision ids in the checksum calculation

    withData

    include document body data in the checksum calculation

  3. abstract def create(setup: (CollectionCreate) ⇒ CollectionCreate = identity): F[ArangoResponse[CollectionInfo]]

    Create the collection

    Create the collection

    setup

    modify creation options

    returns

    collection information

  4. abstract def document(key: DocumentKey): ArangoDocument[F]

    existing document api

  5. abstract def documents: ArangoDocuments[F]

    documents api

  6. abstract def drop(isSystem: Boolean = false): F[ArangoResponse[DeleteResult]]

    Drop collection

    Drop collection

    isSystem

    Whether or not the collection to drop is a system collection. This parameter must be set to true in order to drop a system collection.

    returns

    identifier of the dropped collection

  7. abstract def index(id: String): ArangoIndex[F]

    existing index api

  8. abstract def indexes: ArangoIndexes[F]

    indexes api

  9. abstract def info(): F[ArangoResponse[CollectionInfo]]

    Return information about collection

    Return information about collection

    returns

    collection information

  10. abstract def load(): F[ArangoResponse[CollectionInfo]]

    Load collection

    Load collection

    returns

    collection information

  11. abstract def name: CollectionName

    collection name

  12. abstract def properties(): F[ArangoResponse[CollectionProperties]]

    Read properties of collection

    Read properties of collection

    returns

    collection properties

  13. abstract def rename(newName: CollectionName): F[ArangoResponse[CollectionInfo]]

    Rename collection

  14. abstract def revision(): F[ArangoResponse[CollectionRevision]]

    Return collection revision id

    Return collection revision id

    The revision is a server-generated string that clients can use to check whether data in a collection has changed since the last revision check.

    returns

    collection revision

  15. abstract def truncate(waitForSync: Boolean = false, compact: Boolean = true): F[ArangoResponse[CollectionInfo]]

    Truncate collection

    Truncate collection

    waitForSync

    If true then the data is synchronized to disk before returning from the truncate operation

    compact

    If true then the storage engine is told to start a compaction in order to free up disk space. This can be resource intensive. If the only intention is to start over with an empty collection, specify false.

    returns

    collection information

  16. abstract def unload(): F[ArangoResponse[CollectionInfo]]

    Unload collection

    Unload collection

    returns

    collection information

  17. abstract def update(waitForSync: Option[Boolean] = None, schema: Option[CollectionSchema] = None): F[ArangoResponse[CollectionProperties]]

    Update properties of collection

    Update properties of collection

    waitForSync

    If true then creating or changing a document will wait until the data has been synchronized to disk

    schema

    Object that specifies the collection level schema for documents. The attribute keys rule, level and message must follow the rules documented in Document Schema Validation

    returns

    collection properties

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