MongoLink Introduction

MongoLink is a set of tools for working with MongoDB. This tutorial shows how to perform the most common MongoDB operations using MongoLink.

This tutorial assumes that a MongoDB server is running on your local machine at the default host and port. For platform-dependent instructions for running a MongoDB server locally, see this.

Making a Local Connection

Load MongoLink:

In[1]:=1

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-m80bby

Create a client connection using the default host "localhost" and port 27017 (this is the default hostname and port when running the MongoDB server on your local machine):

In[2]:=2

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-8bxqkz

Out[2]=2

The port and host can also be explicitly specified:

In[3]:=3

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-uwlulg

Out[3]=3

Or use the MongoDB Connection String URI format:

In[4]:=4

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-biyx3g

Out[4]=4

Connecting to a Database

A MongoDB server can host multiple independent databases. List the available databases on the server:

In[5]:=5

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-4noh3a

Out[5]=5

Connect to a database:

In[6]:=6

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-0akmtj

Out[6]=6

This is equivalent to the function:

In[7]:=7

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-6citby

Out[7]=7

Connecting to a Collection

A collection is a collection of documents. Getting a collection is the same as getting a database:

In[8]:=8

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-3ndcon

Out[8]=8

The above syntax is equivalent to:

In[9]:=9

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-roossq

Out[9]=9

Note: databases and collections are created lazily, so getting a collection or database does not perform any operations on the MongoDB server. They are only created once the first document is inserted into them.

Documents

A Document in MongoDB can be viewed as a (possibly) nested Association whose keys must be strings and whose values are limited to a small set of types (for example, strings, lists, integers, dates, etc). One simple example of a document:

In[10]:=10

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-5sfyj5

Out[10]=10

For a list available types that can be used as values, see the documentation for the "BSON" format.

Inserting a Single Document into a Collection

Insert the previous document into the "WolframTest" collection:

In[11]:=11

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-j6j48x

Out[11]=11

Get a list of the inserted document IDs:

In[12]:=12

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-1d8q6i

Out[12]=12

Note: Every MongoDB document must have an "_id" key. If this key is missing from the document being inserted, it is automatically added to the document with value of type BSONObjectID.

A BSONObjectID object contains various metadata related to its creation:

In[13]:=13

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-s0pvkn

Out[13]=13

Inserting Multiple Documents into a Collection

It is more efficient to insert many documents at once into a collection. Create a list of documents:

In[14]:=14

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-34vglk

Out[14]=14

Insert these two documents into the collection:

In[15]:=15

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-zb8wnz

Out[15]=15

Getting a Single Document

The simplest query is performed with MongoCollectionFindOne, which returns a single document from the collection:

In[16]:=16

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-ijy8lx

Out[16]=16

We can specify that we want to find a document of a three year old cat:

In[17]:=17

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-lcsola

Out[17]=17

Various keys that are not wanted can be eliminated using projection. Eliminating the "date" and "sex" fields:

In[18]:=18

✖

https://wolfram.com/xid/0bciup9ss2rgcyfpthi01u1ci-lpwj6m

Out[18]=18

This can be used to speed up the transfer of documents from the server, as unwanted parts of a document need not be transferred.

Note: for more information on building queries, the tutorial "Query Documents" from the MongoDB documentation might be useful.

Getting Multiple Documents

MongoCollectionFind has the same syntax as MongoCollectionFindOne, but instead of returning a document, it returns a MongoCursor, appropriate for handling large datasets:

In[19]:=19