6.117. sibl_gui.components.core.database.operations

operations.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines Application Database operations objects.

Others:

6.117.1. Module Attributes

sibl_gui.components.core.database.operations.LOGGER
sibl_gui.components.core.database.operations.DATABASE_EXCEPTIONS
sibl_gui.components.core.database.operations.DEFAULT_SESSION_MAKER
sibl_gui.components.core.database.operations.DEFAULT_SESSION

6.117.2. Functions

sibl_gui.components.core.database.operations.createSession()[source]

This definition creates a default session.

Returns:Database session. ( Session )
sibl_gui.components.core.database.operations.getSession(session=None)[source]

This definition returns either given session or the default one.

Parameters:session – Database session. ( Session )
Returns:Database session. ( Session )
sibl_gui.components.core.database.operations.query(*args, **kwargs)[source]

This definition queries given session or the default one.

Parameters:
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
Returns:

Query result. ( Object )

sibl_gui.components.core.database.operations.commit(session=None)[source]

This definition commits changes to the Database.

Parameters:session – Database session. ( Session )
Returns:Database commit success. ( Boolean )
sibl_gui.components.core.database.operations.addItem(item, session=None)[source]

This definition adds an item to the Database.

Parameters:
  • item – Item to add. ( Database object )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.addStandardItem(type, name, path, collection, session=None)[source]

This definition adds a new standard item to the Database.

Parameters:
  • type – Item type. ( Object )
  • name – Item name. ( String )
  • path – Item path. ( String )
  • collection – Collection id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.removeItem(item, session=None)[source]

This definition removes an item from the Database.

Parameters:
  • item – Item to remove. ( Database object )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.removeStandardItem(type, identity, session=None)[source]

This definition removes a standard item from the Database.

Parameters:
  • type – Item type. ( Object )
  • identity – Item id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateItemContent(item, session=None)[source]

This definition update an item content.

Parameters:
  • item – Item to set content. ( IblSet )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateItemLocation(item, path, session=None)[source]

This definition updates an item location.

Parameters:
  • item – Item to update. ( Object )
  • path – Item path. ( Path )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.filterItems(items, pattern, field, flags=0)[source]

This definition filters items from the Database.

Parameters:
  • items – Database items. ( List )
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
Returns:

Filtered items. ( List )

sibl_gui.components.core.database.operations.itemExists(items, pattern, field, flags=0)[source]

This definition returns if given item exists in the Database.

Parameters:
  • items – Database items. ( List )
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
Returns:

Filtered items. ( List )

sibl_gui.components.core.database.operations.getIblSets(session=None)[source]

This definition returns the Ibl Sets from the Database.

Parameters:session – Database session. ( Session )
Returns:Database Ibl Sets. ( List )
sibl_gui.components.core.database.operations.filterIblSets(pattern, field, flags=0, session=None)[source]

This definition filters the sets from the Database.

Parameters:
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Ibl Sets. ( List )

sibl_gui.components.core.database.operations.iblSetExists(path, session=None)[source]

This method returns if given Ibl Set exists in the Database.

Parameters:
  • name – Ibl Set path. ( String )
  • session – Database session. ( Session )
Returns:

Ibl Set exists. ( Boolean )

sibl_gui.components.core.database.operations.addIblSet(name, path, collection, session=None)[source]

This definition adds a new Ibl Set to the Database.

Parameters:
  • name – Ibl Set name. ( String )
  • path – Ibl Set path. ( String )
  • collection – Collection id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.removeIblSet(identity, session=None)[source]

This definition removes an Ibl Set from the Database.

Parameters:
  • identity – Ibl Set id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateIblSetContent(iblSet, session=None)[source]

This definition update an Ibl Set content.

Parameters:
  • iblSet – Ibl Set to set content. ( IblSet )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateIblSetLocation(iblSet, path, session=None)[source]

This definition updates an Ibl Set location.

Parameters:
  • iblSet – Ibl Set to update. ( IblSet )
  • path – Ibl Set path. ( Path )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.checkIblSetsTableIntegrity(session=None)[source]

This definition checks sets table integrity.

Parameters:session – Database session. ( Session )
Returns:Ibl Sets table erroneous items. ( Dictionary )
sibl_gui.components.core.database.operations.getCollections(session=None)[source]

This definition returns the Collections from the Database.

Parameters:session – Database session. ( Session )
Returns:Database Collections. ( List )
sibl_gui.components.core.database.operations.filterCollections(pattern, field, flags=0, session=None)[source]

This definition filters the Collections from the Database.

Parameters:
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Collections. ( List )

sibl_gui.components.core.database.operations.getCollectionsByType(type, session=None)[source]

This method returns Collections of given type.

Parameters:
  • type – Type name. ( String )
  • session – Database session. ( Session )
Returns:

Ibl Sets Collections. ( List )

sibl_gui.components.core.database.operations.filterCollectionsByType(type, pattern, field, flags=0, session=None)[source]

This definition filters the Ibl Sets Collections from the Database.

Parameters:
  • type – Type name. ( String )
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Collections. ( List )

sibl_gui.components.core.database.operations.filterIblSetsCollections(pattern, field, flags=0, session=None)[source]

This definition filters the Ibl Sets Collections from the Database.

Parameters:
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Collections. ( List )

sibl_gui.components.core.database.operations.filterTemplatesCollections(pattern, field, flags=0, session=None)[source]

This definition filters the Templates Collections from the Database.

Parameters:
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Collections. ( List )

sibl_gui.components.core.database.operations.collectionExists(name, session=None)[source]

This method returns if the Collection exists in the Database.

Parameters:
  • name – Collection name. ( String )
  • session – Database session. ( Session )
Returns:

Collection exists. ( Boolean )

sibl_gui.components.core.database.operations.addCollection(collection, type, comment, session=None)[source]

This definition adds a Collection to the Database.

Parameters:
  • collection – Collection name. ( String )
  • type – Collection type. ( String )
  • comment – Collection comment. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.removeCollection(identity, session=None)[source]

This definition removes a Collection from the Database.

Parameters:
  • identity – Collection id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.getCollectionsIblSets(identities, session=None)[source]

This definition returns Ibl Sets from Collections ids

Parameters:
  • identities – Collections ids. ( List )
  • session – Database session. ( Session )
Returns:

Ibl Sets list. ( List )

sibl_gui.components.core.database.operations.getCollectionIblSetsCount(collection, session=None)[source]

This method returns given Collection Ibl Sets count.

Parameters:
  • collection – Collection. ( Collection )
  • session – Database session. ( Session )
Returns:

Collection Ibl Sets count. ( Integer )

sibl_gui.components.core.database.operations.getCollectionTemplatesCount(collection, session=None)[source]

This method returns given Collection Tempates count.

Parameters:
  • collection – Collection. ( Collection )
  • session – Database session. ( Session )
Returns:

Collection Templates count. ( Integer )

sibl_gui.components.core.database.operations.getTemplates(session=None)[source]

This definition returns the Templates from the Database.

Parameters:session – Database session. ( Session )
Returns:Database Templates. ( List )
sibl_gui.components.core.database.operations.filterTemplates(pattern, field, flags=0, session=None)[source]

This definition filters the Templates from the Database.

Parameters:
  • pattern – Filtering pattern. ( String )
  • field – Database field to search into. ( String )
  • flags – Flags passed to the regex engine. ( Integer )
  • session – Database session. ( Session )
Returns:

Filtered Templates. ( List )

sibl_gui.components.core.database.operations.templateExists(path, session=None)[source]

This method returns if given Template exists in the Database.

Parameters:
  • name – Template path. ( String )
  • session – Database session. ( Session )
Returns:

Template exists. ( Boolean )

sibl_gui.components.core.database.operations.addTemplate(name, path, collection, session=None)[source]

This definition adds a new Template to the Database.

Parameters:
  • name – Template name. ( String )
  • path – Template path. ( String )
  • collection – Collection id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.removeTemplate(identity, session=None)[source]

This definition removes a Template from the Database.

Parameters:
  • identity – Template id. ( String )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateTemplateContent(template, session=None)[source]

This definition update a Template content.

Parameters:
  • template – Template to Template content. ( Template )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.updateTemplateLocation(template, path, session=None)[source]

This definition updates a Template location.

Parameters:
  • template – Template to update. ( Template )
  • path – Template path. ( Path )
  • session – Database session. ( Session )
Returns:

Database commit success. ( Boolean )

sibl_gui.components.core.database.operations.checkTemplatesTableIntegrity(session=None)[source]

This definition checks Templates table integrity.

Parameters:session – Database session. ( Session )
Returns:Templates table erroneous items. ( Dictionary )