Skip to content

Storage

Bases: Component

Storage Definitions

Storage Name [ Keywords ]
{
    Definition
}

Should usually not be used unless a custom storage definition is needed.

definition = ''

XML storage definition as string or list of string.

XML storage definition syntax is not supported by this library and should be used in conjunction with a XML library.

keywords = field(default_factory=dict, kw_only=True)

Storage Keywords

Optional dict used to specify keywords for this component.

Use {"Keyword": None} for keywords that do not have a value

Valid Storage keywords
  • DataLocation – Specifies where data is stored for this class.
  • DefaultData – Specifies the default data storage definition.
  • Final – Specifies that the storage definition cannot be modified by subclasses.
  • IdFunction – Specifies the system function to be used to assign new ID values for a persistent class using default storage.
  • IdLocation – Specifies location of the ID counter.
  • IndexLocation – Specifies the default storage location for indexes.
  • SqlRowIdName – Specifies the name used for the row ID within SQL.
  • SqlRowIdProperty – Specifies the SQL RowId property.
  • SqlTableNumber – Specifies the internal SQL table number.
  • State – Specifies the data definition used for a serial object.
  • StreamLocation – Specifies the default storage location for stream properties.
  • Type – Storage class used to provide persistence.

name = 'Default'

Name of the Objectscript component

"Default" for Storage components by default