Database context

class luna_handlers.db.context.DBContext(logger)

Handlers DB context.

async checkVerifier(verifierId, accountId=None)

Check verifier existence :param verifierId: verifier id :param accountId: account id

Returns:

True - if verifier exists, otherwise False

Return type:

bool

async createHandler(policies, accountId, description='', isDynamic=False)

Create new handler.

Parameters:

• policies – set handler policies

• accountId – account id

• description – user handler description

• isDynamic – dynamic handler flag

Returns:

handler id

Return type:

str

async createVerifier(policies, accountId, description='')

Create new verifier.

Parameters:

• policies – verifier policies

• accountId – account id

• description – user verifier description

Returns:

verifier id

Return type:

str

async deleteHandler(handlerId, accountId=None)

Delete handler by id

Parameters:

• handlerId – handler id

• accountId – account id of the handler

Returns:

True if handler exist otherwise false

Return type:

bool

async deleteVerifier(verifierId, accountId=None)

Delete verifier by id

Parameters:

• verifierId – verifier id

• accountId – account id

Returns:

True if verifier deleted, otherwise False

Return type:

bool

async doesHandlerExist(handlerId, accountId=None)

Check a account handler with id=handlerId existence :param handlerId: handler id :param accountId: handler account id

Returns:

true - if handler is exist otherwise false

Return type:

bool

async getAbsentHandlersIds(handlerIds)

Given list of handlerIds, return those handlerIds that were removed from database.

Used for removal of items from cache by cache invalidator.

Parameters:

handlerIds – handler ids

Returns:

List with handlersIds that were removed.

Return type:

List[str]

async getHandler(handlerId, targets=(HandlerTarget.handlerId, HandlerTarget.accountId, HandlerTarget.createTime, HandlerTarget.lastUpdateTime, HandlerTarget.description, HandlerTarget.policies, HandlerTarget.isDynamic), accountId=None)

Get handler by id :param handlerId: handler id :param accountId: handler account id :param targets: handler targets

Returns:

deserialize dict with handler

Raises:

VLException(Error.HandlerNotFound.format(handlerId), 404, isCriticalError=False) – if handler not found

Return type:

dict

async getHandlerCount(accountId=None, description=None, isDynamic=None)

Get handler count

Parameters:

• accountId – handler account id

• description – handler description

• isDynamic – whether to get only dynamic (non-dynamic) handlers

Returns:

handler count

async getHandlers(accountId=None, description=None, isDynamic=None, page=1, pageSize=100)

Get handlers by filters

Parameters:

• accountId – handler account id

• description – handler description

• isDynamic – whether to get only dynamic (non-dynamic) handlers

• page – page

• pageSize – page size

Returns:

list of deserialize handlers

Return type:

List[dict]

async getUpdatedHandlers(handlerIds, lastUpdateTimeGte, targets=None)

Get updated handlers by ids. Used for cache invalidation.

Parameters:

• handlerIds – handler ids

• lastUpdateTimeGte – lower bound of handler update time

• targets – handler targets

Returns:

List with handlers

Return type:

List[Dict]

async getVerifier(verifierId, accountId=None)

Get verifier by id :param verifierId: verifier id :param accountId: verifier account id

Returns:

deserialized dict with verifier

Raises:

VLException(Error.VerifierNotFound.format(verifierId), 404, isCriticalError=False) – if verifier not found

Return type:

Dict

async getVerifierCount(accountId=None, description=None)

Get verifier count

Parameters:

• accountId – account id

• description – verifier description

Returns:

verifier count

async getVerifiers(accountId=None, description=None, page=1, pageSize=100)

Get verifiers by filters

Parameters:

• accountId – account id

• description – verifier description

• page – page

• pageSize – page size

Returns:

list of verifiers

Return type:

List[dict]

loadHandlerFromRow(handlerRow, selectColumns)

Load handler as dict from raw row.

Parameters:

• handlerRow – full row from db

• selectColumns – columns from sql query

Returns:

handler as dict

Return type:

dict[str, Any]

loadVerifierFromRow(verifierRow)

Load verifier as dict from raw row.

Parameters:

verifierRow – full row from db

Returns:

verifier as dict

Return type:

Dict[str, Any]

async putHandler(handlerId, policies, accountId, description='', isDynamic=False)

Put handler instead old handler.

Parameters:

• handlerId – handler

• policies – set handler policies

• accountId – account id

• description – user handler description

• isDynamic – dynamic handler flag

Warning

function does not create handler!

Returns:

True if handler exist otherwise false

Return type:

bool

async putVerifier(verifierId, policies, accountId, description='')

Replace verifier by id.

Parameters:

• verifierId – verifier id

• policies – verifier policies

• accountId – account id

• description – user verifier description

Warning

function does not create verifier!

Returns:

verifier current version if verifier replaced

Return type:

Optional[int, None]