Collection

class pyArango.collection.Collection(database, jsonData)

A document collection. Collections are meant to be instanciated by databases

action(method, action, **params)

a generic fct for interacting everything that doesn’t have an assigned fct

activateCache(cacheSize)

Activate the caching system. Cached documents are only available through the __getitem__ interface

bulkImport_json(filename, onDuplicate='error', formatType='auto', **params)

bulk import from a file repecting arango’s key/value format

bulkImport_values(filename, onDuplicate='error', **params)

bulk import from a file repecting arango’s json format

bulkSave(docs, onDuplicate='error', **params)

Parameter docs must be either an iterrable of documents or dictionnaries. This function will return the number of documents, created and updated, and will raise an UpdateError exception if there’s at least one error. params are any parameters from arango’s documentation

checksum()

returns the current checksum

count()

returns the number of documents in the collection

createDocument(initDict=None)

create and returns a completely empty document or one populated with initDict

deactivateCache()

deactivate the caching system

delete()

deletes the collection from the database

empty()

alias for truncate

ensureFulltextIndex(fields, minLength=None, name=None)

Creates a fulltext index if it does not already exist, and returns it

ensureGeoIndex(fields, name=None)

Creates a geo index if it does not already exist, and returns it

ensureHashIndex(fields, unique=False, sparse=True, deduplicate=False, name=None)

Creates a hash index if it does not already exist, and returns it

ensureIndex(index_type, fields, name=None, **index_args)

Creates an index of any type.

ensurePersistentIndex(fields, unique=False, sparse=True, deduplicate=False, name=None)

Creates a persistent index if it does not already exist, and returns it

ensureSkiplistIndex(fields, unique=False, sparse=True, deduplicate=False, name=None)

Creates a skiplist index if it does not already exist, and returns it

ensureTTLIndex(fields, expireAfter, unique=False, sparse=True, name=None)

Creates a TTL index if it does not already exist, and returns it

fetchAll(rawResults=False, **queryArgs)

Returns all the documents in the collection. You can use the optinal arguments ‘skip’ and ‘limit’:

fetchAll(limit = 3, skip = 10)

fetchByExample(exampleDict, batchSize, rawResults=False, **queryArgs)

exampleDict should be something like {‘age’ : 28}

fetchDocument(key, rawResults=False, rev=None)

Fetches a document from the collection given it’s key. This function always goes straight to the db and bypasses the cache. If you want to take advantage of the cache use the __getitem__ interface: collection[key]

fetchFirstExample(exampleDict, rawResults=False)

exampleDict should be something like {‘age’ : 28}. returns only a single element but still in a SimpleQuery object. returns the first example found that matches the example

figures()

a more elaborate version of count, see arangodb docs for more infos

getIndexes()

Fills self.indexes with all the indexes associates with the collection and returns it

getStatus()

returns a word describing the status of the collection (loaded, loading, deleted, unloaded, newborn) instead of a number, if you prefer the number it’s in self.status

getType()

returns a word describing the type of the collection (edges or ducments) instead of a number, if you prefer the number it’s in self.type

classmethod hasField(fieldName)

returns True/False wether the collection has field K in it’s schema. Use the dot notation for the nested fields: address.street

load()

loads collection in memory

properties()

returns the current properties

restoreIndexes(indexes_dct=None)

restores all previously removed indexes

revision()

returns the current revision

simpleQuery(queryType, rawResults=False, **queryArgs)

General interface for simple queries. queryType can be something like ‘all’, ‘by-example’ etc… everything is in the arango doc. If rawResults, the query will return dictionaries instead of Document objetcs.

truncate()

deletes every document in the collection

unload()

unloads collection from memory

validatePrivate(field, value)

validate a private field value

class pyArango.collection.Edges(database, jsonData)

The default edge collection. All edge Collections must inherit from it

This one is meant to be called by the database

createEdge(initValues=None)

Create an edge populated with defaults

getEdges(vertex, inEdges=True, outEdges=True, rawResults=False)

returns in, out, or both edges liked to a given document. vertex can be either a Document object or a string for an _id. If rawResults a arango results will be return as fetched, if false, will return a liste of Edge objects

getInEdges(vertex, rawResults=False)

An alias for getEdges() that returns only the in Edges

getOutEdges(vertex, rawResults=False)

An alias for getEdges() that returns only the out Edges

classmethod validateField(fieldName, value)

checks if ‘value’ is valid for field ‘fieldName’. If the validation is unsuccessful, raises a SchemaViolation or a ValidationError. for nested dicts ex: {address : { street: xxx} }, fieldName can take the form address.street

class pyArango.collection.Field(validators=None, default=None)

The class for defining pyArango fields.

validators must be a list of validators. default can also be a callable

validate(value)

checks the validity of ‘value’ given the lits of validators

class pyArango.collection.DocumentCache(cacheSize)

Document cache for collection, with insert, deletes and updates in O(1)

delete(_key)

removes a document from the cache

getChain()

returns a list of keys representing the chain of documents

stringify()

a pretty str version of getChain()

class pyArango.collection.CachedDoc(document, prev, nextDoc)

A cached document

class pyArango.collection.Collection_metaclass

The metaclass that takes care of keeping a register of all collection types

classmethod getCollectionClass(name)

Return the class object of a collection given its ‘name’

classmethod isCollection(name)

return true or false wether ‘name’ is the name of collection.

classmethod isDocumentCollection(name)

return true or false wether ‘name’ is the name of a document collection.

classmethod isEdgeCollection(name)

return true or false wether ‘name’ is the name of an edge collection.

pyArango.collection.getCollectionClass(name)

return true or false wether ‘name’ is the name of collection.

pyArango.collection.isCollection(name)

return true or false wether ‘name’ is the name of a document collection.

pyArango.collection.isDocumentCollection(name)

return true or false wether ‘name’ is the name of a document collection.

pyArango.collection.isEdgeCollection(name)

return true or false wether ‘name’ is the name of an edge collection.

pyArango.collection.getCollectionClasses()

returns a dictionary of all defined collection classes