BibDocFile API

The BibDocFile library handles every interaction relation between records and related fulltext document files.

Nomenclature

record

the unit of information within Invenio. It is constituted by all the MARC metadata and have unique integer called Record ID.

fulltext

is a physical file connected to a record and often described by the record it self.

bibdoc

is an abstract document related to a record. It has a unique docname within the record, and is linked with multiple format and revision of fulltext files.

format (or extension)

is the extension associated with a physical file. Within a bibdoc, for a given version it can exist at most one file with a given format (e.g. .gif, .jpeg...)

version (or revision)

a progressive integer associated with a fulltext. The higher, the recent. Usually previous versions of a file are hidden.

Python API

Given a record_id, BibRecDocs(record_id) will be an object useful to represent all the bibdocs connected to a record.

Given a record_id and a docname or a document_id, BibDoc(recid=record_id, docname=docname) or BibDoc(docid=document_id) will be an object useful to represent all the possible version and formats of a document connected to a record.

By properly querying BibRecDocs and BibDoc you can obtain a BibDocFile. This is an object representing all the possible details related a single physical file, like a comment, a description, the path, the related URL, the size, the format, the version, the checksum, the protection...

See bibdocfile API for a complete API description.