.. testsetup::

    from arango import create

    c = create(db="test")
    c.database.create()
    c.test.delete()
    c.test.create()

.. _documents:

Documents
---------

Documents in ArangoDB are JSON objects. These objects can be nested (to any depth) and may contains lists. Each document is unique identified by its document handle.

Usage example:

.. testcode::

    from arango import create

    # connection & collection `test`
    c = create(db="test")
    c.database.create()  # make sure database exists
    c.test.create()

    # create document
    document = c.test.documents.create({
        "sample_key": "sample_value"
    })

    assert document.get("sample_key") == "sample_value"

    assert c.test.documents().count != 0


.. _documents proxy:

Documents for Collection instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Documents are accessible via collection instance for example ``connection.collection.sample_collection.documents``. Usually this expressions looks lot shorter.

Basically via `documents` shortcut accessible **Docuemnts Proxy** - Proxy object which have several shortcuts and produce ``Resultset`` object.

Below described basic method within ``Documents`` proxy:

.. autoclass:: arango.document.Documents
    :members: create, create_bulk, delete, update, count, load



.. _document:

Document
~~~~~~~~

Document instance methods consist of basic **CRUD** methods and several
convience functions that act as shortcuts for more convenient work with documents.

.. autoclass:: arango.document.Document
    :members: id, rev,
              create, update, delete, save,
              body, get