-
Notifications
You must be signed in to change notification settings - Fork 8
/
Model.pm
1052 lines (787 loc) · 28.6 KB
/
Model.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Elastic::Model::Role::Model;
use Moose::Role;
use Carp;
use Elastic::Model::Types qw(ES ES_UniqueKey);
use ElasticSearch 0.58 ();
use ElasticSearchX::UniqueKey 0.03 ();
use Class::Load qw(load_class);
use Moose::Util qw(does_role);
use MooseX::Types::Moose qw(:all);
use Elastic::Model::UID();
use Elastic::Model::Deleted();
use Scalar::Util qw(blessed refaddr weaken);
use List::MoreUtils qw(uniq);
use namespace::autoclean;
my @wrapped_classes = qw(
domain namespace store view scope
results scrolled_results result
);
for my $class (@wrapped_classes) {
#===================================
has "${class}_class" => (
#===================================
isa => Str,
is => 'ro',
default => sub { shift->wrap_class($class) }
);
}
#===================================
has 'typemap' => (
#===================================
is => 'ro',
isa => Str,
default => sub { shift->wrap_class('typemap') }
);
#===================================
has [ 'deflators', 'inflators' ] => (
#===================================
isa => HashRef,
is => 'ro',
default => sub { {} }
);
#===================================
has 'store' => (
#===================================
does => 'Elastic::Model::Role::Store',
is => 'ro',
lazy => 1,
builder => '_build_store'
);
#===================================
has 'es' => (
#===================================
isa => ES,
is => 'ro',
lazy => 1,
builder => '_build_es',
coerce => 1,
);
#===================================
has 'es_unique' => (
#===================================
isa => ES_UniqueKey,
is => 'ro',
lazy => 1,
builder => '_build_es_unique',
);
#===================================
has 'doc_class_wrappers' => (
#===================================
is => 'ro',
isa => HashRef,
traits => ['Hash'],
lazy => 1,
builder => '_build_doc_class_wrappers',
handles => {
class_for => 'get',
knows_class => 'exists'
}
);
#===================================
has 'namespaces' => (
#===================================
is => 'ro',
isa => HashRef,
traits => ['Hash'],
builder => '_build_namespaces',
handles => { namespace => 'get' }
);
#===================================
has '_domain_cache' => (
#===================================
isa => HashRef,
is => 'bare',
traits => ['Hash'],
default => sub { {} },
# TODO clear domain cache when changing indices/aliases?
handles => {
_get_domain => 'get',
_cache_domain => 'set',
},
);
#===================================
has '_domain_namespace' => (
#===================================
is => 'ro',
isa => HashRef,
traits => ['Hash'],
lazy => 1,
builder => '_build_domain_namespace',
clearer => 'clear_domain_namespace',
handles => { _get_domain_namespace => 'get', }
);
#===================================
has 'current_scope' => (
#===================================
is => 'rw',
isa => 'Elastic::Model::Scope',
weak_ref => 1,
clearer => 'clear_current_scope',
predicate => 'has_current_scope',
);
#===================================
sub BUILD { shift->doc_class_wrappers }
sub _build_store { $_[0]->store_class->new( es => $_[0]->es ) }
sub _build_es { ElasticSearch->new }
#===================================
#===================================
sub _build_es_unique {
#===================================
my $self = shift;
my $index = Class::MOP::class_of($self)->unique_index;
my $uniq = ElasticSearchX::UniqueKey->new(
es => $self->es,
index => $index
);
$uniq->bootstrap;
return $uniq;
}
#===================================
sub _build_namespaces {
#===================================
my $self = shift;
my $conf = Class::MOP::class_of($self)->namespaces;
my %namespaces;
my $ns_class = $self->namespace_class;
while ( my ( $name, $args ) = each %$conf ) {
my $types = $args->{types};
my %classes
= map { $_ => $self->class_for( $types->{$_} ) } keys %$types;
$namespaces{$name} = $ns_class->new(
name => $name,
types => \%classes,
fixed_domains => $args->{fixed_domains} || []
);
}
\%namespaces;
}
#===================================
sub _build_doc_class_wrappers {
#===================================
my $self = shift;
my $namespaces = Class::MOP::class_of($self)->namespaces;
+{ map { $_ => $self->wrap_doc_class($_) }
map { values %{ $_->{types} } } values %$namespaces
};
}
#===================================
sub _build_domain_namespace {
#===================================
my $self = shift;
my $namespaces = $self->namespaces;
my %domains;
for my $name ( keys %$namespaces ) {
my $ns = $namespaces->{$name};
for my $domain ( $namespaces->{$name}->all_domains ) {
croak "Cannot map domain ($domain) to namespace ($name). "
. "It is already mapped to namespace ("
. $domains{$domain}->name . ")."
if $domains{$domain};
$domains{$domain} = $ns;
}
}
\%domains;
}
#===================================
sub namespace_for_domain {
#===================================
my ( $self, $domain ) = @_;
my $ns;
$ns = $self->_get_domain_namespace($domain) and return $ns;
$self->clear_domain_namespace;
$self->_get_domain_namespace($domain)
or croak "No namespace found for domain ($domain). ";
}
#===================================
sub all_live_indices {
#===================================
my $self = shift;
return map { $_->all_live_indices } values %{ $self->namespaces };
}
#===================================
sub wrap_doc_class {
#===================================
my $self = shift;
my $class = shift;
load_class($class);
croak "Class ($class) does not do Elastic::Model::Role::Doc. "
. "Please add : use Elastic::Doc;\n\n"
unless Moose::Util::does_role( $class, 'Elastic::Model::Role::Doc' );
$self->_wrap_class($class);
}
#===================================
sub wrap_class {
#===================================
my $self = shift;
my $name = shift || '';
my $class = $self->meta->get_class($name)
or croak "Unknown class for ($name)";
$self->_wrap_class($class);
}
#===================================
sub _wrap_class {
#===================================
my $self = shift;
my $class = shift;
load_class($class);
my $meta
= Moose::Meta::Class->create(
Class::MOP::class_of($self)->wrapped_class_name($class),
superclasses => [$class] );
weaken( my $weak_model = $self );
$meta->add_method( model => sub {$weak_model} );
$meta->add_method( original_class => sub {$class} );
$meta->make_immutable;
return $meta->name;
}
#===================================
sub domain {
#===================================
my $self = shift;
my $name = shift or croak "No domain name passed to domain()";
my $domain;
$domain = $self->_get_domain($name) and return $domain;
my $ns = $self->namespace_for_domain($name)
or croak "Unknown domain name ($name)";
$domain = $self->domain_class->new(
name => $name,
namespace => $ns
);
return $self->_cache_domain( $name => $domain );
}
#===================================
sub view { shift->view_class->new(@_) }
#===================================
#===================================
sub new_scope {
#===================================
my $self = shift;
my @args
= $self->has_current_scope ? ( parent => $self->current_scope ) : ();
$self->current_scope( $self->scope_class->new(@args) );
}
#===================================
sub detach_scope {
#===================================
my ( $self, $scope ) = @_;
my $current = $self->current_scope;
return unless $current && refaddr($current) eq refaddr($scope);
my $parent = $scope->parent;
return $self->clear_current_scope unless $parent;
$self->current_scope($parent);
}
#===================================
sub get_doc {
#===================================
my ( $self, %args ) = @_;
my $uid = $args{uid}
or croak "No UID passed to get_doc()";
my $ns = $self->namespace_for_domain( $uid->index );
my $scope = $self->current_scope;
my $source = $args{source};
my $object;
$object = $scope->get_object( $ns->name, $uid )
if $scope && !$source;
unless ($object) {
unless ( $source || $uid->from_store ) {
$source = $self->get_doc_source(%args) or return;
}
my $class = $ns->class_for_type( $uid->type );
$object = $class->meta->new_stub( $uid, $source );
$object = $scope->store_object( $ns->name, $object )
if $scope;
}
$object;
}
#===================================
sub get_doc_source {
#===================================
my ( $self, %args ) = @_;
my $uid = delete $args{uid};
my $result = $self->store->get_doc( $uid, %args ) or return;
$uid->update_from_store($result);
return $result->{_source};
}
#===================================
sub new_partial_doc {
#===================================
my ( $self, %args ) = @_;
my $uid = $args{uid}
or croak "No UID passed to new_partial_doc()";
my $source = $args{partial_source}
or croak "No (partial_source) passed to new_partial_doc()";
my $ns = $self->namespace_for_domain( $uid->index );
my $class = $ns->class_for_type( $uid->type );
return $class->meta->new_stub( $uid, $source );
}
#===================================
sub doc_exists {
#===================================
my ( $self, %args ) = @_;
my $uid = delete $args{uid}
or croak "No UID passed to doc_exists()";
return $self->store->doc_exists( $uid, %args );
}
#===================================
sub save_doc {
#===================================
my ( $self, %args ) = @_;
my $doc = delete $args{doc};
my $uid = $doc->uid;
croak "Cannot save partial doc type ("
. $uid->type
. ") id ("
. $uid->id . ")"
if $uid->is_partial;
my $data = $self->deflate_object($doc);
my $action
= ( $uid->from_store or $uid->id and defined $args{version} )
? 'index_doc'
: 'create_doc';
my $on_unique = delete $args{on_unique};
my $on_conflict = delete $args{on_conflict};
my $unique = $self->_update_unique_keys( $doc, $action, $on_unique )
or return;
my $result = eval { $self->store->$action( $uid, $data, %args ) } or do {
my $error = $@;
$unique->{rollback}->();
return $self->_handle_error( $error, $on_conflict, $doc );
};
$unique->{commit}->();
$uid->update_from_store($result);
$doc->_set_source($data);
my $scope = $self->current_scope
or return $doc;
my $ns = $self->namespace_for_domain( $uid->index );
return $scope->store_object( $ns->name, $doc );
}
my $noops = {
commit => sub { },
rollback => sub { }
};
#===================================
sub _update_unique_keys {
#===================================
my ( $self, $doc, $action, $on_unique ) = @_;
my $meta = Class::MOP::class_of($doc);
my $uniques = $meta->unique_keys
or return $noops;
my $from_store = $doc->uid->from_store;
croak "Cannot overwrite a new doc of class ("
. $doc->original_class
. ") because it has unique keys"
if $action eq 'index_doc' and not $from_store;
my ( %old, %new );
for my $key ( keys %$uniques ) {
my $unique_key = $uniques->{$key};
my $new = $doc->$key;
if ($from_store) {
my $old
= $doc->has_changed($key)
? $doc->old_value($key)
: $doc->$key;
no warnings 'uninitialized';
next if $from_store and $old eq $new;
$old{$unique_key} = $old if defined $old and length $old;
}
$new{$unique_key} = $new if defined $new and length $new;
}
my $uniq = $self->es_unique;
if ( my %failed = $uniq->multi_create(%new) ) {
if ($on_unique) {
$on_unique->( $doc, \%failed );
return;
}
croak "Unique keys already exist: "
. join( ', ', map { $_ . '/' . $failed{$_} } sort keys %failed );
}
return {
commit => sub { $uniq->multi_delete(%old); },
rollback => sub { $uniq->multi_delete(%new); }
};
}
#===================================
sub _handle_error {
#===================================
my ( $self, $error, $on_conflict, $original ) = @_;
$error ||= 'Unknown error';
die $error
unless $on_conflict
and $error =~ /ElasticSearch::Error::Conflict/;
my $new;
if ( my $current_version = $error->{-vars}{current_version} ) {
my $uid = Elastic::Model::UID->new(
%{ $original->uid->read_params },
version => $current_version,
from_store => 1
);
$new = $self->get_doc( uid => $uid );
}
else {
$new = $self->get_doc( uid => $original->uid->clone );
}
$on_conflict->( $original, $new );
return;
}
#===================================
sub delete_doc {
#===================================
my ( $self, %args ) = @_;
my $uid = delete $args{uid}
or croak "No UID passed to delete_doc()";
my $unique = $self->_delete_unique_keys($uid);
my $result = $self->store->delete_doc( $uid, %args )
or return;
$unique->{commit}->();
$uid->update_from_store($result);
if ( my $scope = $self->current_scope ) {
my $ns = $self->namespace_for_domain( $uid->index );
$scope->delete_object( $ns->name, $uid );
}
return $uid;
}
#===================================
sub _delete_unique_keys {
#===================================
my ( $self, $uid ) = @_;
my $doc = $self->get_doc( uid => $uid, ignore_missing => 1 )
or return $noops;
my $meta = Class::MOP::class_of($doc);
my $uniques = $meta->unique_keys or return $noops;
my %old;
for my $key ( keys %$uniques ) {
my $old
= $doc->has_changed($key)
? $doc->old_value($key)
: $doc->$key;
$old{ $uniques->{$key} } = $old if defined $old and length $old;
}
my $uniq = $self->es_unique;
return {
commit => sub { $uniq->multi_delete(%old) }
};
}
#===================================
sub search { shift->store->search(@_) }
#===================================
#===================================
sub deflate_object {
#===================================
my $self = shift;
my $object = shift or die "No object passed to deflate()";
my $class = blessed $object
or die "deflate() can only deflate objects";
$self->deflator_for_class($class)->($object);
}
#===================================
sub deflator_for_class {
#===================================
my $self = shift;
my $class = shift;
$class = $self->class_for($class) || $class;
return $self->deflators->{$class} ||= do {
die "Class $class is not an Elastic class."
unless does_role( $class, 'Elastic::Model::Role::Doc' );
$self->typemap->class_deflator($class);
};
}
#===================================
sub inflate_object {
#===================================
my $self = shift;
my $object = shift or die "No object passed to inflate()";
my $hash = shift or die "No hash pashed to inflate()";
$self->inflator_for_class( blessed $object)->( $object, $hash );
}
#===================================
sub inflator_for_class {
#===================================
my $self = shift;
my $class = shift;
$class = $self->class_for($class) || $class;
return $self->inflators->{$class} ||= do {
die "Class $class is not an Elastic class."
unless does_role( $class, 'Elastic::Model::Role::Doc' );
$self->typemap->class_inflator($class);
};
}
#===================================
sub map_class {
#===================================
my $self = shift;
my $class = shift;
$class = $self->class_for($class) || $class;
die "Class $class is not an Elastic class."
unless does_role( $class, 'Elastic::Model::Role::Doc' );
my $meta = $class->original_class->meta;
my %mapping = (
%{ $meta->mapping },
$self->typemap->class_mapping($class),
dynamic => 'strict',
_timestamp => { enabled => 1, path => 'timestamp' },
numeric_detection => 1,
);
$mapping{_source}{compress} = 1;
return \%mapping;
}
1;
__END__
# ABSTRACT: The role applied to your Model
=head1 SYNOPSIS
use MyApp;
my $es = ElasticSearch->new( servers => 'es.domain.com:9200' );
my $model = MyApp->new( es => $es );
my $namespace = $model->namespace('myapp');
my $domain = $model->domain('my_domain');
my $view = $model->view();
my $scope = $model->new_scope;
=head1 DESCRIPTION
A "Model" is the Boss Object, which ties an instance of your application to
a particular ElasticSearch cluster. You can have multiple instances of your
Model class which connect to different clusters.
C<Elastic::Model::Role::Model> is applied to your Model class when you
include the line:
use Elastic::Model;
See L<Elastic::Model> for more about how to setup your Model class.
=head1 COMMONLY USED METHODS
=head2 new()
Usually, the only parameter that you need to pass to C<new()> is C<es>,
which contains your L<ElasticSearch> connection.
$es = ElasticSearch->new( servers => 'es1.domain.com:9200' );
$model = MyApp->new( es => $es );
If the C<es> parameter is omitted, then it will default to an L<ElasticSearch>
connection to C<localhost:9200>.
$model = MyApp->new(); # localhost:9200
=head2 namespace()
$namespace = $model->namespace($name);
Returns the L<Elastic::Model::Namespace> instance corresponding to
C<$name>. The namespace must have been configured via
L<Elastic::Model/has_namespace>.
Use a C<$namespace> to create, delete and update
L<indices|Elastic::Manual::Terminology/Index> and
L<index aliases|Elastic::Manual::Terminology/Alias>.
=head2 domain()
$domain = $model->domain($name);
Returns an L<Elastic::Model::Domain> instance where C<$name> is the name
of an L<index|Elastic::Manual::Terminology/Index> or
L<index alias|Elastic::Manual::Terminology/Alias> (which points at a single
index) and is known to one of the L</namespaces>.
Use a C<$domain> to create, retrieve, update or delete individual
objects/documents.
=head2 view()
$view = $model->view(%args);
Creates a new L<Elastic::Model::View> instance. Any args are passed on to
L<Elastic::Model::View/"new()">.
Use a C<$view> to query your documents. Views can be multi-domain and
multi-type.
=head2 new_scope()
$scope = $model->new_scope();
Creates a new L<Elastic::Model::Scope> instance (in-memory cache). If there is
an existing scope, then the new scope inherits from the existing scope.
$scope = $model->new_scope(); # scope_1
$scope = $model->new_scope(); # scope_2, inherits from scope_1
undef $scope; # scope_2 and scope_1 are destroyed
Scopes are optional unless you have attributes which are weakened.
See L<Elastic::Model::Scoping> and L<Elastic::Model::Scope> to read more about
how scopes work.
=head1 OTHER METHODS AND ATTRIBUTES
These methods and attributes, while public, are usually used only by internal
modules. They are documented here for completeness.
=head2 CRUD
=head3 get_doc()
Normally, you want to use L<Elastic::Model::Domain/"get()"> rather than this
method.
$doc = $model->get_doc(uid => $uid);
$doc = $model->get_doc(uid => $uid, ignore_missing => 1, ...);
C<get_doc()> tries to retrieve the object corresponding to the
L<$uid|Elastic::Model::UID>, first from the L</current_scope()> (if there is one)
or from any of its parents. Failing that, it tries to retrieve the doc
from the L</store>. If it finds the doc, then
it stores it in the current scope (again, if there is one), otherwise it
throws an error.
C<get_doc()> also accepts an optional C<$source> parameter which is
used internally for inflating search results.
See L<Elastic::Model::Scope> for a more detailed explanation.
Any other args are passed on to L<Elastic::Model::Store/get_doc()>.
=head3 get_doc_source()
$doc = $model->get_doc_source(uid => $uid);
$doc = $model->get_doc_source(uid => $uid, ignore_missing => 1, ...);
Calls L<Elastic::Model::Store/"get_doc()"> and returns the raw source hashref
as stored in ElasticSearch for the doc with the corresponding
L<$uid|Elastic::Model::UID>. Throws an error if it doesn't exist.
Any other args are passed on to L<Elastic::Model::Store/get_doc()>.
=head3 doc_exists()
$bool = $model->doc_exists( uid => $uid, %args );
Calls L<Elastic::Model::Role::Store/doc_exists()> to check whether the doc
exists.
=head3 save_doc()
Normally, you want to use L<Elastic::Model::Role::Doc/"save()"> rather than this
method.
$doc = $model->save_doc(doc => $doc, %args);
Saves C<$doc> to ElasticSearch by calling
L<Elastic::Model::Store/"index_doc()"> (if the C<$doc> was originally loaded
from ElasticSearch), or L<Elastic::Model::Store/"create_doc()">, which
will throw an error if a doc with the same C<index|type|id> already
exists.
Any C<%args> are passed on to L<index_doc()|Elastic::Model::Store/"index_doc()"> or
L<create_doc()|Elastic::Model::Store/"create_doc()">.
If there is a L</current_scope()> then the object is also stored there.
Also see the L<Elastic::Model::Role::Doc/on_conflict> and
L<Elastic::Model::Role::Doc/on_unique> parameters.
=head3 delete_doc()
$uid = $model->delete_doc(uid => $uid, ignore_missing => 1, ...)
Calls L<Elastic::Model::Store/delete_doc()> and returns the updated
L<Elastic::Model::UID> object. Throws an error if it doesn't exist.
If there is a L</current_scope()> then an L<Elastic::Model::Deleted> object
is stored there.
=head3 search()
Normally, you want to use L<Elastic::Model::View> rather than this
method.
$results = $model->search(%args)
Passes C<%args> through to L<Elastic::Model::Store/"search()">
=head3 new_partial_doc()
part_doc = $model->new_partial_doc(
uid => $uid,
partial_source => \%source
);
Creates an instance of a partial doc (ie an object which contains only some of
the values stored in elasticsearch). These partial docs are useful when
your objects are large, and you need to display search results which
require only a few attributes, instead of the whole object.
Attempting to save a partial doc will cause an error to be thrown.
You shouldn't need to call this method yourself.
=head2 Miscellaneous
=head3 namespaces
\%namespaces = $model->namespaces;
A hashref whose keys are the namespace names, and whose values are the
corresponding L<Elastic::Model::Namespace> instances.
=head3 namespace_for_domain()
$namespace = $model->namespace_for_domain($domain_name)
Returns the L<Elastic::Model::Namespace> object which corresponds to the
C<$domain_name>. If the index (or alias) name is not yet known to the
C<$model>, it will update the known domain list from the namespace objects.
=head3 all_live_indices()
@indices = $model->all_live_indices();
Queries ElasticSearch to find all existing indices related to all namespaces
known to the model.
=head3 es
$es = $model->es
Returns the L<ElasticSearch> instance that was passed to L</"new()">.
=head3 es_unique
$uniq = $model->es_unique
Returns the L<ElasticSearchX::UniqueKey> instance pointing to the index
specified with L<has_unique_index|Elastic::Model/Custom unique key index>.
=head3 store
$store = $model->store
Returns the L<Elastic::Model::Store> instance.
=head2 Deflation, Inflation And Mapping
=head3 typemap
$typemap_class = $model->typemap;
Elastic::Model uses L<Elastic::Model::TypeMap::Default> (after
L<wrapping|/wrap_class()> it) to figure out how
to deflate and inflate your objects, and how to configure (map) them in
ElasticSearch.
You can specify your own type-map class in your model configuration with
L<has_typemap|Elastic::Model/Custom TypeMap>. See
L<Elastic::Model::TypeMap::Base> for instructions on how to define
your own type-map classes.
=head3 deflator_for_class()
$deflator = $model->deflator_for_class($class);
Returns a code-ref that knows how to deflate a class which does
L<Elastic::Model::Role::Doc>, and caches the deflator in L</"deflators">.
=head3 deflate_object()
$hash = $model->deflate_object($object);
Uses the deflator returned by L</"deflator_for_class()"> to deflate
an object which does L<Elastic::Model::Role::Doc> into a hash ref
suitable for conversion to JSON.
=head3 deflators
$deflators = $model->deflators
A hashref which caches all of the deflators which have been generated by
L</"deflator_for_class()">.
=head3 inflator_for_class()
$inflator = $model->inflator_for_class($class);
Returns a code-ref that knows how to inflate a plain hashref into the correct
attribute values for a class which does L<Elastic::Model::Role::Doc>,
and caches the inflator in L</"inflators">.
=head3 inflate_object()
$object = $model->inflate_object($object,$hash);
Uses the inflator returned by L</"inflator_for_class()"> to inflate
the attribute values of C<$object> from the value stored in C<$hash>.
=head3 inflators
$inflators = $model->inflators
A hashref which caches all of the inflators which have been generated by
L</"inflator_for_class()">.
=head3 map_class()
$mapping = $model->map_class($class);
Returns the type mapping / schema for a class which does
L<Elastic::Model::Role::Doc>, suitable for passing to ElasticSearch.
=head2 Scoping
Also see L</"new_scope()"> and L<Elastic::Model::Scope>.
=head3 current_scope()
$scope = $model->current_scope($scope);
Read/write accessor for the current scope. Throws an exception if no scope
is currently set.
=head3 detach_scope()
$model->detach_scope($scope);
Removes the passed in C<$scope> if it is the current scope. Replaces
the current scope with its parent scope, if there is one. L</"detach_scope()">
is called automatically when a scope goes out of scope:
{
my $scope = $model->new_scope;
# do work
}
# current scope is removed
=head3 has_current_scope()
$bool = $model->has_current_scope
Returns a true or false value signalling whether a L</"current_scope()">
exists.
=head3 clear_current_scope()
$model->clear_current_scope
Clears the L</"current_scope()">
=head2 Core classes
The following core classes are used internally by ElasticSearch, after
being wrapped by L</wrap_class()>, which pins the new anonymous class
to the current C<$model> instance. An instance of the wrapped class
can be created with, eg:
$domain = $model->domain_class->new(%args);
If you would like to override any of the core classes, then you can specify
them in your model setup using
L<override_classes|Elastic::Model/Overriding Core Classes>.
=head3 Default core classes:
=over
=item *
C<domain_class> C<--------------> L<Elastic::Model::Domain>
=item *
C<store_class> C<---------------> L<Elastic::Model::Store>
=item *
C<view_class> C<----------------> L<Elastic::Model::View>
=item *