trait ArangoDocuments[F[_]] extends AnyRef
Arango documents API
- F
effect
- Alphabetic
- By Inheritance
- ArangoDocuments
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
count(transactionId: Option[TransactionId] = None): F[ArangoResponse[CollectionCount]]
Counts the documents in a collection
-
abstract
def
create[T](documents: Seq[T], waitForSync: Boolean = false, returnNew: Boolean = false, returnOld: Boolean = false, silent: Boolean = false, overwrite: Boolean = false, transaction: Option[TransactionId] = None)(implicit arg0: VPackDecoder[T], arg1: VPackEncoder[T]): F[ArangoResponse[Seq[Document[T]]]]
Create documents
Create documents
- T
document type
- documents
documents value
- waitForSync
Wait until document has been synced to disk. (optional)
- returnNew
Additionally return the complete new document under the attribute *new* in the result. (optional)
- returnOld
Additionally return the complete old document under the attribute *old* in the result. Only available if the overwrite option is used. (optional)
- silent
If set to *true*, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. (optional)
- overwrite
If set to *true*, the insert becomes a replace-insert. If a document with the same *_key* already exists the new document is not rejected with unique constraint violated but will replace the old document. (optional)
-
abstract
def
insert[T](document: T, waitForSync: Boolean = false, returnNew: Boolean = false, returnOld: Boolean = false, silent: Boolean = false, overwrite: Boolean = false, transaction: Option[TransactionId] = None)(implicit arg0: VPackEncoder[T], arg1: VPackDecoder[T]): F[ArangoResponse[Document[T]]]
Create a document
Create a document
- T
document type
- document
document value
- waitForSync
Wait until document has been synced to disk. (optional)
- returnNew
Additionally return the complete new document under the attribute *new* in the result. (optional)
- returnOld
Additionally return the complete old document under the attribute *old* in the result. Only available if the overwrite option is used. (optional)
- silent
If set to *true*, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. (optional)
- overwrite
If set to *true*, the insert becomes a replace-insert. If a document with the same *_key* already exists the new document is not rejected with unique constraint violated but will replace the old document. (optional)
-
abstract
def
remove[T, K](keys: Seq[K], waitForSync: Boolean = false, returnOld: Boolean = false, ignoreRevs: Boolean = true, transaction: Option[TransactionId] = None)(implicit arg0: VPackDecoder[T], arg1: VPackEncoder[K]): F[ArangoResponse[Seq[Document[T]]]]
The body of the request is an array consisting of selectors for documents.
The body of the request is an array consisting of selectors for documents. A selector can either be a string with a key or a string with a document handle or an object with a _key attribute. This API call removes all specified documents from collection. If the selector is an object and has a _rev attribute, it is a precondition that the actual revision of the removed document in the collection is the specified one
- T
Response body type
- K
Key selector type
- keys
Removes the document identified by document-handle.
- waitForSync
Wait until deletion operation has been synced to disk.
- returnOld
Return additionally the complete previous revision of the changed document under the attribute old in the result.
- ignoreRevs
If set to true, ignore any _rev attribute in the selectors. No revision check is performed
-
abstract
def
replace[T](documents: Seq[T], waitForSync: Boolean = false, ignoreRevs: Boolean = true, returnOld: Boolean = false, returnNew: Boolean = false, transaction: Option[TransactionId] = None)(implicit arg0: VPackDecoder[T], arg1: VPackEncoder[T]): F[ArangoResponse[Seq[Document[T]]]]
Replaces multiple documents in the specified collection with the ones in the body, the replaced documents are specified by the _key attributes in the body documents.
Replaces multiple documents in the specified collection with the ones in the body, the replaced documents are specified by the _key attributes in the body documents.
- T
document type
- documents
representation of an array of documents
- waitForSync
Wait until the new documents have been synced to disk
- ignoreRevs
By default, or if this is set to true, the _rev attributes in the given documents are ignored. If this is set to false, then any _rev attribute given in a body document is taken as a precondition. The document is only replaced if the current revision is the one specified
- returnOld
Return additionally the complete previous revision of the changed documents under the attribute old in the result
- returnNew
Return additionally the complete new documents under the attribute new in the result
-
abstract
def
update[T, P](patch: Seq[P], keepNull: Boolean = false, mergeObjects: Boolean = true, waitForSync: Boolean = false, ignoreRevs: Boolean = true, returnOld: Boolean = false, returnNew: Boolean = false, transaction: Option[TransactionId] = None)(implicit arg0: VPackDecoder[T], arg1: VPackEncoder[P]): F[ArangoResponse[Seq[Document[T]]]]
Partially updates documents, the documents to update are specified by the _key attributes in the body objects.
Partially updates documents, the documents to update are specified by the _key attributes in the body objects. The body of the request must contain a JSON array of document updates with the attributes to patch (the patch documents). All attributes from the patch documents will be added to the existing documents if they do not yet exist, and overwritten in the existing documents if they do exist there
- T
document type
- P
patch type
- patch
representation of an array of document updates as objects
- keepNull
If the intention is to delete existing attributes with the patch command, the URL query parameter keepNull can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null
- mergeObjects
Controls whether objects (not arrays) will be merged if present in both the existing and the patch document. If set to false, the value in the patch document will overwrite the existing document's value. If set to true, objects will be merged. The default is true
- waitForSync
Wait until the new documents have been synced to disk
- ignoreRevs
By default, or if this is set to true, the _rev attributes in the given documents are ignored. If this is set to false, then any _rev attribute given in a body document is taken as a precondition. The document is only updated if the current revision is the one specified
- returnOld
Return additionally the complete previous revision of the changed documents under the attribute old in the result
- returnNew
Return additionally the complete new documents under the attribute new in the result
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()