Attributes

Author: bajb

pages/features/properties.md

@@ -16,3 +16,49 @@ Data can be transferred to KeystoneDB in a variety of formats. The following are
 - `IntSet` - A unique set of integers
 - `StringSet` - A unique set of strings
 - `Bytes` - Raw bytes
+
+## Attributes
+
+The Keystone attribute works similar to json/yaml attributes, where it contains a comma separated list, where the first part is the name (if left blank, the property name will be generated), and options are provided from that point.
+
+	PaymentCount int64 `keystone:"_count_relation:payment"`
+
+- `_entity_id` - The loaded Keystone ID (Parent)
+- `_child_id` - The loaded Keystone ID (Child)
+- `_schema_id` - Schema ID
+- `_created` - Date/Time Created
+- `_state_change` - Date/Time State Change
+- `_state` - Current State
+- `_last_update` - Date/Time Last Updated
+
+## Calculated Attributes
+
+- `_count_relation`
+- `_count_descendant`
+
+Optionally suffixed with :vendorId[:appId[:key]]
+
+e.g.
+
+```
+  _count_relation:vendorId:appId:key
+  _count_relation:vendorId:appId
+  _count_relation:vendorId
+```
+
+Optionally suffixed with :type[:vendorId[:appId[:key]]]
+
+- `_child_count`
+- `_child_sum`
+- `_child_min`
+- `_child_max`
+- `_child_avg`
+
+e.g.
+
+```
+  child_count:type:vendorId:appId:key
+  child_count:type:vendorId:appId
+  child_count:type:vendorId
+  child_count:type
+```