Skip to main content

Reference

 

OutSystems

DbCleaner API

Allows freeing-up database space.

Summary

Actions
Attribute_DropColumn Physically deletes the database table column associated to the specified entity attribute. If the entity attribute still exists in an module’s meta model, the delete operation will not be performed.
Attribute_ListDeleted Returns a list of attributes, with their information, that have been deleted from module’s meta model but are still physically present in the database.
Entity_DropTable Physically deletes the database table associated to the specified entity. If the entity still exists in an module’s meta model, the delete operation will not be performed.
Entity_ListDeleted Returns a list of entities, with their information, that have been deleted from module’s meta model but are still physically present in the database.
ModuleVersion_Delete Deletes the specified module version of the specified module from the database.
ModuleVersion_DeleteAll Deletes all module versions with a published date older than the specified value.
ModuleVersion_ListOldest Returns a list of the oldest module versions, with their definitions, that have been published in the past and are kept stored in the database. Currently published version and versions belonging to a tagged version of an application are not returned.
Structures
AttributeInfo Information about a specific entity attribute.
EntityInfo Information about a specific entity.
ModuleInfo Information about a specific module.
ModuleVersionInfo Information about a specific module version.
Static Entities
ModuleType Types of modules.

Actions

Attribute_DropColumn

Physically deletes the database table column associated to the specified entity attribute. If the entity attribute still exists in an module’s meta model, the delete operation will not be performed.

Inputs

AttributeId
Type: mandatory, Integer.
The attribute identifier.

Attribute_ListDeleted

Returns a list of attributes, with their information, that have been deleted from module’s meta model but are still physically present in the database.

Outputs

DeletedAttributes
Type: AttributeInfo List.
List of attributes, with their information, that have been deleted from module’s meta model.

Entity_DropTable

Physically deletes the database table associated to the specified entity. If the entity still exists in an module’s meta model, the delete operation will not be performed.

Inputs

EntityId
Type: mandatory, Integer.
The entity identifier.

Entity_ListDeleted

Returns a list of entities, with their information, that have been deleted from module’s meta model but are still physically present in the database.

Outputs

DeletedEntities
Type: EntityInfo List.
List of entities, with their information, that have been deleted from module’s meta model.

ModuleVersion_Delete

Deletes the specified module version of the specified module from the database.

Inputs

ModuleVersionId
Type: mandatory, Integer.
The module version identifier.
ModuleId
Type: mandatory, Integer.
The module identifier.

ModuleVersion_DeleteAll

Deletes module versions that were published before the specified date and time. This action does not delete the module version that is currently published nor module versions used in tagged versions of applications or solutions.

Inputs

OlderThan
Type: mandatory, Date Time.
Date and time that indicates the most recent point in time from which onward module versions are not to be deleted from the database.
ModuleId
Type: optional, Integer.
The module identifier. If not specified, returns module versions of all modules.
MaxNumberOfVersions
Type: optional, Integer.
The maximum number of versions to get. If not specified, returns the oldest 100 module versions. Set to 0 (zero) to get all the module versions.

Outputs

HasMoreVersions
Type: Boolean.
Returns True if there are still module versions to delete.

ModuleVersion_ListOldest

Returns a list of module versions that are stored in the database and that were published before the specified date and time. This action does not return the module version that is currently published nor module versions used in tagged versions of applications or solutions.

Inputs

OlderThan
Type: mandatory, Date Time.
Date and time that indicates the most recent point in time from which onward module versions are not to be deleted from the database.
ModuleName
Type: optional, Text.
The name of the module. If not specified, returns module versions of modules with any name.
ModuleTypeId
Type: optional, ModuleType Identifier.
The type of the module. If not specified, returns module versions of modules of any type.
MaxNumberOfVersions
Type: optional, Integer.
The maximum number of versions to get. If not specified, returns the oldest 100 module versions. Set to 0 (zero) to get all the module versions

Outputs

ModuleVersions
Type: ModuleVersionInfo List.
List of module versions, with their information, that have been published in the past and are kept stored in the database.
HasMoreVersions
Type: Boolean.
Returns True if there are more module versions than the ones listed.

Structures

AttributeInfo

Information about a specific entity attribute.

Attributes
Id
Type: Integer.
Attribute unique identifier
Name
Type: Text.
Name of the attribute
IsDeleted
Type: Boolean.
Indicates if the attribute was deleted
EntityInfo
Type: EntityInfo.
Information about the entity to which the attribute belongs

EntityInfo

Information about a specific entity.

Attributes
Id
Type: Integer.
Entity unique identifier
Name
Type: Text.
Name of the entity
IsDeleted
Type: Boolean.
Indicates if the entity was deleted
ModuleInfo
Type: ModuleInfo.
Information about the module to which the entity belongs

ModuleInfo

Information about a specific module.

Attributes
Id
Type: Integer.
Module unique identifier
Name
Type: Text.
Name of the module
IsDeleted
Type: Boolean.
Indicates if the module was deleted
ModuleTypeId
Type: ModuleType Identifier.
Module type identifier

ModuleVersionInfo

Information about a specific module version.

Attributes
Id
Type: Integer.
Module version unique identifier
Version
Type: Text.
Version number
UploadedDate
Type: Date Time.
Date and time when the version was uploaded to the server
LastPublishedDate
Type: Date Time.
Date and time of the last publish of the module version
ModuleInfo
Type: ModuleInfo.
Information about the module to which the module version belongs

Static Entities

ModuleType

Types of modules.

Attributes
Id
Type: Integer.
Label
Type: Text (50).
Records:
  • Extension
  • Espace
  • Was this article helpful?