StorageProtocol#

class scikitplot.corpus.StorageProtocol(*args, **kwargs)[source]#

Structural interface every storage backend must satisfy.

delete(record_id)[source]#

Delete a record by its identifier.

Parameters:

record_idstr

Storage record ID.

Returns:

bool

True if the record existed and was deleted.

Parameters:

record_id (str)

Return type:

bool

get(record_id)[source]#

Retrieve a record by its identifier.

Parameters:

record_idstr

Storage record ID.

Returns:

CorpusRecord or None

None if no record with this ID exists.

Parameters:

record_id (str)

Return type:

CorpusRecord | None

save(record)[source]#

Persist a single CorpusRecord.

Parameters:

recordCorpusRecord

Record to persist.

Parameters:

record (CorpusRecord)

Return type:

None

save_batch(records)[source]#

Persist a batch of CorpusRecord objects.

Parameters:

recordslist[CorpusRecord]

Records to persist.

Parameters:

records (list[CorpusRecord])

Return type:

None

search(query)[source]#

Execute a retrieval query against this backend.

Parameters:

queryRetrievalQuery

Query specification.

Returns:

list[ChunkHit]

Ranked results.

Parameters:

query (RetrievalQuery)

Return type:

list[ChunkHit]