StorageQuery#

class scikitplot.corpus.StorageQuery(input_path=None, source_type=None, language=None, section_type=None, collection_id=None, parent_doc_id=None, full_text=None, limit=100, offset=0)[source]#

Query parameters for StorageBase.query.

Parameters:
input_pathstr or None, optional

Filter to documents from this source file. Default: None (all).

source_typestr or None, optional

Filter to documents with this source_type value. Default: None.

languagestr or None, optional

Filter by ISO 639-1 language code. Default: None.

section_typestr or None, optional

Filter by SectionType value string. Default: None.

collection_idstr or None, optional

Filter by corpus collection identifier. Default: None.

parent_doc_idstr or None, optional

Filter to the direct children of this doc_id. Without this the document hierarchy was recorded but unqueryable – “give me the children of X” was inexpressible (finding F-R08-02). Default: None.

full_textstr or None, optional

Full-text search string. Supported by SQLiteStorage (FTS5) only; ignored by InMemoryStorage and JSONLStorage. Default: None.

limitint, optional

Maximum number of results to return. Default: 100.

offsetint, optional

Zero-based result offset for pagination. Default: 0.

Parameters:

  • input_path (str | None)

  • source_type (str | None)

  • language (str | None)

  • section_type (str | None)

  • collection_id (str | None)

  • parent_doc_id (str | None)

  • full_text (str | None)

  • limit (int)

  • offset (int)

collection_id: str | None = None#
full_text: str | None = None#
input_path: str | None = None#
language: str | None = None#
limit: int = 100#
offset: int = 0#
parent_doc_id: str | None = None#
section_type: str | None = None#
source_type: str | None = None#