PSPrefix

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCCore
__TOCDet/Description = Describes some recommended prefixes to use in a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe most important one is -dt- ("dt/") for data.0x000D0x000A0x000D0x000AOther examples are "doc/" for documentation "cmd/" for commands, "log/" for logging.0x000D0x000A0x000D0x000AIn -ARCAPI-, the Controllers -RQController- and -AddController- usually work against a top level structure identical to these prefixes, but there is no strict one-to-one mapping here.0x000D0x000A0x000D0x000A-dtr- is special and signifies that a whole record under "dt/" follows.0x000D0x000A0x000D0x000A-ARCEvent- supports -RS- (-RegStream-, Registration Stream) and -ES- (-EventStream-) in order to do 2D -EventSourcing- (with corresponding Controllers -RSController- and -ESController-).0x000D0x000A0x000D0x000AThese prefixes are not obligatory and not enforced by AgoRapide. Consider them as guidelines only.0x000D0x000ANaming is mimicking best practices used in for instance MQTT messaging.0x000D0x000A0x000D0x000ANote the general principle of containing application data, logging and documentation within the same data structure.0x000D0x000A
__TOCDet/DocFragType = Enum
__TOCDet/Name = PSPrefix
__TOCDet/Namespace = ARCCore
__TOCDet/Type = PSPrefix
__TOCDet/Attribute/AREnumType = OrdinaryEnum
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/Description = Describes some recommended prefixes to use in a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe most important one is -dt- ("dt/") for data.0x000D0x000A0x000D0x000AOther examples are "doc/" for documentation "cmd/" for commands, "log/" for logging.0x000D0x000A0x000D0x000AIn -ARCAPI-, the Controllers -RQController- and -AddController- usually work against a top level structure identical to these prefixes, but there is no strict one-to-one mapping here.0x000D0x000A0x000D0x000A-dtr- is special and signifies that a whole record under "dt/" follows.0x000D0x000A0x000D0x000A-ARCEvent- supports -RS- (-RegStream-, Registration Stream) and -ES- (-EventStream-) in order to do 2D -EventSourcing- (with corresponding Controllers -RSController- and -ESController-).0x000D0x000A0x000D0x000AThese prefixes are not obligatory and not enforced by AgoRapide. Consider them as guidelines only.0x000D0x000ANaming is mimicking best practices used in for instance MQTT messaging.0x000D0x000A0x000D0x000ANote the general principle of containing application data, logging and documentation within the same data structure.0x000D0x000A
__TOCDet/Attribute/EnumNamespace = ARCCore
__TOCDet/Attribute/EnumType = PSPrefix
app/__TOCDet/Assembly = ARCCore
app/__TOCDet/Description = Application state, like app/0x000D0x000A0x000D0x000AApplication state means the actual internal state of application, and also logging.0x000D0x000ASee -ExposingApplicationState-.0x000D0x000A0x000D0x000AThese data points are normally not read from disk at application initialization.0x000D0x000AThey can however normally be accessed from the in-memory data storage as the application progresses.0x000D0x000A0x000D0x000ANote that logging is kind of inbuilt in AgoRapide.0x000D0x000AThe -PropertyStream- / (-RegStream- if you use -ARCEvent-) 'is' the log and if you need to insert additional log0x000D0x000Ainformation they are just new properties to be added to the stream.0x000D0x000A0x000D0x000AA logging console is likewise just a -Client- which subscribes to the whole or part of the -PropertyStream- (for instance like Subscripton = 'as/*'). 0x000D0x000ANOTE: You could have as many log-consoles as you prefer (each with different subscriptions), in order to follow specific parts of the system.0x000D0x000A0x000D0x000AIn addition to the inbuilt log-characteristics of the -PropertyStream- you can insert additional application state data points through two main methods:0x000D0x000A0x000D0x000AMethod A) Call to -Log- (this can also be instructed to log to the local console). Note overloads to this methods encouraging you to supply a set of data-points (set of (key, values) tuples), instead of just some loose text.0x000D0x000ATODO. GIVE EXAMPLE OF THIS.0x000D0x000A0x000D0x000AMethod B) Use a class like -PConcurrent- with concept of -Logger-, this will log any changes to the class (especially useful for exposing -ExposingApplicationState-).0x000D0x000A0x000D0x000ASee also -Log-, -HandleException-, -ExposingApplicationState-.
app/__TOCDet/DocFragType = EnumMember
app/__TOCDet/Name = app
app/__TOCDet/Namespace = ARCCore
app/__TOCDet/Type = PSPrefix
app/__TOCDet/Attribute/Description = Application state, like app/0x000D0x000A0x000D0x000AApplication state means the actual internal state of application, and also logging.0x000D0x000ASee -ExposingApplicationState-.0x000D0x000A0x000D0x000AThese data points are normally not read from disk at application initialization.0x000D0x000AThey can however normally be accessed from the in-memory data storage as the application progresses.0x000D0x000A0x000D0x000ANote that logging is kind of inbuilt in AgoRapide.0x000D0x000AThe -PropertyStream- / (-RegStream- if you use -ARCEvent-) 'is' the log and if you need to insert additional log0x000D0x000Ainformation they are just new properties to be added to the stream.0x000D0x000A0x000D0x000AA logging console is likewise just a -Client- which subscribes to the whole or part of the -PropertyStream- (for instance like Subscripton = 'as/*'). 0x000D0x000ANOTE: You could have as many log-consoles as you prefer (each with different subscriptions), in order to follow specific parts of the system.0x000D0x000A0x000D0x000AIn addition to the inbuilt log-characteristics of the -PropertyStream- you can insert additional application state data points through two main methods:0x000D0x000A0x000D0x000AMethod A) Call to -Log- (this can also be instructed to log to the local console). Note overloads to this methods encouraging you to supply a set of data-points (set of (key, values) tuples), instead of just some loose text.0x000D0x000ATODO. GIVE EXAMPLE OF THIS.0x000D0x000A0x000D0x000AMethod B) Use a class like -PConcurrent- with concept of -Logger-, this will log any changes to the class (especially useful for exposing -ExposingApplicationState-).0x000D0x000A0x000D0x000ASee also -Log-, -HandleException-, -ExposingApplicationState-.
app/__TOCDet/Attribute/EnumMember = app
app/__TOCDet/Attribute/EnumType = PSPrefix
cmd/__TOCDet/Assembly = ARCCore
cmd/__TOCDet/Description = Command.0x000D0x000A0x000D0x000ASee in -ARCEvent- -Cmd-, -ICmdHandler- and -CmdController-.0x000D0x000A0x000D0x000AExample: "cmd/Device/42/TurnOn".0x000D0x000A
cmd/__TOCDet/DocFragType = EnumMember
cmd/__TOCDet/Name = cmd
cmd/__TOCDet/Namespace = ARCCore
cmd/__TOCDet/Type = PSPrefix
cmd/__TOCDet/Attribute/Description = Command.0x000D0x000A0x000D0x000ASee in -ARCEvent- -Cmd-, -ICmdHandler- and -CmdController-.0x000D0x000A0x000D0x000AExample: "cmd/Device/42/TurnOn".0x000D0x000A
cmd/__TOCDet/Attribute/EnumMember = cmd
cmd/__TOCDet/Attribute/EnumType = PSPrefix
doc/__TOCDet/Assembly = ARCCore
doc/__TOCDet/Description = Documentation.0x000D0x000A0x000D0x000AExample: "doc/toc" for Documentation Table of Contents.0x000D0x000AExample, full URL: "http://arnorthwind.agorapide.com/RQ/doc/toc ".0x000D0x000A0x000D0x000ANote: Documentation is usually generated on the fly at application startup and not persisted to disk.0x000D0x000A0x000D0x000ASee also -LinkInsertionInDocumentation-.
doc/__TOCDet/DocFragType = EnumMember
doc/__TOCDet/Name = doc
doc/__TOCDet/Namespace = ARCCore
doc/__TOCDet/Type = PSPrefix
doc/__TOCDet/Attribute/Description = Documentation.0x000D0x000A0x000D0x000AExample: "doc/toc" for Documentation Table of Contents.0x000D0x000AExample, full URL: "http://arnorthwind.agorapide.com/RQ/doc/toc ".0x000D0x000A0x000D0x000ANote: Documentation is usually generated on the fly at application startup and not persisted to disk.0x000D0x000A0x000D0x000ASee also -LinkInsertionInDocumentation-.
doc/__TOCDet/Attribute/EnumMember = doc
doc/__TOCDet/Attribute/EnumType = PSPrefix
dt/__TOCDet/Assembly = ARCCore
dt/__TOCDet/Description = Data, single key + value.0x000D0x000A0x000D0x000AExample: "dt/Customer/42/FirstName = John".0x000D0x000A0x000D0x000AThis is the actual data that your application stores, that is entities like 'Customer', 'Order', 'Hub', 'Device' or rather single properties like 'FirstName', 'Quantity', 'NetworkId' or 'Temperature'.
dt/__TOCDet/DocFragType = EnumMember
dt/__TOCDet/Name = dt
dt/__TOCDet/Namespace = ARCCore
dt/__TOCDet/Type = PSPrefix
dt/__TOCDet/Attribute/Description = Data, single key + value.0x000D0x000A0x000D0x000AExample: "dt/Customer/42/FirstName = John".0x000D0x000A0x000D0x000AThis is the actual data that your application stores, that is entities like 'Customer', 'Order', 'Hub', 'Device' or rather single properties like 'FirstName', 'Quantity', 'NetworkId' or 'Temperature'.
dt/__TOCDet/Attribute/EnumMember = dt
dt/__TOCDet/Attribute/EnumType = PSPrefix
dtr/__TOCDet/Assembly = ARCCore
dtr/__TOCDet/Description = Data, whole records.0x000D0x000A0x000D0x000AExample: "dtr/Customer/42/John/Smith".0x000D0x000A0x000D0x000AThis will correspond to multiple lines of -dt-, for instance the example above would correspond to:0x000D0x000A  "dt/Customer/42/FirstName = John"0x000D0x000A  "dt/Customer/42/LastName = John"0x000D0x000A0x000D0x000AIn other words, 'dtr' is a more compact format with higher performance, but since the parsing relies on a given order in the corresponding schema it is more vulnerable against changes in the schema.0x000D0x000A0x000D0x000A'dtr' is understood by -TryParseDtr-.0x000D0x000A
dtr/__TOCDet/DocFragType = EnumMember
dtr/__TOCDet/Name = dtr
dtr/__TOCDet/Namespace = ARCCore
dtr/__TOCDet/Type = PSPrefix
dtr/__TOCDet/Attribute/Description = Data, whole records.0x000D0x000A0x000D0x000AExample: "dtr/Customer/42/John/Smith".0x000D0x000A0x000D0x000AThis will correspond to multiple lines of -dt-, for instance the example above would correspond to:0x000D0x000A  "dt/Customer/42/FirstName = John"0x000D0x000A  "dt/Customer/42/LastName = John"0x000D0x000A0x000D0x000AIn other words, 'dtr' is a more compact format with higher performance, but since the parsing relies on a given order in the corresponding schema it is more vulnerable against changes in the schema.0x000D0x000A0x000D0x000A'dtr' is understood by -TryParseDtr-.0x000D0x000A
dtr/__TOCDet/Attribute/EnumMember = dtr
dtr/__TOCDet/Attribute/EnumType = PSPrefix
ES/__TOCDet/Assembly = ARCCore
ES/__TOCDet/Description = ES = Event Stream (see -EventStream-).0x000D0x000A0x000D0x000ARelated to -ARCEvent- which implements 2D -EventSourcing-.0x000D0x000A0x000D0x000A
ES/__TOCDet/DocFragType = EnumMember
ES/__TOCDet/Name = ES
ES/__TOCDet/Namespace = ARCCore
ES/__TOCDet/Type = PSPrefix
ES/__TOCDet/Attribute/Description = ES = Event Stream (see -EventStream-).0x000D0x000A0x000D0x000ARelated to -ARCEvent- which implements 2D -EventSourcing-.0x000D0x000A0x000D0x000A
ES/__TOCDet/Attribute/EnumMember = ES
ES/__TOCDet/Attribute/EnumType = PSPrefix
RS/__TOCDet/Assembly = ARCCore
RS/__TOCDet/Description = RS = Registration Stream (see -RegStream-).0x000D0x000A0x000D0x000ARelated to -ARCEvent- which implements 2D -EventSourcing-.0x000D0x000A0x000D0x000AA -PropertyStreamLine- with this prefix should be parsed as an -IRegHandler- in -ARCEvent-.
RS/__TOCDet/DocFragType = EnumMember
RS/__TOCDet/Name = RS
RS/__TOCDet/Namespace = ARCCore
RS/__TOCDet/Type = PSPrefix
RS/__TOCDet/Attribute/Description = RS = Registration Stream (see -RegStream-).0x000D0x000A0x000D0x000ARelated to -ARCEvent- which implements 2D -EventSourcing-.0x000D0x000A0x000D0x000AA -PropertyStreamLine- with this prefix should be parsed as an -IRegHandler- in -ARCEvent-.
RS/__TOCDet/Attribute/EnumMember = RS
RS/__TOCDet/Attribute/EnumType = PSPrefix
t/__TOCDet/Assembly = ARCCore
t/__TOCDet/Description = Translations.0x000D0x000A0x000D0x000AExample: "t/de_DE/Car/Wagen"0x000D0x000A0x000D0x000ASee also -Translations- and -TranslationSingle- in -ARCQuery-.0x000D0x000A
t/__TOCDet/DocFragType = EnumMember
t/__TOCDet/Name = t
t/__TOCDet/Namespace = ARCCore
t/__TOCDet/Type = PSPrefix
t/__TOCDet/Attribute/Description = Translations.0x000D0x000A0x000D0x000AExample: "t/de_DE/Car/Wagen"0x000D0x000A0x000D0x000ASee also -Translations- and -TranslationSingle- in -ARCQuery-.0x000D0x000A
t/__TOCDet/Attribute/EnumMember = t
t/__TOCDet/Attribute/EnumType = PSPrefix

Edit single sub keys only: __TOCDet / app / cmd / doc / dt / dtr / ES / RS / t

Generated 2025-04-19 12:46:34.702 UTC