Files

Your files are stored in a _files system collection as a documents.

Total size of all files could be found in a project's status files_size property

Upload files

You can upload files using CLI:

deform document create -c users -d '{
    "_id": "september_vacation",
    "avatar": @"/var/files/vacation.png"
}'

Also you can use a python-deform:

from pydeform import Client
deform = Client(
    host='deform.io'
).auth(
    'token',
    'MYTOKEN',
    project_id='MYPROJECT'
)

resp = deform.document.save(
    collection='photos',
    data={
        "_id": "september_vacation",
        "avatar": open("/var/files/vacation.png", 'rb'),
    }
)

Now it's time to get uploaded file.

GET /api/collections/photos/documents/september_vacation/avatar/ will return you a JSON document

{
    "_id": "574c9a266dff87000562eaf6",
    "collection_id": "september_vacation",
    "content_type": "image/png",
    "date_created": "2016-05-31T19:53:10.43Z",
    "document_id": "574d48cf32d2c69274322585",
    "last_access": "2016-05-31T19:53:10.43Z",
    "md5": "a6a859273c133cdf168295a3b7d83a0f",
    "name": "vacation.png",
    "size": 3421
}

GET /api/collections/_files/documents/574c9a266dff87000562eaf6/ will return you the same

{
    "_id": "574c9a266dff87000562eaf6",
    "collection_id": "september_vacation",
    "content_type": "image/png",
    "date_created": "2016-05-31T19:53:10.43Z",
    "document_id": "574d48cf32d2c69274322585",
    "last_access": "2016-05-31T19:53:10.43Z",
    "md5": "a6a859273c133cdf168295a3b7d83a0f",
    "name": "vacation.png",
    "size": 3421
}

The difference is - you need to know _id of a file to access it while in _files collection.

Document and Content

Every file can be retrieved as JSON document and raw bytes.

/api/collections/_files/documents/<file_id>/ - JSON document
/api/collections/_files/documents/<file_id>/content/ - raw bytes
/api/collections/<collection_with_a_document>/documents/<document_id>/my/file/path/ - JSON document
/api/collections/<collection_with_a_document>/documents/<document_id>/my/file/path/content/ - raw bytes

File raw bytes

Want to get file's content - use the /content/ suffix.

Deform also supports file partial content.

File as JSON document

This is how the document will look like:

{
    "_id": "574c9a266dff87000562eaf6",
    "collection_id": "september_vacation",
    "content_type": "image/png",
    "date_created": "2016-05-31T19:53:10.43Z",
    "document_id": "574d48cf32d2c69274322585",
    "last_access": "2016-05-31T19:53:10.43Z",
    "md5": "a6a859273c133cdf168295a3b7d83a0f",
    "name": "vacation.png",
    "size": 3421
}

Property	Type	Description
_id	string	unique identity of the file
collection_id	string	identity of a collection file attached to
content_type	string	content-type of a file
date_created	datetime	date when the file was uploaded
document_id	string	identity of a document file attached to
last_access	datetime	date when the file was accessed
md5	string	md5 of a file's content
name	string	name of a file
size	integer	size of a file's content