colrev.env.local_index_sqlite.SQLiteIndexTOC

class colrev.env.local_index_sqlite.SQLiteIndexTOC(*, reinitialize=False)

Bases: SQLiteIndex

The SQLiteIndexTOC class implements indexing and retrieval of TOC items locally

Methods

add	Add TOC items to the index
commit	Commit changes to the SQLITE database
exists	Check if TOC item exists in the index
get_toc_items	Get TOC items from the index

Attributes

CREATE_TABLE_QUERY
INDEX_NAME
INSERT_MANY_QUERY
KEYS
SELECT_ALL_QUERY
SELECT_KEY_QUERY
connection

add(toc_to_index)

Add TOC items to the index

Return type:

None

commit()

Commit changes to the SQLITE database

Return type:

None

exists(toc_item)

Check if TOC item exists in the index

Return type:

bool

get_toc_items(toc_key='', partial_toc_key='')

Get TOC items from the index

Return type:

list