/usr/lib/perl5/MongoDB/Examples.pod is in libmongodb-perl 0.702.1+ds-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #
# Copyright 2009-2013 10gen, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# PODNAME: MongoDB::Examples
# ABSTRACT: Some examples of MongoDB syntax
__END__
=pod
=head1 NAME
MongoDB::Examples - Some examples of MongoDB syntax
=head1 VERSION
version 0.702.1
=head1 MAPPING SQL TO MONGODB
For developers familiar with SQL, the following chart should help you see how
many common SQL queries could be expressed in MongoDB.
These are Perl-specific examples of translating SQL queries to MongoDB's query
language. To see the JavaScript (or other languages') mappings, see
L<http://dochub.mongodb.org/core/sqlToMongo>.
In the following examples, C<$db> is a L<MongoDB::Database> object which was
retrieved by using C<get_database>. See L<MongoDB::MongoClient> for more.
=over
=item C<CREATE TABLE USERS (a Number, b Number)>
Implicit, can be done explicitly.
=item C<INSERT INTO USERS VALUES(1,1)>
$db->get_collection( 'users' )->insert( { a => 1, b => 1 } );
=item C<SELECT a,b FROM users>
$db->get_collection( 'users')->find( { }, { a => 1, b => 1 } );
=item C<SELECT * FROM users>
$db->get_collection( 'users' )->find;
=item C<SELECT * FROM users WHERE age=33>
$db->get_collection( 'users' )->find( { age => 33 } )
=item C<SELECT a,b FROM users WHERE age=33>
$db->get_collection( 'users' )->find( { age => 33 }, { a => 1, b => 1 } );
=item C<SELECT * FROM users WHERE age=33 ORDER BY name>
$db->get_collection( 'users' )->find( { age => 33 } )->sort( { name => 1 } );
=item C<<SELECT * FROM users WHERE age>33>>
$db->get_collection( 'users' )->find( { age => { '$gt' => 33 } } );
=item C<<SELECT * FROM users WHERE age<33>>
$db->get_collection( 'users' )->find( { age => { '$lt' => 33 } } );
=item C<SELECT * FROM users WHERE name LIKE "%Joe%">
$db->get_collection( 'users' )->find( { name => qr/Joe/ } );
=item C<SELECT * FROM users WHERE name LIKE "Joe%">
$db->get_collection( 'users' )->find( {name => qr/^Joe/ } );
=item C<<SELECT * FROM users WHERE age>33 AND age<=40>>
$db->get_collection( 'users' )->find( { age => { '$gt' => 33, '$lte' => 40 } } );
=item C<SELECT * FROM users ORDER BY name DESC>
$db->get_collection( 'users' )->find->sort( { name => -1 } );
=item C<CREATE INDEX myindexname ON users(name)>
$db->get_collection( 'users' )->ensure_index( { name => 1 } );
=item C<CREATE INDEX myindexname ON users(name,ts DESC)>
$db->get_collection( 'users' )->ensure_index( Tie::IxHash->new( name => 1, ts => -1 ) );
In this example, we must use L<Tie::IxHash> to preserve the ordering of the arguments to
C<ensureIndex>.
=item C<SELECT * FROM users WHERE a=1 and b='q'>
$db->get_collection( 'users' )->find( {a => 1, b => "q" } );
=item C<SELECT * FROM users LIMIT 10 SKIP 20>
$db->get_collection( 'users' )->find->limit(10)->skip(20);
=item C<SELECT * FROM users WHERE a=1 or b=2>
$db->get_collection( 'users' )->find( { '$or' => [ {a => 1 }, { b => 2 } ] } );
=item C<SELECT * FROM users LIMIT 1>
$db->get_collection( 'users' )->find->limit(1);
=item C<EXPLAIN SELECT * FROM users WHERE z=3>
$db->get_collection( 'users' )->find( { z => 3 } )->explain;
=item C<SELECT DISTINCT last_name FROM users>
$db->run_command( { distinct => "users", key => "last_name" } );
=item C<SELECT COUNT(*y) FROM users>
$db->get_collection( 'users' )->count;
=item C<<SELECT COUNT(*y) FROM users where age > 30>>
$db->get_collection( 'users' )->find( { "age" => { '$gt' => 30 } } )->count;
=item C<SELECT COUNT(age) from users>
$db->get_collection( 'users' )->find( { age => { '$exists' => 1 } } )->count;
=item C<UPDATE users SET a=1 WHERE b='q'>
$db->get_collection( 'users' )->update( { b => "q" }, { '$set' => { a => 1 } } );
=item C<UPDATE users SET a=a+2 WHERE b='q'>
$db->get_collection( 'users' )->update( { b => "q" }, { '$inc' => { a => 2 } } );
=item C<DELETE FROM users WHERE z="abc">
$db->get_database( 'users' )->remove( { z => "abc" } );
=back
=head1 DATABASE COMMANDS
If you do something in the MongoDB shell and you would like to translate it to
Perl, the best way is to run the function in the shell without parentheses, which
will print the source. You can then generally translate the source into Perl
fairly easily.
For example, suppose we want to use C<db.foo.validate> in Perl. We could
run:
> db.foo.validate
function (full) {
var cmd = {validate:this.getName()};
if (typeof full == "object") {
Object.extend(cmd, full);
} else {
cmd.full = full;
}
var res = this._db.runCommand(cmd);
if (typeof res.valid == "undefined") {
res.valid = false;
var raw = res.result || res.raw;
if (raw) {
var str = "-" + tojson(raw);
res.valid = !(str.match(/exception/) || str.match(/corrupt/));
var p = /lastExtentSize:(\d+)/;
var r = p.exec(str);
if (r) {
res.lastExtentSize = Number(r[1]);
}
}
}
return res;
}
Thus, we can translate the important parts into Perl:
$db->run_command( { validate => "foo" } );
=head2 Distinct
The distinct command returns all values for a given key in a collection. For
example, suppose we had a collection with the following documents (C<_id> value
ignored):
{ 'name' => 'a', code => 1 }
{ 'name' => 'b', code => 1 }
{ 'name' => 'c', code => 2 }
{ 'name' => 'd', code => "3" }
If we wanted to see all of values in the "code" field, we could run:
my $result = $db->run_command([
"distinct" => "collection_name",
"key" => "code",
"query" => { }
]);
Notice that the arguments are in an array, to ensure that their order is
preserved. You could also use a L<Tie::IxHash>.
C<query> is an optional argument, which can be used to only run C<distinct> on
specific documents. It takes a hash (or L<Tie::IxHash> or array) in the same
form as L<MongoDB::Collection/"find($query)">.
Running C<distinct> on the above collection would give you:
{
'ok' => '1',
'values' => [
1,
2,
"3"
]
};
=head2 Find-and-modify
The find-and-modify command is similar to update (or remove), but it will return
the modified document. It can be useful for implementing queues or locks.
For example, suppose we had a list of things to do, and we wanted to remove the
highest-priority item for processing. We could do a L<MongoDB::Collection/find>
and then a L<MongoDB::Collection/remove>, but that wouldn't be atomic (a write
could occur between the query and the remove). Instead, we can use find and
modify.
my $next_task = $db->run_command({
findAndModify => "todo",
sort => {priority => -1},
remove => 1
});
This will atomically find and pop the next-highest-priority task.
See L<http://www.mongodb.org/display/DOCS/findAndModify+Command> for more
details on find-and-modify.
=head2 Group
The group command is similar to "GROUP BY" in SQL. You can use the
L<MongoDB::Database/run_command> method to perform group-bys with MongoDB.
For example, suppose we have a number of local businesses stored in a "business"
collection. If we wanted to find the number of coffeeshops in each neighborhood, we
could do:
my $reduce = <<REDUCE;
function(doc, prev) {
for (var t in doc.tags) {
if (doc.tags[t] == "coffeeshop") {
prev["num coffeeshops"]++;
break;
}
}
}
REDUCE
my $result = $db->run_command({group => {
'ns' => "business",
'key' => {"neighborhood" => 1},
'initial' => {"num coffeeshops" => 0},
'$reduce' => MongoDB::Code->new(code => $reduce)
This would return something like:
{
'ok' => '1',
'keys' => 4,
'count' => '487', # total number of documents
'retval' => [
{
'neighborhood' => 'Soho',
'num coffeeshops' => '23'
},
{
'neighborhood' => 'Chinatown',
'num coffeeshops' => '14'
},
{
'neighborhood' => 'Upper East Side',
'num coffeeshops' => '10'
},
{
'neighborhood' => 'East Village',
'num coffeeshops' => '87'
}
]
};
Thus, there are 23 coffeeshops in Soho, 14 in Chinatown, and so on.
See L<http://www.mongodb.org/display/DOCS/Aggregation> for more details on
grouping.
=head2 MapReduce
MapReduce is a powerful aggregation tool. (For traditional queries, you should
use C<MongoDB::Collection::query>.)
This example counts the number of occurences of each tag in a collection. Each
document contains a "tags" array that contains zero or more strings.
my $map = <<MAP;
function() {
this.tags.forEach(function(tag) {
emit(tag, {count : 1});
});
}
MAP
my $reduce = <<REDUCE;
function(prev, current) {
result = {count : 0};
current.forEach(function(item) {
result.count += item.count;
});
return result;
}
REDUCE
my $cmd = Tie::IxHash->new("mapreduce" => "foo",
"map" => $map,
"reduce" => $reduce);
my $result = $db->run_command($cmd);
See the MongoDB documentation on MapReduce for more information
(L<http://dochub.mongodb.org/core/mapreduce>).
=head1 QUERYING
=head2 Nested Fields
MongoDB allows you to store deeply nested structures and then query for fields
within them using I<dot-notation>. For example, suppose we have a users
collection with documents that look like:
{
"userId" => 12345,
"address" => {
"street" => "123 Main St",
"city" => "Springfield",
"state" => "MN",
"zip" => "43213"
}
}
If we want to query for all users from Springfield, we can do:
my $cursor = $users->find({"address.city" => "Springfield"});
This will search documents for an "address" field that is a subdocument and a
"city" field within the subdocument.
=head1 UPDATING
=head2 Positional Operator
In MongoDB 1.3.4 and later, you can use positional operator, C<$>, to update
elements of an array. For instance, suppose you have an array of user
information and you want to update a user's name.
A sample document in JavaScript:
{
"users" : [
{
"name" : "bill",
"age" : 60
},
{
"name" : "fred",
"age" : 29
},
]
}
The update:
$coll->update({"users.name" => "fred"}, {'users.$.name' => "george"});
This will update the array so that the element containing C<"name" =E<gt> "fred">
now has C<"name" =E<gt> "george">.
=head1 AUTHORS
=over 4
=item *
Florian Ragwitz <rafl@debian.org>
=item *
Kristina Chodorow <kristina@mongodb.org>
=item *
Mike Friedman <mike.friedman@10gen.com>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by 10gen, Inc..
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
|