README.md in global-registry-bindings-0.1.1 vs README.md in global-registry-bindings-0.1.2
- old
+ new
@@ -69,10 +69,14 @@
* `:parent_association_class`: Class name of the parent model. Required if `:parent_association` can not be used
to determine the parent class. This can happen if parent is defined by another gem, like `ancestry`.
(default: `nil`) **[`:entity`]**
+* `:primary_binding`: Determines what type of global-registry-binding the primary association points to. Defaults
+to `:entity`, but can be set to a `:relationship` type name (ex: `:assignment`) to create a relationship_type
+between a relationship and an entity. (default: `:entity`) **[`:relationship`]**
+
* `:primary_association`: Name of the Active Record primary association. Must be defined before calling
global_registry_bindings in order to determine foreign_key for use in exclude_fields. (default: `nil`)
**[`:relationship`]**
* `:primary_association_class`: Class name of the primary model. Required if `:primary_association` can not be
@@ -92,15 +96,15 @@
* `:related_association_foreign_key`: Foreign Key column for the related association. Used if foreign_key can
not be determined from `:primary_association`. (default: `:primary_association.foreign_key`)
**[`:relationship`]**
-* `:primary_relationship_name`: Name of primary relationship role. Required if `:ensure_relationship_type` is
-`true`. (default: `nil`) **[`:relationship`]**
+* `:primary_relationship_name`: **Required** Name of primary relationship. Should be unique to prevent
+ambiguous relationship names. (default: `nil`) **[`:relationship`]**
-* `:related_relationship_name`: Name of the related relationship role. Required if `:ensure_relationship_type`
-is `true`. (default: `nil`) **[`:relationship`]**
+* `:related_relationship_name`: **Required** Name of the related relationship. Should be unique to prevent
+ambiguous relationship names (default: `nil`) **[`:relationship`]**
* `:related_association_type`: Name of the related association entity_type. Required if unable to determined
`:type` from related. (default: `nil`) **[`:relationship`]**
* `:related_global_registry_id`: Global Registry ID of a remote related entity. Proc or Symbol. Implementation
@@ -112,9 +116,13 @@
* `:ensure_entity_type`: Ensure Global Registry Entity Type exists and is up to date.
(default: `true`) **[`:entity`]**
* `:client_integration_id`: Client Integration ID for relationship. Proc or Symbol.
(default: `:primary_association.id`) **[`:relationship`]**
+
+* `:include_all_columns`: Include all model columns in the fields to push to Global Registry. If `false`, fields must
+be defined in the `:extra_fields` option. (default: `true`)
+**[`:entity`, `:relationship`]**
* `:exclude_fields`: Array, Proc or Symbol. Array of Model fields (as symbols) to exclude when pushing to Global
Registry. Array Will additionally include `:mdm_id_column` and `:parent_association` foreign key when defined.
If Proc, is passed type and model instance and should return an Array of the fields to exclude. If Symbol,
this should be a method name the Model instance responds to. It is passed the type and should return an Array