¶ Database
The database is responsible for keeping track of sentences, entity mentions, and entity indices.
¶ Features
- CRUD (Create, Read, Update, Delete) Operations supported.
- Uses SQLite.
- Seeds the database with required tables if they do not exist.
¶ Overview
The database contains the following tables:
¶ sentence
Contains each sentence from all input text. Has a unique sid.
¶ entitymention
Represents each entity mention from all input text. Has sid as foreign key (a sentence must exist for the entitymention to exist).
¶ EntityIndex
Used by the Entity Linker to find potential matches for a given entity mention. See Entity Linker Docs for more information.
¶ Methods
async def InitializeIndexDB(dbPath):
¶ Parameters:
- dbPath (str): A path where the database will be stored / is stored, ie.
some/path/to/a/Database/directory.
async def Insert(dbPath, tableName, queryInformation):
¶ Parameters:
- dbPath (str): A path where the database will be stored / is stored, ie.
some/path/to/a/Database/directory. - tableName (str): The name of the table you want to insert into, available ones can be found in Overview.
- queryInformation (JSON): A JSON object containing the key-value pairs you want to insert, for example:
{
"fileName": "article.txt",
"string": "A duck walked across the road",
"startindex": 20,
"endIndex": 29
}
Would be a valid insert in the sentence table.
NOTE: The
sidis autogenerated usingAUTOINCREMENT.
async def Read(dbPath, tableName, searchPred=""):
¶ Parameters:
- dbPath (str): A path where the database will be stored / is stored, ie.
some/path/to/a/Database/directory. - tableName (str): The name of the table you want to insert into, available ones can be found in Overview.
- The search predicate to query the table with, for example if
searchPred=Jonesand thetableName=entitymention, the entitymention table will be searched forJones.
async def Update(dbPath, tableName, indexID, updatedName):
¶ Parameters:
- dbPath (str): A path where the database will be stored / is stored, ie.
some/path/to/a/Database/directory. - tableName (str): The name of the table you want to insert into, available ones can be found in Overview.
- indexID (str): The
sid,eidorid(EntityIndex) to update. - updatedName (str): What the
string,mentionornameshould be updated to.
async def Delete(dbPath, tableName, indexID):
¶ Parameters:
- dbPath (str): A path where the database will be stored / is stored, ie.
some/path/to/a/Database/directory. - tableName (str): The name of the table you want to insert into, available ones can be found in Overview.
- indexID (str): The
sid,eidorid(EntityIndex) to delete.