Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

prophet::changeset(3pm) [debian man page]

Prophet::ChangeSet(3pm) 				User Contributed Perl Documentation				   Prophet::ChangeSet(3pm)

NAME

       Prophet::ChangeSet

DESCRIPTION

       This class represents a single, atomic Prophet database update. It tracks some metadata about the changeset itself and contains a list of
       Prophet::Change entries which describe the actual records created, updated and deleted.

METHODS

   new
       Instantiate a new, empty Prophet::ChangeSet object.

   creator
       A string representing who created this changeset.

   created
       A string representing the ISO 8601 date and time when this changeset was created (UTC).

   sequence_no
       The changeset's sequence number (in subversion terms, revision #) on the replica sending us the changeset.

   source_uuid
       The uuid of the replica sending us the change.

   original_source_uuid
       The uuid of the replica where the change was authored.

   original_sequence_no
       The changeset's sequence number (in subversion terms, revision #) on the replica where the change was originally created.

   is_nullification
       A boolean value specifying whether this is a nullification changeset or not.

   is_resolution
       A boolean value specifying whether this is a conflict resolution changeset or not.

   changes
       Returns an array of all the changes in the current changeset.

   has_changes
       Returns true if this changeset has any changes.

   add_change { change => Prophet::Change }
       Adds a new change to this changeset.

   as_hash
       Returns a reference to a representation of this changeset as a hash, containing all the properties in the package variable
       @SERIALIZE_PROPS, as well as a "changes" key containing hash representations of each change in the changeset, keyed on UUID.

   new_from_hashref HASHREF
       Takes a reference to a hash representation of a changeset (such as is returned by "as_hash" or serialized json) and returns a new
       Prophet::ChangeSet representation of it.

       Should be invoked as a class method, not an object method.

       For example: "Prophet::ChangeSet->new_from_hashref($ref_to_changeset_hash)"

   as_string ARGS
       Returns a single string representing the changes in this changeset.

       If $args{header_callback} is defined, the string returned from passing $self to the callback is prepended to the changeset string before it
       is returned (instead of "description_as_string").

       If $args{skip_empty} is defined, an empty string is returned if the changeset contains no changes.

       The argument "change_filter" can be used to filter certain changes from the string representation; the function is passed a change and
       should return false if that change should be skipped.

       The "change_header" argument, if present, is passed to "$change->to_string" when individual changes are converted to strings.

   description_as_string
       Returns a string representing a description of this changeset.

perl v5.10.1							    2009-12-22						   Prophet::ChangeSet(3pm)

Check Out this Related Man Page

Prophet::Change(3pm)					User Contributed Perl Documentation				      Prophet::Change(3pm)

NAME

       Prophet::Change

DESCRIPTION

       This class encapsulates a change to a single record in a Prophet replica.

METHODS

   record_type
       The record type for the record.

   record_uuid
       The UUID of the record being changed.

   change_type
       One of "add_file", "add_dir", "update_file", "delete".

   is_resolution
       A boolean value specifying whether this change represents a conflict resolution or not.

   prop_changes [@PROPCHANGES]
       Returns a list of Prophet::PropChanges associated with this Change. Takes an optional arrayref to fully replace the set of propchanges.

   has_prop_changes
       Returns true if this change contains any Prophet::PropChanges and false if it doesn't.

   new_from_conflict $conflict
       Takes a Prophet::Conflict object and creates a Prophet::Change object representing the conflict resolution.

   add_prop_change { new => __, old => ___, name => ___ }
       Adds a new Prophet::PropChange to this Prophet::Change.

       Takes a "name", and the "old" and "new" values.

   as_hash
       Returns a reference to a representation of this change as a hash.

   as_string ARGS
       Returns a string representing this change. If $args{header_callback} is specified, the string returned from passing $self to the callback
       is prepended to the change string before it is returned.

   new_from_hashref HASHREF
       Takes a reference to a hash representation of a change (such as is returned by "as_hash" or serialized json) and returns a new
       Prophet::Change representation of it.

       This method should be invoked as a class method, not an object method.

       For example: "Prophet::Change->new_from_hashref($ref_to_change_hash)"

perl v5.10.1							    2009-12-22						      Prophet::Change(3pm)
Man Page