/ doc / tocNamespace / ARCCore / PropertyStreamLine

PropertyStreamLine

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 = Has two main functions:0x000D0x000A0x000D0x000A1) Encodes and decodes single lines in the -PropertyStream-.0x000D0x000ASee methods like -EncodeKeyPart-, -EncodeValuePart- and -Decode-.0x000D0x000A0x000D0x000A2) Stores single lines in the -PropertyStream- into a data-storage. See -TryStore-.0x000D0x000A0x000D0x000A3) Parses a collection of -PropertyStream- lines into a single -IP- instanse.0x000D0x000ASee methods like -TryParseDirectToIP-.0x000D0x000A0x000D0x000A4) Parses a single -PropertyStream- line into a single property.0x000D0x000ASee methods like -TryParseDirectToProperty-.0x000D0x000A0x000D0x000AA line consists of a key-part, the separator ' = ' (space, equals sign, space) and a value part.0x000D0x000A(the value part may be empty, see -PValueEmpty-).0x000D0x000A0x000D0x000AExamples are (syntax only approximate as of May 2020):0x000D0x000A'// This is a comment (lines starting with // are to be ignored in any processing0x000D0x000A'dt/Customer/42 (create new Customer object, actually this line is not necessary)0x000D0x000A'dt/Customer/42/Cid = User/43' (See -Cid-)0x000D0x000A'dt/Customer/42/FirstName = John'0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333' (create new PhoneNumber)0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333/Invalid' (Equivalent to 'delete', see -Invalid)0x000D0x000A0x000D0x000A'dt/Order/1968/CustomerId = Customer/42'0x000D0x000A0x000D0x000A'dt/OrderLine/2001/OrderId = 1968'0x000D0x000A'dt/OrderLine/2001/ProductId = 2003'0x000D0x000A'dt/OrderLine/2001/Quantity = 3'0x000D0x000A0x000D0x000A'dt/Product/2003/Name = Widget3'0x000D0x000A'dt/Product/2003/Colour = Red'0x000D0x000A0x000D0x000ANote that timestamps are normally not needed because the property stream is sequentially organised, and timestamps are inserted automatically (see -TimestampResolution-).0x000D0x000ASee -EncodeKeyPart- and -EncodeValuePart- for how data is actually encoded (examples given above are only indicative).0x000D0x000A0x000D0x000ANote that this class is static, that is, no instances if this class are ever created.0x000D0x000AInstead simple strings are used for representing property stream lines for transmission and storage. This is considered to be more efficient (less processing required) and take up less memory (especially for -CoreDB-).
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = FAQ: Is the property stream (and AgoRapide in general) strongly or weakly typed?0x000D0x000AThat is up to you.0x000D0x000AFor getting started, and just in order to experiment with some various data, you can start weakly typed, or just use strings everywhere.0x000D0x000AA standard storage like -PRich- and a generic -ARAAPI- built on top of that is not dependent on any pre-defined structure, it just accepts whatever is in the property stream.0x000D0x000AIn your C# code you can use multi-level indexing like this: 'DataStorage0x005B"Customer"0x005D0x005B"42"0x005D0x005B"FirstName"0x005D = "John"' without bothering about types at all (or just send the corresponding -PropertyStreamLine- 'dt/Customer/42/FirstName = John' to -TryParse-).0x000D0x000AAs your project matures and you see which classes and properties are more important, you can create the corresponding 'entity' classes and their -PropertyKeyEnum-, and specify more exact types for the properties.0x000D0x000ATaken into account concepts like -LinkInsertionInDocumentation- this will also constitute documenting your application.0x000D0x000ANote that though you can choose the level of dynamic typing (as shown), static strong typing is always a bit weaker with -PropertyAccess-. See -AssertTypeIntegrity- and -BoilerplateCodeProperties- for attempts at alleviating this.0x000D0x000A0x000D0x000AFAQ: How does the property stream format compare to the JSON format?0x000D0x000AThe short answer is that JSON is well suited when you want to transfer a whole object.0x000D0x000AIf you want to transfer parts of an object, for instance updating one single property, then the property stream format is better suited.0x000D0x000AA JSON representation of some given data points could be seen as a 'compiled' variant of the same data points stored as property stream lines.0x000D0x000AThis is because the original property stream lines for a given JSON representation may be spread out (not being located close to each other).0x000D0x000ANote however that if the actual property stream lines (for some given data points) reside consequently to each other in the data storage, then JSON would be a much more effective format for representation because it is much less verbose.0x000D0x000ATODO: Insert examples here in order to clarify.0x000D0x000A0x000D0x000ASome notes about compression:0x000D0x000ANote how the format used is somewhat verbose but well suited for on-disk compression.0x000D0x000AIt is for instance inefficient (storage-wise) to repeat the same context line after line.0x000D0x000ABut on the other hand, the underlying OS can easily be instructed to compress the storage files instead (something it should be able to do quite efficiently, leaving the size-issue to mostly constitute a network bandwidth problem.0x000D0x000ANote that some optimizations are performed anyway, see for instance -Timestamp- which describes how timestamps are not added to each and every property stream line but inserted as needed.0x000D0x000A0x000D0x000A
__TOCDet/Name = PropertyStreamLine
__TOCDet/Namespace = ARCCore
__TOCDet/Type = PropertyStreamLine
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = PropertyStreamLine
__TOCDet/Attribute/Description = Has two main functions:0x000D0x000A0x000D0x000A1) Encodes and decodes single lines in the -PropertyStream-.0x000D0x000ASee methods like -EncodeKeyPart-, -EncodeValuePart- and -Decode-.0x000D0x000A0x000D0x000A2) Stores single lines in the -PropertyStream- into a data-storage. See -TryStore-.0x000D0x000A0x000D0x000A3) Parses a collection of -PropertyStream- lines into a single -IP- instanse.0x000D0x000ASee methods like -TryParseDirectToIP-.0x000D0x000A0x000D0x000A4) Parses a single -PropertyStream- line into a single property.0x000D0x000ASee methods like -TryParseDirectToProperty-.0x000D0x000A0x000D0x000AA line consists of a key-part, the separator ' = ' (space, equals sign, space) and a value part.0x000D0x000A(the value part may be empty, see -PValueEmpty-).0x000D0x000A0x000D0x000AExamples are (syntax only approximate as of May 2020):0x000D0x000A'// This is a comment (lines starting with // are to be ignored in any processing0x000D0x000A'dt/Customer/42 (create new Customer object, actually this line is not necessary)0x000D0x000A'dt/Customer/42/Cid = User/43' (See -Cid-)0x000D0x000A'dt/Customer/42/FirstName = John'0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333' (create new PhoneNumber)0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333/Invalid' (Equivalent to 'delete', see -Invalid)0x000D0x000A0x000D0x000A'dt/Order/1968/CustomerId = Customer/42'0x000D0x000A0x000D0x000A'dt/OrderLine/2001/OrderId = 1968'0x000D0x000A'dt/OrderLine/2001/ProductId = 2003'0x000D0x000A'dt/OrderLine/2001/Quantity = 3'0x000D0x000A0x000D0x000A'dt/Product/2003/Name = Widget3'0x000D0x000A'dt/Product/2003/Colour = Red'0x000D0x000A0x000D0x000ANote that timestamps are normally not needed because the property stream is sequentially organised, and timestamps are inserted automatically (see -TimestampResolution-).0x000D0x000ASee -EncodeKeyPart- and -EncodeValuePart- for how data is actually encoded (examples given above are only indicative).0x000D0x000A0x000D0x000ANote that this class is static, that is, no instances if this class are ever created.0x000D0x000AInstead simple strings are used for representing property stream lines for transmission and storage. This is considered to be more efficient (less processing required) and take up less memory (especially for -CoreDB-).
__TOCDet/Attribute/LongDescription = FAQ: Is the property stream (and AgoRapide in general) strongly or weakly typed?0x000D0x000AThat is up to you.0x000D0x000AFor getting started, and just in order to experiment with some various data, you can start weakly typed, or just use strings everywhere.0x000D0x000AA standard storage like -PRich- and a generic -ARAAPI- built on top of that is not dependent on any pre-defined structure, it just accepts whatever is in the property stream.0x000D0x000AIn your C# code you can use multi-level indexing like this: 'DataStorage0x005B"Customer"0x005D0x005B"42"0x005D0x005B"FirstName"0x005D = "John"' without bothering about types at all (or just send the corresponding -PropertyStreamLine- 'dt/Customer/42/FirstName = John' to -TryParse-).0x000D0x000AAs your project matures and you see which classes and properties are more important, you can create the corresponding 'entity' classes and their -PropertyKeyEnum-, and specify more exact types for the properties.0x000D0x000ATaken into account concepts like -LinkInsertionInDocumentation- this will also constitute documenting your application.0x000D0x000ANote that though you can choose the level of dynamic typing (as shown), static strong typing is always a bit weaker with -PropertyAccess-. See -AssertTypeIntegrity- and -BoilerplateCodeProperties- for attempts at alleviating this.0x000D0x000A0x000D0x000AFAQ: How does the property stream format compare to the JSON format?0x000D0x000AThe short answer is that JSON is well suited when you want to transfer a whole object.0x000D0x000AIf you want to transfer parts of an object, for instance updating one single property, then the property stream format is better suited.0x000D0x000AA JSON representation of some given data points could be seen as a 'compiled' variant of the same data points stored as property stream lines.0x000D0x000AThis is because the original property stream lines for a given JSON representation may be spread out (not being located close to each other).0x000D0x000ANote however that if the actual property stream lines (for some given data points) reside consequently to each other in the data storage, then JSON would be a much more effective format for representation because it is much less verbose.0x000D0x000ATODO: Insert examples here in order to clarify.0x000D0x000A0x000D0x000ASome notes about compression:0x000D0x000ANote how the format used is somewhat verbose but well suited for on-disk compression.0x000D0x000AIt is for instance inefficient (storage-wise) to repeat the same context line after line.0x000D0x000ABut on the other hand, the underlying OS can easily be instructed to compress the storage files instead (something it should be able to do quite efficiently, leaving the size-issue to mostly constitute a network bandwidth problem.0x000D0x000ANote that some optimizations are performed anyway, see for instance -Timestamp- which describes how timestamps are not added to each and every property stream line but inserted as needed.0x000D0x000A0x000D0x000A

Edit single sub keys only: __TOCDet

Generated 2025-06-18 00:26:30.752 UTC