DataParcelAttribute MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The DataParcelAttribute type exposes the following members.
Constructors

  NameDescription
Public methodDataParcelAttribute
Initializes a new instance of the DataParcelAttribute class
Back to Top
Methods

  NameDescription
Public methodOnlineEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Returns the hash code for this instance.
(Inherited from OnlineAttribute.)
Public methodStatic memberGetParcelAttr
Returns DataParcelAttribute for a parcel type. Use Parcel.MetadataAttribute to obtain the attribute instance polymorphically for instance. If parcel is not decorated by the attribute then exception is thrown
Protected methodStatic membergetParcelAttrCore
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from OnlineAttribute.)
Public methodOnlineMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Properties

  NameDescription
Public propertyAreaName
Specifies the Areaname - the logical subdivision in the store where parcels reside within the schema(see SchemaName): i.e. 'commonClinicalData'. Depending on a particular store setup this logical name may or may not represent physical servers/locations in the store. Every store implementation maps logical paths to physical servers and/or shards. This feature provides very high degree of distributed database design flexibility, as some parcels may represent common/dictionary data that does not need to be sharded, whereas others may represent purely transactional high-volume data that needs to be sharded. The value is required and is always specified or exception is thrown in .ctor
Public propertyCacheAbsoluteExpirationUTC
This property can not be set on the attribute level and always returns null
Public propertyCachePriority
Specifies the relative cache priority of this parcel This property acts as a default, the runtime first checks parcel instance properties then reverts to this attribute
Public propertyCacheReadMaxAgeSec
Specifies the maximum age of parcel instance in cache to be suitable for reading This property acts as a default, the runtime first checks parcel instance properties then reverts to this attribute
Public propertyCacheTableName
Specifies the name of the cache table for this parcel This property acts as a default, the runtime first checks parcel instance properties then reverts to this attribute
Public propertyCacheWriteMaxAgeSec
Specifies for how long should this parcel be cached in RAM after a write (after a saved change). This property acts as a default, the runtime first checks parcel instance properties then reverts to this attribute
Public propertyReplicationChannel
Specifies the name of the replication channel used to pump data between servers/data centers/locations
Public propertySchemaName
Specifies the name for logical schema that parcel decorated by this attribute belongs to. The exact location within the data store is detailed further with AreaName property. The value is required and is always specified or exception is thrown in .ctor
Public propertyShardingParcel
Specifies the type of Parcel that is used for sharding. By default this parameter is null, so parcels are sharded on their own instance types, however there are cases when a parcel overrides ShardingID and specifies ShardingParcel type via this member so it gets stored along with the specified parcel
Public propertySupportsMerge
Returns true if parcel supports merge with other versions. Server may merge multiple parcel versions to resolve versioning conflict. Default implementation returns false
Public propertyTableMappings
Returns mappins of target->table attributes. Pass in [DataParcel(targetTableMappings = "targetName1=tableName1{atr1=v1 atr2=v2...} targetName2=tableName2{atr1=v1 atr2=v2...}...")];
Public propertyOnlineTypeId
When implemented in a derived class, gets a unique identifier for this OnlineAttribute.
(Inherited from OnlineAttribute.)
Back to Top
See Also