Mongo (mongodb-driver v0.7.4) View Source

The main entry point for doing queries. All functions take a topology to run the query on.

Generic options

All operations take these options.

  • :timeout - The maximum time that the caller is allowed the to hold the connection’s state (ignored when using a run/transaction connection, default: 15_000)
  • :checkout_timeout - The maximum time for checking out a new session and connection (default: 60_000). When the connection pool exhausted then the function call times out after :checkout_timeout.
  • :pool - The pooling behaviour module to use, this option is required unless the default DBConnection.Connection pool is used
  • :pool_timeout - The maximum time to wait for a reply when making a synchronous call to the pool (default: 5_000)
  • :queue - Whether to block waiting in an internal queue for the connection's state (boolean, default: true)
  • :log - A function to log information about a call, either a 1-arity fun, {module, function, args} with DBConnection.LogEntry.t prepended to args or nil. See DBConnection.LogEntry (default: nil)
  • :database - the database to run the operation on
  • :connect_timeout - maximum timeout for connect (default: 5_000)

Read options

All read operations that returns a cursor take the following options for controlling the behaviour of the cursor.

  • :batch_size - Number of documents to fetch in each batch
  • :limit - Maximum number of documents to fetch with the cursor
  • :read_preference - specifies the rules for selecting a server to query

Write options

All write operations take the following options for controlling the write concern.

  • :w - The number of servers to replicate to before returning from write operators, a 0 value will return immediately, :majority will wait until the operation propagates to a majority of members in the replica set (Default: 1)
  • :j If true, the write operation will only return after it has been committed to journal - (Default: false)
  • :wtimeout - If the write concern is not satisfied in the specified interval, the operation returns an error

Link to this section Summary

Functions

Executes an admin command against the admin database using alway the primary. Retryable writes are disabled.

Performs aggregation operation using the aggregation pipeline.

Issue a database command. If the command has parameters use a keyword list for the document because the "command key" has to be the first in the document.

Similar to command/3 but unwraps the result and raises on error.

Returns the count of documents that would match a find/4 query.

Similar to count_documents/4 but unwraps the result and raises on error.

Explicitly creates a collection or view.

Convenient function to creates new indexes in the collection coll. The indexes parameter is a list with all options for creating indexes in the MongoDB.

Remove all documents matching the filter from the collection.

Similar to delete_many/4 but unwraps the result and raises on error.

Remove a document matching the filter from the collection.

Similar to delete_one/4 but unwraps the result and raises on error.

Finds the distinct values for a specified field across a collection.

Similar to distinct/5 but unwraps the result and raises on error.

Convenient function that drops the collection coll.

Convenient function that drops the database name.

Convenient function that drops the index name in the collection coll.

Estimate the number of documents in a collection using collection metadata.

Similar to estimated_document_count/3 but unwraps the result and raises on error.

Selects documents in a collection and returns a cursor for the selected documents.

Selects a single document in a collection and returns either a document or nil.

Finds a document and updates it (using atomic modifiers).

Insert multiple documents into the collection.

Similar to insert_many/4 but unwraps the result and raises on error.

Insert a single document into the collection.

Similar to insert_one/4 but unwraps the result and raises on error.

This function is very fundamental.

Returns the limits of the database.

Convenient function that returns a cursor with the names of the indexes.

Returns a cursor to enumerate all indexes

Generates a new BSON.ObjectId.

Sends a ping command to the server.

Replace a single document matching the filter with the new document.

Similar to replace_one/5 but unwraps the result and raises on error.

In case of retryable reads are enabled, the keyword :read_counter is added with the value of 1.

In case of retryable writes are enabled, the keyword :write_counter is added with the value of 1.

Start and link to a database connection process.

Converts the DataTime to a MongoDB timestamp.

Update all documents matching the filter.

Similar to update_many/5 but unwraps the result and raises on error.

Update a single document matching the filter.

Similar to update_one/5 but unwraps the result and raises on error.

Creates a new UUID.

Converts the binary to UUID

Similar to uuid/1 except it will unwrap the error tuple and raise in case of errors.

Creates a change stream cursor all collections of the database.

Returns the wire version of the database

Link to this section Types

Specs

collection() :: String.t()

Specs

conn() :: DbConnection.Conn

Specs

cursor()

Specs

initial_type() :: :unknown | :single | :replica_set_no_primary | :sharded

Specs

result(t) :: :ok | {:ok, t} | {:error, Mongo.Error.t()}

Specs

result!(t) :: nil | t | no_return()

Link to this section Functions

Link to this function

admin_command(topology_pid, cmd)

View Source

Executes an admin command against the admin database using alway the primary. Retryable writes are disabled.

Example

iex> cmd = [

configureFailPoint: "failCommand",
mode: "alwaysOn",
data: [errorCode: 6, failCommands: ["commitTransaction"], errorLabels: ["TransientTransactionError"]]

]

iex> {:ok, _doc} = Mongo.admin_command(top, cmd)

Link to this function

aggregate(topology_pid, coll, pipeline, opts \\ [])

View Source

Specs

Performs aggregation operation using the aggregation pipeline.

For all options see Options

Link to this function

command(topology_pid, cmd, opts \\ [])

View Source

Specs

Issue a database command. If the command has parameters use a keyword list for the document because the "command key" has to be the first in the document.

Link to this function

command!(topology_pid, cmd, opts \\ [])

View Source

Specs

Similar to command/3 but unwraps the result and raises on error.

Link to this function

count_documents(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Returns the count of documents that would match a find/4 query.

Options

  • :limit - Maximum number of documents to fetch with the cursor
  • :skip - Number of documents to skip before returning the first
Link to this function

count_documents!(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Similar to count_documents/4 but unwraps the result and raises on error.

Link to this function

create(topology_pid, coll, opts \\ [])

View Source

Specs

create(GenServer.server(), collection(), Keyword.t()) ::
  :ok | {:error, Mongo.Error.t()}

Explicitly creates a collection or view.

Link to this function

create_indexes(topology_pid, coll, indexes, opts \\ [])

View Source

Specs

create_indexes(GenServer.server(), String.t(), [Keyword.t()], Keyword.t()) ::
  :ok | {:error, Mongo.Error.t()}

Convenient function to creates new indexes in the collection coll. The indexes parameter is a list with all options for creating indexes in the MongoDB.

See options about the details of each parameter.

Link to this function

delete_many(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Remove all documents matching the filter from the collection.

Link to this function

delete_many!(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Similar to delete_many/4 but unwraps the result and raises on error.

Link to this function

delete_one(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Remove a document matching the filter from the collection.

Link to this function

delete_one!(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Similar to delete_one/4 but unwraps the result and raises on error.

Link to this function

distinct(topology_pid, coll, field, filter, opts \\ [])

View Source

Specs

Finds the distinct values for a specified field across a collection.

Options

  • :max_time - Specifies a time limit in milliseconds
  • :collation - Optionally specifies a collation to use in MongoDB 3.4 and
Link to this function

distinct!(topology_pid, coll, field, filter, opts \\ [])

View Source

Specs

Similar to distinct/5 but unwraps the result and raises on error.

Link to this function

drop_collection(topology_pid, coll, opts \\ [])

View Source

Specs

drop_collection(GenServer.server(), String.t(), Keyword.t()) ::
  :ok | {:error, Mongo.Error.t()}

Convenient function that drops the collection coll.

Link to this function

drop_database(topology_pid, name \\ nil)

View Source

Specs

drop_database(GenServer.server(), String.t()) :: :ok | {:error, Mongo.Error.t()}

Convenient function that drops the database name.

Link to this function

drop_index(topology_pid, coll, name, opts \\ [])

View Source

Specs

drop_index(GenServer.server(), String.t(), String.t(), Keyword.t()) ::
  :ok | {:error, Mongo.Error.t()}

Convenient function that drops the index name in the collection coll.

Link to this function

estimated_document_count(topology_pid, coll, opts)

View Source

Specs

estimated_document_count(GenServer.server(), collection(), Keyword.t()) ::
  result(non_neg_integer())

Estimate the number of documents in a collection using collection metadata.

Link to this function

estimated_document_count!(topology_pid, coll, opts)

View Source

Specs

estimated_document_count!(GenServer.server(), collection(), Keyword.t()) ::
  result!(non_neg_integer())

Similar to estimated_document_count/3 but unwraps the result and raises on error.

Link to this function

find(topology_pid, coll, filter, opts \\ [])

View Source

Specs

find(GenServer.server(), collection(), BSON.document(), Keyword.t()) ::
  cursor() | {:error, term()}

Selects documents in a collection and returns a cursor for the selected documents.

For all options see Options

Use the underscore style, for example to set the option singleBatch use single_batch. Another example:

 Mongo.find(top, "jobs", %{}, batch_size: 2)
Link to this function

find_one(topology_pid, coll, filter, opts \\ [])

View Source

Specs

Selects a single document in a collection and returns either a document or nil.

If multiple documents satisfy the query, this method returns the first document according to the natural order which reflects the order of documents on the disk.

For all options see Options

Use the underscore style, for example to set the option readConcern use read_concern. Another example:

 Mongo.find_one(top, "jobs", %{}, read_concern: %{level: "local"})
Link to this function

find_one_and_delete(topology_pid, coll, filter, opts \\ [])

View Source

Specs

find_one_and_delete(
  GenServer.server(),
  collection(),
  BSON.document(),
  Keyword.t()
) :: result(BSON.document())

Finds a document and deletes it.

Options

  • :max_time - The maximum amount of time to allow the query to run (in MS)
  • :projection - Limits the fields to return for all matching documents.
  • :sort - Determines which document the operation modifies if the query selects multiple documents.
  • :collation - Optionally specifies a collation to use in MongoDB 3.4 and higher.
Link to this function

find_one_and_replace(topology_pid, coll, filter, replacement, opts \\ [])

View Source

Specs

Finds a document and replaces it.

Options

  • :bypass_document_validation - Allows the write to opt-out of document level validation
  • :max_time - The maximum amount of time to allow the query to run (in MS)
  • :projection - Limits the fields to return for all matching documents.
  • :return_document - Returns the replaced or inserted document rather than the original. Values are :before or :after. (default is :before)
  • :sort - Determines which document the operation modifies if the query selects multiple documents.
  • :upsert - Create a document if no document matches the query or updates the document.
  • :collation - Optionally specifies a collation to use in MongoDB 3.4 and higher.
Link to this function

find_one_and_update(topology_pid, coll, filter, update, opts \\ [])

View Source

Specs

find_one_and_update(
  GenServer.server(),
  collection(),
  BSON.document(),
  BSON.document(),
  Keyword.t()
) :: result(BSON.document()) | {:ok, nil}

Finds a document and updates it (using atomic modifiers).

Options

  • :bypass_document_validation - Allows the write to opt-out of document level validation
  • :max_time - The maximum amount of time to allow the query to run (in MS)
  • :projection - Limits the fields to return for all matching documents.
  • :return_document - Returns the replaced or inserted document rather than the original. Values are :before or :after. (default is :before)
  • :sort - Determines which document the operation modifies if the query selects multiple documents.
  • :upsert - Create a document if no document matches the query or updates the document.
  • :collation - Optionally specifies a collation to use in MongoDB 3.4 and
Link to this function

insert_many(topology_pid, coll, docs, opts \\ [])

View Source

Specs

Insert multiple documents into the collection.

If any of the documents is missing the _id field or it is nil, an ObjectId will be generated, and insertd into the document. Ids of all documents will be returned in the result struct.

Options

For more information about options see Options

Examples

Mongo.insert_many(pid, "users", [%{first_name: "John", last_name: "Smith"}, %{first_name: "Jane", last_name: "Doe"}])
Link to this function

insert_many!(topology_pid, coll, docs, opts \\ [])

View Source

Specs

Similar to insert_many/4 but unwraps the result and raises on error.

Link to this function

insert_one(topology_pid, coll, doc, opts \\ [])

View Source

Specs

Insert a single document into the collection.

If the document is missing the _id field or it is nil, an ObjectId will be generated, inserted into the document, and returned in the result struct.

Examples

Mongo.insert_one(pid, "users", %{first_name: "John", last_name: "Smith"})

{:ok, session} = Session.start_session(pid)
Session.start_transaction(session)
Mongo.insert_one(pid, "users", %{first_name: "John", last_name: "Smith"}, session: session)
Session.commit_transaction(session)
Session.end_session(pid)
Link to this function

insert_one!(topology_pid, coll, doc, opts \\ [])

View Source

Specs

Similar to insert_one/4 but unwraps the result and raises on error.

Link to this function

issue_command(topology_pid, cmd, atom, opts)

View Source

This function is very fundamental.

Specs

limits(GenServer.server()) :: {:ok, BSON.document()} | {:error, Mongo.Error.t()}

Returns the limits of the database.

Example

{:ok, top} = Mongo.start_link(...)
Mongo.limits(top)

{:ok, %{
   compression: nil,
   logical_session_timeout: 30,
   max_bson_object_size: 16777216,
   max_message_size_bytes: 48000000,
   max_wire_version: 8,
   max_write_batch_size: 100000,
   read_only: false
}}
Link to this function

list_index_names(topology_pid, coll, opts \\ [])

View Source

Specs

list_index_names(GenServer.server(), String.t(), Keyword.t()) :: %Stream{
  accs: term(),
  done: term(),
  enum: term(),
  funs: term()
}

Convenient function that returns a cursor with the names of the indexes.

Link to this function

list_indexes(topology_pid, coll, opts \\ [])

View Source

Specs

list_indexes(GenServer.server(), String.t(), Keyword.t()) :: cursor()

Returns a cursor to enumerate all indexes

Specs

object_id() :: BSON.ObjectId.t()

Generates a new BSON.ObjectId.

Specs

Sends a ping command to the server.

Link to this function

replace_one(topology_pid, coll, filter, replacement, opts \\ [])

View Source

Specs

Replace a single document matching the filter with the new document.

Options

  • :upsert - if set to true creates a new document when no document matches the filter (default: false)
Link to this function

replace_one!(topology_pid, coll, filter, replacement, opts \\ [])

View Source

Specs

Similar to replace_one/5 but unwraps the result and raises on error.

In case of retryable reads are enabled, the keyword :read_counter is added with the value of 1.

In other cases like

  • :retryable_reads is false or nil
  • :session is nil
  • :read_counter is nil

the opts is unchanged

Example

iex> Mongo.retryable_reads([retryable_reads: true]) [retryable_reads: true, read_counter: 1]

Link to this function

retryable_writes(opts, bool)

View Source

In case of retryable writes are enabled, the keyword :write_counter is added with the value of 1.

In other cases like

  • :retryable_writes is false or nil
  • :session is nil
  • :write_counter is nil

the opts is unchanged

Example

iex> Mongo.retryable_writes([retryable_writes: true], true) [retryable_writes: true, write_counter: 1]

Link to this function

show_collections(topology_pid, opts \\ [])

View Source

Specs

show_collections(GenServer.server(), Keyword.t()) :: cursor()

Getting Collection Names

Specs

start_link(Keyword.t()) :: {:ok, pid()} | {:error, Mongo.Error.t() | atom()}

Start and link to a database connection process.

Options

  • :database - The database to use (required)
  • :hostname - The host to connect to (require)
  • :port - The port to connect to your server (default: 27017)
  • :url - A mongo connection url. Can be used in place of :hostname and :database (optional)
  • :socket_dir - Connect to MongoDB via UNIX sockets in the given directory. The socket name is derived based on the port. This is the preferred method for configuring sockets and it takes precedence over the hostname. If you are connecting to a socket outside of the MongoDB convection, use :socket instead.
  • :socket - Connect to MongoDB via UNIX sockets in the given path. This option takes precedence over :hostname and :socket_dir.
  • :database (optional)
  • :seeds - A list of host names in the cluster. Can be used in place of :hostname (optional)
  • :username - The User to connect with (optional)
  • :password - The password to connect with (optional)
  • :auth - List of additional users to authenticate as a keyword list with :username and :password keys (optional)
  • :auth_source - The database to authenticate against
  • :appname - The name of the application used the driver for the MongoDB-Handshake
  • :set_name - The name of the replica set to connect to (required if connecting to a replica set)
  • :type - a hint of the topology type. See initial_type/0 for valid values (default: :unknown)
  • :idle - The idle strategy, :passive to avoid checkin when idle and :active to checking when idle (default: :passive)
  • :idle_timeout - The idle timeout to ping the database (default: 1_000)
  • :connect_timeout - The maximum timeout for the initial connection (default: 5_000)
  • :backoff_min - The minimum backoff interval (default: 1_000)
  • :backoff_max - The maximum backoff interval (default: 30_000)
  • :backoff_type - The backoff strategy, :stop for no backoff and to stop, :exp of exponential, :rand for random and :ran_exp for random exponential (default: :rand_exp)
  • :after_connect - A function to run on connect use run/3. Either a 1-arity fun, {module, function, args} with DBConnection.t, prepended to args or nil (default: nil)
  • :auth_mechanism - options for the mongo authentication mechanism, currently only supports :x509 atom as a value
  • :ssl - Set to true if ssl should be used (default: false)
  • :ssl_opts - A list of ssl options, see the ssl docs

Error Reasons

  • :single_topology_multiple_hosts - A topology of :single was set but multiple hosts were given
  • :set_name_bad_topology - A :set_name was given but the topology was set to something other than :replica_set_no_primary or :single

Specs

timestamp(DateTime.t()) :: BSON.Timestamp.t()

Converts the DataTime to a MongoDB timestamp.

Link to this function

update_many(topology_pid, coll, filter, update, opts \\ [])

View Source

Specs

Update all documents matching the filter.

Uses MongoDB update operators to specify the updates. For more information and all options please refer to the MongoDB documentation

Link to this function

update_many!(topology_pid, coll, filter, update, opts \\ [])

View Source

Specs

Similar to update_many/5 but unwraps the result and raises on error.

Link to this function

update_one(topology_pid, coll, filter, update, opts \\ [])

View Source

Specs

Update a single document matching the filter.

Uses MongoDB update operators to specify the updates. For more information please refer to the MongoDB documentation

Example:

Mongo.update_one(MongoPool,
  "my_test_collection",
  %{"filter_field": "filter_value"},
  %{"$set": %{"modified_field": "new_value"}})

Options

  • :upsert - if set to true creates a new document when no document matches the filter (default: false)
Link to this function

update_one!(topology_pid, coll, filter, update, opts \\ [])

View Source

Specs

Similar to update_one/5 but unwraps the result and raises on error.

Creates a new UUID.

Specs

uuid(String.t()) ::
  {:ok, BSON.Binary.t()}
  | {:error, %ArgumentError{__exception__: term(), message: term()}}
uuid(String.t()) :: BSON.Binary.t()

Converts the binary to UUID

Example

iex> Mongo.uuid("848e90e9-5750-4e0a-ab73-66ac6b328242")
{:ok, #BSON.UUID<848e90e9-5750-4e0a-ab73-66ac6b328242>}

iex> Mongo.uuid("848e90e9-5750-4e0a-ab73-66ac6b328242x")
{:error, %ArgumentError{message: "invalid UUID string"}}

iex> Mongo.uuid("848e90e9-5750-4e0a-ab73-66-c6b328242")
{:error, %ArgumentError{message: "non-alphabet digit found: "-" (byte 45)"}}

Similar to uuid/1 except it will unwrap the error tuple and raise in case of errors.

Example

iex> Mongo.uuid!("848e90e9-5750-4e0a-ab73-66ac6b328242")
#BSON.UUID<848e90e9-5750-4e0a-ab73-66ac6b328242>

iex> Mongo.uuid!("848e90e9-5750-4e0a-ab73-66ac6b328242x")
** (ArgumentError) invalid UUID string
(mongodb_driver 0.6.4) lib/mongo.ex:205: Mongo.uuid!/1
Link to this function

watch_collection(topology_pid, coll, pipeline, on_resume_token \\ nil, opts \\ [])

View Source

Specs

watch_collection(
  GenServer.server(),
  collection() | 1,
  [BSON.document()],
  (... -> any()),
  Keyword.it()
) :: cursor()

Creates a change stream cursor on collections.

on_resume_token is function that takes the new resume token, if it changed.

Options

  • :full_document -
  • :max_time - Specifies a time limit in milliseconds. This option is used on getMore commands
  • :batch_size - Specifies the number of maximum number of documents to return (default: 1)
  • :resume_after - Specifies the logical starting point for the new change stream.
  • :start_at_operation_time - The change stream will only provide changes that occurred at or after the specified timestamp (since 4.0)
  • :start_after - Similar to resumeAfter, this option takes a resume token and starts a new change stream returning the first notification after the token. This will allow users to watch collections that have been dropped and recreated or newly renamed collections without missing any notifications. (since 4.0.7)
Link to this function

watch_db(topology_pid, pipeline, on_resume_token \\ nil, opts \\ [])

View Source

Specs

watch_db(GenServer.server(), [BSON.document()], (... -> any()), Keyword.it()) ::
  cursor()

Creates a change stream cursor all collections of the database.

on_resume_token is function that takes the new resume token, if it changed.

Options

  • :full_document -
  • :max_time - Specifies a time limit in milliseconds. This option is used on getMore commands
  • :batch_size - Specifies the number of maximum number of documents to return (default: 1)
  • :resume_after - Specifies the logical starting point for the new change stream.
  • :start_at_operation_time - The change stream will only provide changes that occurred at or after the specified timestamp (since 4.0)
  • :start_after - Similar to resumeAfter, this option takes a resume token and starts a new change stream returning the first notification after the token. This will allow users to watch collections that have been dropped and recreated or newly renamed collections without missing any notifications. (since 4.0.7)
Link to this function

wire_version(topology_pid)

View Source

Specs

wire_version(GenServer.server()) :: {:ok, integer()} | {:error, Mongo.Error.t()}

Returns the wire version of the database

Example

{:ok, top} = Mongo.start_link(...)
Mongo.wire_version(top)

{:ok, 8}