Package ghidra.features.bsim.query.client

Class PostgresFunctionDatabase

java.lang.Object

ghidra.features.bsim.query.client.AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

ghidra.features.bsim.query.client.PostgresFunctionDatabase

All Implemented Interfaces:

FunctionDatabase, SQLFunctionDatabase, AutoCloseable

public final class PostgresFunctionDatabase
extends AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Defines the BSim FunctionDatabase backed by a PostgreSQL database. Simple, one-column tables that only contain string data use the SQLStringTable class and are defined in this class. More complex tables are defined in their own classes in the ghidra.features.bsim.query.client.tables package.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.features.bsim.query.FunctionDatabase

FunctionDatabase.BSimError, FunctionDatabase.ConnectionType, FunctionDatabase.DatabaseNonFatalException, FunctionDatabase.ErrorCategory, FunctionDatabase.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LAYOUT_VERSION

Fields inherited from class ghidra.features.bsim.query.client.AbstractSQLFunctionDatabase

ds, JAVA_TIME_FORMAT, SQL_TIME_FORMAT, supportedLayoutVersion, vectorFactory

Constructor Summary

Constructors

Constructor	Description
PostgresFunctionDatabase(URL postgresUrl, boolean async)

Method Summary

Modifier and Type	Method	Description
void	close()	Close down (the connection with) the database
protected void	createDatabase(Configuration config)	Generate tables and initialize state for a new database.
protected int	deleteVectors(long id, int countdiff)	Low level count decrement of a vector record from vectable, if count reaches zero, the record is deleted
QueryResponseRecord	doQuery(BSimQuery<?> query, Connection c)
protected void	dropDatabase()	Drop this database
String	formatBitAndSQL(String v1, String v2)	Generate SQL bitwise-and syntax for use in database query WHERE clause
protected void	generateRawDatabase()	Generate new empty database which corresponds to AbstractSQLFunctionDatabase.ds.
String	getUserName()
protected void	initializeDatabase(Configuration config)	Initialize table state and config from existing database.
protected void	lockTablesForWrite()	Obtain an exclusive lock on the main tables.
protected void	queryNearestVector(QueryNearestVector query)	Perform nearest vector query based upon specified query which contains response record which should be filled-in with search results.
protected int	queryNearestVector(List<VectorResult> resultset, LSHVector vec, double simthresh, double sigthresh, int max)
protected VectorResult	queryVectorId(long id)
protected long	storeSignatureRecord(SignatureRecord sigrec)	Make sure the vector corresponding to the SignatureRecord is inserted into the vectable

Methods inherited from class ghidra.features.bsim.query.client.AbstractSQLFunctionDatabase

appendEscapedLiteral, beginTransaction, closing, compareLayout, convertDescriptionRows, endTransaction, getConnectionType, getFunctionTags, getInfo, getLastError, getLSHVectorFactory, getServerInfo, getStatus, getURLString, initConnection, initialize, query, queryFunctions, retrieveFuncDescFromVectors, setConnectionOnTables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ghidra.features.bsim.query.FunctionDatabase

changePassword, getOverviewFunctionsPerStage, getQueriedFunctionsPerStage, isPasswordChangeAllowed

Field Details

LAYOUT_VERSION

public static final int LAYOUT_VERSION

See Also:

• Constant Field Values

Constructor Details

PostgresFunctionDatabase

public PostgresFunctionDatabase(URL postgresUrl,
 boolean async)

Method Details

close

public void close()

Description copied from interface: FunctionDatabase

Close down (the connection with) the database

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FunctionDatabase

Overrides:

close in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

lockTablesForWrite

protected void lockTablesForWrite()
                           throws SQLException

Obtain an exclusive lock on the main tables. To be used when INSERTING, DELETING, or UPDATING to prevent concurrent changes to the tables.

Overrides:

lockTablesForWrite in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Throws:

SQLException - if the server reports an error

initializeDatabase

protected void initializeDatabase(Configuration config)
                           throws SQLException

Description copied from class: AbstractSQLFunctionDatabase

Initialize table state and config from existing database. NOTE: it is left to specific implementation to override this method to properly initialize default config.weightfactory and config.idflookup .

Overrides:

initializeDatabase in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

config - the database configuration

Throws:

SQLException - if there is a problem opening the database connection

generateRawDatabase

protected void generateRawDatabase()
                            throws SQLException

Description copied from class: AbstractSQLFunctionDatabase

Generate new empty database which corresponds to AbstractSQLFunctionDatabase.ds. A new connection may be used to the default database so that a new database may be created.

Specified by:

generateRawDatabase in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Throws:

SQLException - if an error occurs while creating the database

createDatabase

protected void createDatabase(Configuration config)
                       throws SQLException

Description copied from class: AbstractSQLFunctionDatabase

Generate tables and initialize state for a new database.

Overrides:

createDatabase in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

config - the database configuration

Throws:

SQLException - if there is aproblem opening a connectino to the database

dropDatabase

protected void dropDatabase()
                     throws SQLException

Description copied from class: AbstractSQLFunctionDatabase

Drop this database

Specified by:

dropDatabase in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Throws:

SQLException - if a database error occured

storeSignatureRecord

protected long storeSignatureRecord(SignatureRecord sigrec)
                             throws SQLException

Make sure the vector corresponding to the SignatureRecord is inserted into the vectable

Specified by:

storeSignatureRecord in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

sigrec - is the SignatureRecord

Returns:

the computed id of the vector

Throws:

SQLException - if there is a problem creating or executing the query

deleteVectors

protected int deleteVectors(long id,
 int countdiff)
                     throws SQLException

Low level count decrement of a vector record from vectable, if count reaches zero, the record is deleted

Specified by:

deleteVectors in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

id - vector row ID

countdiff - the amount to subtract from count

Returns:

0 if decrement short of 0, return 1 if record was removed, return -1 if there was a problem

Throws:

SQLException - if there is a problem creating or executing the query

queryNearestVector

protected int queryNearestVector(List<VectorResult> resultset,
 LSHVector vec,
 double simthresh,
 double sigthresh,
 int max)
                          throws SQLException

Specified by:

queryNearestVector in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

resultset - the list of result set objects to populate

vec - the vector containing the saveSQL query statement

simthresh - the similarity threshold

sigthresh - the confidence threshold

max - the max number of results to return

Returns:

the number of results returned

Throws:

SQLException - if there is a problem creating or executing the query

queryNearestVector

protected void queryNearestVector(QueryNearestVector query)
                           throws SQLException

Description copied from class: AbstractSQLFunctionDatabase

Perform nearest vector query based upon specified query which contains response record which should be filled-in with search results.

Specified by:

queryNearestVector in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

query - the nearest vector query to perform

Throws:

SQLException - if there is an error issuing the query

queryVectorId

protected VectorResult queryVectorId(long id)
                              throws SQLException

Specified by:

queryVectorId in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Parameters:

id - the vector id

Returns:

the vector result

Throws:

SQLException - if there is a problem creating or executing the query

getUserName

public String getUserName()

Specified by:

getUserName in interface FunctionDatabase

Overrides:

getUserName in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Returns:

username (being used to establish connection)

doQuery

public QueryResponseRecord doQuery(BSimQuery<?> query,
 Connection c)
                            throws SQLException,
LSHException,
FunctionDatabase.DatabaseNonFatalException

Overrides:

doQuery in class AbstractSQLFunctionDatabase<WeightedLSHCosineVectorFactory>

Throws:

SQLException

LSHException

FunctionDatabase.DatabaseNonFatalException

formatBitAndSQL

public String formatBitAndSQL(String v1,
 String v2)

Description copied from interface: SQLFunctionDatabase

Generate SQL bitwise-and syntax for use in database query WHERE clause

Parameters:

v1 - first value

v2 - second value

Returns:

SQL