.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MongoDBx::Class::Document 3pm" .TH MongoDBx::Class::Document 3pm "2014-05-13" "perl v5.18.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" MongoDBx::Class::Document \- A MongoDBx::Class document role .SH "VERSION" .IX Header "VERSION" version 1.030002 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # create a document class \& package MyApp::Schema::Novel; \& \& use MongoDBx::Class::Moose; # use this instead of Moose; \& use namespace::autoclean; \& \& with \*(AqMongoDBx::Class::Document\*(Aq; \& \& has \*(Aqtitle\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqStr\*(Aq, required => 1, writer => \*(Aqset_title\*(Aq); \& \& holds_one \*(Aqauthor\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqMyApp::Schema::PersonName\*(Aq, required => 1, writer => \*(Aqset_author\*(Aq); \& \& has \*(Aqyear\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqInt\*(Aq, predicate => \*(Aqhas_year\*(Aq, writer => \*(Aqset_year\*(Aq); \& \& has \*(Aqadded\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqDateTime\*(Aq, traits => [\*(AqParsed\*(Aq], required => 1); \& \& has \*(Aqreview_count\*(Aq => (is => \*(Aqrw\*(Aq, isa => \*(AqInt\*(Aq, traits => [\*(AqTransient\*(Aq], builder => \*(Aq_build_review_count\*(Aq); \& \& holds_many \*(Aqtags\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqMyApp::Schema::Tag\*(Aq, predicate => \*(Aqhas_tags\*(Aq); \& \& joins_one \*(Aqsynopsis\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqSynopsis\*(Aq, coll => \*(Aqsynopsis\*(Aq, ref => \*(Aqnovel\*(Aq); \& \& has_many \*(Aqrelated_novels\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqNovel\*(Aq, predicate => \*(Aqhas_related_novels\*(Aq, writer => \*(Aqset_related_novels\*(Aq, clearer => \*(Aqclear_related_novels\*(Aq); \& \& joins_many \*(Aqreviews\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqReview\*(Aq, coll => \*(Aqreviews\*(Aq, ref => \*(Aqnovel\*(Aq); \& \& sub _build_review_count { shift\->reviews\->count } \& \& sub print_related_novels { \& my $self = shift; \& \& foreach my $other_novel ($self\->related_novels) { \& print $other_novel\->title, \*(Aq, \*(Aq, \& $other_novel\->year, \*(Aq, \*(Aq, \& $other_novel\->author\->name, "\en"; \& } \& } \& \& around \*(Aqreviews\*(Aq => sub { \& my ($orig, $self) = (shift, shift); \& \& my $cursor = $self\->$orig; \& \& return $cursor\->sort([ year => \-1, title => 1, \*(Aqauthor.last_name\*(Aq => 1 ]); \& }; \& \& _\|_PACKAGE_\|_\->meta\->make_immutable; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" MongoDBx::Class::Document is a Moose role meant to be consumed by document classes. It provides expanded MongoDB documents with some common attributes, and needed methods for easy updating and deleting of documents. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" The following attributes are provided: .SS "_id" .IX Subsection "_id" The document's internal \s-1ID,\s0 represented as a MongoDB::OID object. This is a required attribute. .SS "_collection" .IX Subsection "_collection" The MongoDBx::Class::Collection object representing the MongoDB collection in which the document is stored. This is a required attribute. .SS "_class" .IX Subsection "_class" A string. The name of the document class of this document. This is a required attribute. .SH "OBJECT METHODS" .IX Header "OBJECT METHODS" The following object methods are provided: .SS "\fIid()\fP" .IX Subsection "id()" .SS "\fIoid()\fP" .IX Subsection "oid()" Both methods are equivalent. They are convenience methods that return the documents internal MongoDB \s-1OID\s0 in string format. .SS "update( [ \e%object, [ \e%options ] ] )" .IX Subsection "update( [ %object, [ %options ] ] )" Saves a new version of the document to the database. The behavior of this method is dependent on the existance or non-existance of an object hash-ref: .PP If an object hash-ref is provided, all of its key-value pairs are collapsed, and a \f(CW$set\fR update is performed on them. For example: .PP .Vb 1 \& $doc\->update({ author => \*(AqSir Arthur Conan Doyle\*(Aq, year => 1895 }, $options) .Ve .PP Will effectively result in something like this being performed: .PP .Vb 1 \& $coll\->update({ _id => $doc\->_id }, { \*(Aq$set\*(Aq => { author => \*(AqSir Arthur Conan Doyle\*(Aq, year => 1895 } }, $options) .Ve .PP If an object hash-ref isn't provided, the entire document object is collapsed and an aggresive update is performed (i.e. an entirely new version of the document, representing the current state of the document's attributes, is saved to the database. For example: .PP .Vb 1 \& my $doc = find_one($id); \& \& $doc\->set_author(\*(AqSir Arthur Conan Doyle\*(Aq); \& $doc\->set_year(1895); \& $doc\->update; .Ve .PP Will effectively result in something like this being performed: .PP .Vb 1 \& $coll\->update({ _id => $doc\->_id }, $collapsed_doc, $options) .Ve .PP You can pass an options hash-ref just like with the \f(CW\*(C`update()\*(C'\fR method of MongoDBx::Class::Collection, but only if you pass an update object also. .PP Returns the output of MongoDB::Collection's original \f(CW\*(C`update()\*(C'\fR method. .SS "\fIdelete()\fP" .IX Subsection "delete()" .SS "\fIremove()\fP" .IX Subsection "remove()" Both methods are equivalent. They are shortcut methods for invoking the collection's \f(CW\*(C`remove()\*(C'\fR method on this document only. So, umm, they remove the document. But note that this operation does not cascade, so documents which are considered dependent on this document (such as those that reference it with \f(CW\*(C`belongs_to\*(C'\fR) will not be removed too. .SH "INTERNAL METHODS" .IX Header "INTERNAL METHODS" The following methods are only to be used internally. .SS "\fI_database()\fP" .IX Subsection "_database()" Convenience method, shortcut for \f(CW\*(C`$doc\->_collection\->_database\*(C'\fR. .SS "\fI_connection()\fP" .IX Subsection "_connection()" Convenience method, shortcut for \f(CW\*(C`$doc\->_database\->_connection\*(C'\fR. .SS "\fI_attributes()\fP" .IX Subsection "_attributes()" Returns a list of names of all attributes the document object has, minus \&'_collection' and '_class', sorted alphabetically. .SS "\fI_update_self()\fP" .IX Subsection "_update_self()" Used by the \f(CW\*(C`update( \e%changes )\*(C'\fR method to update the object instance with the new values. .SH "AUTHOR" .IX Header "AUTHOR" Ido Perlmuter, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \f(CW\*(C`bug\-mongodbx\-class at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc MongoDBx::Class::Document .Ve .PP You can also look for information at: .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "SEE ALSO" .IX Header "SEE ALSO" MongoDBx::Class::Moose, MongoDBx::Class::EmbeddedDocument. .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2010\-2014 Ido Perlmuter. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.