/ doc / toc / ARCCore / Class / Subscription

Subscription

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 = A stream -Subscription- is the concept of how nodes (see -ARNodeType-) subscribe to the -PropertyStream- (either the whole stream or just part of it) in a distributed manner.0x000D0x000A0x000D0x000AThis class -Subscription- describes WHAT data is required from the -PropertyStream-.0x000D0x000AUsed in connection with -ClientUpdatePosition- which describes from WHERE (from WHEN) in the historic -PropertyStream- data is to be returned.0x000D0x000A0x000D0x000AThis class describes a single subscription element. A complete query consists of one or more instances of this class. See -IsMatch- for how a query is evaluated.0x000D0x000A0x000D0x000ASome examples of subscriptions could be:0x000D0x000A0x000D0x000A1) A -Client-, for instance -ARCAPI-, subscribing (towards -CoreDB-) to those parts of the -PropertyStream- that it needs for its functioning.0x000D0x000AAs this client receives the incoming properties (through -OutsideLocalReceiver-) they would typically be stored in a -PRich- for immediate in-memory evaluation of incoming queries to the client again.0x000D0x000A0x000D0x000A2) Subscribe to logging properties for setting up of a log-console (see -app-).0x000D0x000A0x000D0x000A3) Subscribe to whole database or part of database in different manners in order to set up load-balancing, fault-tolerance, caching and similar (see -MultipleConnectionUsage- and -Sharding- for more information).0x000D0x000A(in other words, synchronizing and coordinating between multiple AgoRapide based nodes, especially between -CoreDB- nodes.) Note how the subscription instruction itself can very well be sent over the -PropertyStream-, configuring the different nodes from a central entry point of administration.0x000D0x000A0x000D0x000ASee -SyntaxHelp-.0x000D0x000A0x000D0x000ATODO: Introduce '**' in order to signify any hierarchical level.0x000D0x000ATODO: Like +**/Heartbeat/* in order to collect all -Heartbeat- in the system, regardless of hierarchical level.0x000D0x000ASee -IsMatch- (static method) for how a query consisting of multiple instances of -Subscription- are evaluated.0x000D0x000AThis class is immutable.
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = Note that this same 'query language' (multiple instances of -Subscription-) can very well be used by clients of -ARCAPI- also.0x000D0x000A(but more probably an API client will make GraphQL requests instead).0x000D0x000A0x000D0x000ANote / FAQ about IQueryable0x003C0x003E: May 2020: AgoRapide will probably not support IQueryable because this interface is mostly about avoiding local processing of data. With IQueryable the query will not be executed until it reaches the actual data storage. Since a typical -ARNodeType- actually has all data present locally, this concept becomes irrelevant.0x000D0x000A
__TOCDet/Name = Subscription
__TOCDet/Namespace = ARCCore
__TOCDet/Type = Subscription
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = Subscription
__TOCDet/Attribute/Description = A stream -Subscription- is the concept of how nodes (see -ARNodeType-) subscribe to the -PropertyStream- (either the whole stream or just part of it) in a distributed manner.0x000D0x000A0x000D0x000AThis class -Subscription- describes WHAT data is required from the -PropertyStream-.0x000D0x000AUsed in connection with -ClientUpdatePosition- which describes from WHERE (from WHEN) in the historic -PropertyStream- data is to be returned.0x000D0x000A0x000D0x000AThis class describes a single subscription element. A complete query consists of one or more instances of this class. See -IsMatch- for how a query is evaluated.0x000D0x000A0x000D0x000ASome examples of subscriptions could be:0x000D0x000A0x000D0x000A1) A -Client-, for instance -ARCAPI-, subscribing (towards -CoreDB-) to those parts of the -PropertyStream- that it needs for its functioning.0x000D0x000AAs this client receives the incoming properties (through -OutsideLocalReceiver-) they would typically be stored in a -PRich- for immediate in-memory evaluation of incoming queries to the client again.0x000D0x000A0x000D0x000A2) Subscribe to logging properties for setting up of a log-console (see -app-).0x000D0x000A0x000D0x000A3) Subscribe to whole database or part of database in different manners in order to set up load-balancing, fault-tolerance, caching and similar (see -MultipleConnectionUsage- and -Sharding- for more information).0x000D0x000A(in other words, synchronizing and coordinating between multiple AgoRapide based nodes, especially between -CoreDB- nodes.) Note how the subscription instruction itself can very well be sent over the -PropertyStream-, configuring the different nodes from a central entry point of administration.0x000D0x000A0x000D0x000ASee -SyntaxHelp-.0x000D0x000A0x000D0x000ATODO: Introduce '**' in order to signify any hierarchical level.0x000D0x000ATODO: Like +**/Heartbeat/* in order to collect all -Heartbeat- in the system, regardless of hierarchical level.0x000D0x000ASee -IsMatch- (static method) for how a query consisting of multiple instances of -Subscription- are evaluated.0x000D0x000AThis class is immutable.
__TOCDet/Attribute/Interfaces = ITypeDescriber0x003BIEquatable0xoooo003CSubscription0xoooo003E
__TOCDet/Attribute/InterfacesDirectlyImplemented = ITypeDescriber0x003BIEquatable0xoooo003CSubscription0xoooo003E
__TOCDet/Attribute/LongDescription = Note that this same 'query language' (multiple instances of -Subscription-) can very well be used by clients of -ARCAPI- also.0x000D0x000A(but more probably an API client will make GraphQL requests instead).0x000D0x000A0x000D0x000ANote / FAQ about IQueryable0x003C0x003E: May 2020: AgoRapide will probably not support IQueryable because this interface is mostly about avoiding local processing of data. With IQueryable the query will not be executed until it reaches the actual data storage. Since a typical -ARNodeType- actually has all data present locally, this concept becomes irrelevant.0x000D0x000A
FromTime/__TOCDet/Assembly = ARCCore
FromTime/__TOCDet/Description = TODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.
FromTime/__TOCDet/DocFragType = ClassMember
FromTime/__TOCDet/IsInherited = False
FromTime/__TOCDet/IsInheritedDoc = False
FromTime/__TOCDet/Lines = 2
FromTime/__TOCDet/Name = FromTime
FromTime/__TOCDet/Namespace = ARCCore
FromTime/__TOCDet/Type = Subscription
FromTime/__TOCDet/Attribute/DeclaringType = Subscription
FromTime/__TOCDet/Attribute/Description = TODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.
FromTime/__TOCDet/Attribute/MethodName = FromTime
FromTime/__TOCDet/Attribute/MethodSignature = Void FromTime()
IsAdd/__TOCDet/Assembly = ARCCore
IsAdd/__TOCDet/Description = Corresponds to whether value starts with a plus sign, '+' or not.
IsAdd/__TOCDet/DocFragType = ClassMember
IsAdd/__TOCDet/IsInherited = False
IsAdd/__TOCDet/IsInheritedDoc = False
IsAdd/__TOCDet/Lines = 1
IsAdd/__TOCDet/Name = IsAdd
IsAdd/__TOCDet/Namespace = ARCCore
IsAdd/__TOCDet/Type = Subscription
IsAdd/__TOCDet/Attribute/DeclaringType = Subscription
IsAdd/__TOCDet/Attribute/Description = Corresponds to whether value starts with a plus sign, '+' or not.
IsAdd/__TOCDet/Attribute/MethodName = IsAdd
IsAdd/__TOCDet/Attribute/MethodSignature = Boolean IsAdd
IsMatch/__TOCDet/_Description = 2 items
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Assembly = ARCCore
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Description = Evaluates a query consisting of multiple instances of -Subscription- against a single property stream line.0x000D0x000A0x000D0x000ATRUE is returned when0x000D0x000A(any of the -IsAdd- instances matches)0x000D0x000AAND NOT0x000D0x000A(any of the -IsRemove- instances matches)0x000D0x000A0x000D0x000ATODO: Add support for RegEx and other formats
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/DocFragType = ClassMember
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/IsInherited = False
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/IsInheritedDoc = False
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Lines = 8
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Name = IsMatch
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Namespace = ARCCore
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Type = Subscription
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Attribute/DeclaringType = Subscription
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Attribute/Description = Evaluates a query consisting of multiple instances of -Subscription- against a single property stream line.0x000D0x000A0x000D0x000ATRUE is returned when0x000D0x000A(any of the -IsAdd- instances matches)0x000D0x000AAND NOT0x000D0x000A(any of the -IsRemove- instances matches)0x000D0x000A0x000D0x000ATODO: Add support for RegEx and other formats
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Attribute/MethodName = IsMatch
IsMatch/ARCCore.Subscription.IsMatch Overload1/__TOCDet/Attribute/MethodSignature = Boolean IsMatch(System.Collections.Generic.List0x006010x005BARCCore.Subscription0x005D, System.String)
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Assembly = ARCCore
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Description = Evaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).0x000D0x000A0x000D0x000ADoes not take into consideration + or - (whether we are -IsAdd- / -IsRemove-), considers only whether string matches
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/DocFragType = ClassMember
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/IsInherited = False
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/IsInheritedDoc = False
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Lines = 3
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Name = IsMatch
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Namespace = ARCCore
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Type = Subscription
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Attribute/DeclaringType = Subscription
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Attribute/Description = Evaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).0x000D0x000A0x000D0x000ADoes not take into consideration + or - (whether we are -IsAdd- / -IsRemove-), considers only whether string matches
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Attribute/MethodName = IsMatch
IsMatch/ARCCore.Subscription.IsMatch Overload2/__TOCDet/Attribute/MethodSignature = Boolean IsMatch(System.Collections.Generic.List0x006010x005BSystem.String0x005D)
IsRemove/__TOCDet/Assembly = ARCCore
IsRemove/__TOCDet/Description = Corresponds to whether value starts with a minus sign, '+' or not.
IsRemove/__TOCDet/DocFragType = ClassMember
IsRemove/__TOCDet/IsInherited = False
IsRemove/__TOCDet/IsInheritedDoc = False
IsRemove/__TOCDet/Lines = 1
IsRemove/__TOCDet/Name = IsRemove
IsRemove/__TOCDet/Namespace = ARCCore
IsRemove/__TOCDet/Type = Subscription
IsRemove/__TOCDet/Attribute/DeclaringType = Subscription
IsRemove/__TOCDet/Attribute/Description = Corresponds to whether value starts with a minus sign, '+' or not.
IsRemove/__TOCDet/Attribute/MethodName = IsRemove
IsRemove/__TOCDet/Attribute/MethodSignature = Boolean IsRemove
SyntaxHelp/__TOCDet/Assembly = ARCCore
SyntaxHelp/__TOCDet/Description = '+*'                         Subscribe to everything in database.0x000D0x000A'+dt/Customer/*'             Subscribe to all Customer properties.0x000D0x000A'-dt/Customer/*/Photo/*'     Exclude from subscription photos of customers.0x000D0x000A'+dt/Customer/*/FirstName/*' Subscribe to all occurrences of Customer.FirstName.0x000D0x000A'+dt/Customer/*/LastName/*'  Subscribe to all occurrences of Customer.LastName.0x000D0x000A'+dt/Customer/42/*'          Subscribe to all properties related to customer with id 42.0x000D0x000A'+dt/Order/*'                Subscribe to all Order properties.0x000D0x000A'+log/*'                     Subscribe to everything beginning with log .0x000D0x000A'-log/API/*'                 Do not include properties beginning with 'log/API/ in subscription.0x000D0x000A'-*'                         Stop existing subscription.0x000D0x000A
SyntaxHelp/__TOCDet/DocFragType = ClassMember
SyntaxHelp/__TOCDet/IsInherited = False
SyntaxHelp/__TOCDet/IsInheritedDoc = False
SyntaxHelp/__TOCDet/Lines = 11
SyntaxHelp/__TOCDet/Name = SyntaxHelp
SyntaxHelp/__TOCDet/Namespace = ARCCore
SyntaxHelp/__TOCDet/Type = Subscription
SyntaxHelp/__TOCDet/Attribute/DeclaringType = Subscription
SyntaxHelp/__TOCDet/Attribute/Description = '+*'                         Subscribe to everything in database.0x000D0x000A'+dt/Customer/*'             Subscribe to all Customer properties.0x000D0x000A'-dt/Customer/*/Photo/*'     Exclude from subscription photos of customers.0x000D0x000A'+dt/Customer/*/FirstName/*' Subscribe to all occurrences of Customer.FirstName.0x000D0x000A'+dt/Customer/*/LastName/*'  Subscribe to all occurrences of Customer.LastName.0x000D0x000A'+dt/Customer/42/*'          Subscribe to all properties related to customer with id 42.0x000D0x000A'+dt/Order/*'                Subscribe to all Order properties.0x000D0x000A'+log/*'                     Subscribe to everything beginning with log .0x000D0x000A'-log/API/*'                 Do not include properties beginning with 'log/API/ in subscription.0x000D0x000A'-*'                         Stop existing subscription.0x000D0x000A
SyntaxHelp/__TOCDet/Attribute/MethodName = SyntaxHelp
SyntaxHelp/__TOCDet/Attribute/MethodSignature = System.String SyntaxHelp
ToTime/__TOCDet/Assembly = ARCCore
ToTime/__TOCDet/Description = TODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.
ToTime/__TOCDet/DocFragType = ClassMember
ToTime/__TOCDet/IsInherited = False
ToTime/__TOCDet/IsInheritedDoc = False
ToTime/__TOCDet/Lines = 2
ToTime/__TOCDet/Name = ToTime
ToTime/__TOCDet/Namespace = ARCCore
ToTime/__TOCDet/Type = Subscription
ToTime/__TOCDet/Attribute/DeclaringType = Subscription
ToTime/__TOCDet/Attribute/Description = TODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.
ToTime/__TOCDet/Attribute/MethodName = ToTime
ToTime/__TOCDet/Attribute/MethodSignature = Void ToTime()

Edit single sub keys only: __TOCDet / FromTime / IsAdd / IsMatch / IsRemove / SyntaxHelp / ToTime

Generated 2025-07-10 09:05:46.991 UTC