docria.collection

I/O module, read/write collections of documents

Functions

build_msgpack_directory_fileindex(path, *props)

Construct a document index spanning over multiple docria files.

build_msgpack_fileindex(path, *props)

Construct a document index

get_codec(name[, no_except])

rtype

Optional[CompressionCodec]

register_codec(name, compress, decompress[, ...])

unregister_codec(name)

Classes

CompressionCodec(name, compress, decompress)

DocumentFileIndex(filepath, properties, docrefs)

In-memory index of a single docria file

DocumentIO()

DocumentIndex([basepath])

Multi-file in-memory index

DocumentReader(inputreader)

Utility reader, returns Docria documents.

MsgpackDocumentBlock(position, rawbuffer)

Represents a block of MessagePack docria documents

MsgpackDocumentIO()

MessagePack Document I/O class

MsgpackDocumentReader(inputio)

Reader for the blocked MessagePack document file format

MsgpackDocumentWriter(outputio[, ...])

Writer for the blocked MessagePack document file format

TarMsgpackReader(inputpath[, mode])

Reader for the tar-based sequential MessagePack format.

TarMsgpackWriter(outputpath[, docformat, ...])

Writer for the tar-based sequential MessagePack format.