Module mongoc

Client for a MongoDB instance, a replica set, or a set of mongoses.

Authors: Alexander Hudich (alttagil@gmail.com).

Description

Client for a MongoDB instance, a replica set, or a set of mongoses.

Data Types

colldb()

colldb() = collection() | {database(), collection()}

collection()

collection() = binary() | atom()

connectoptions()

connectoptions() = [coption()]

coption()

coption() = {name, atom()} | {register, atom()} | {pool_size, integer()} | {max_overflow, integer()} | {localThresholdMS, integer()} | {connectTimeoutMS, integer()} | {socketTimeoutMS, integer()} | {serverSelectionTimeoutMS, integer()} | {waitQueueTimeoutMS, integer()} | {heartbeatFrequencyMS, integer()} | {minHeartbeatFrequencyMS, integer()} | {rp_mode, readmode()} | {rp_tags, list()}

database()

database() = binary() | atom()

host()

host() = list()

projector()

projector() = bson:document() | map()

query()

query() = #query{database = database(), collection = colldb(), tailablecursor = boolean(), slaveok = boolean(), sok_overriden = boolean(), nocursortimeout = boolean(), awaitdata = boolean(), skip = mc_worker_api:skip(), batchsize = mc_worker_api:batchsize(), selector = mc_worker_api:selector(), projector = mc_worker_api:projector()}

readmode()

readmode() = primary | secondary | primaryPreferred | secondaryPreferred | nearest

seed()

seed() = host() | {rs, binary(), [host()]} | {single, host()} | {unknown, [host()]} | {sharded, [host()]}

selector()

selector() = map() | bson:document()

woption()

woption() = {database, database()} | {login, binary()} | {password, binary()} | {w_mode, mc_worker_api:write_mode()}

workeroptions()

workeroptions() = [woption()]

Function Index

connect/3Creates new topology discoverer, return its pid.
disconnect/1
status/1
transaction/2
transaction/3
transaction/4Get worker from pool and run transaction with it.
transaction_query/2Get worker from pool and run transaction with additioanl query options on it.
transaction_query/3
transaction_query/4
find_one_query/5
find_query/6
count_query/4
append_read_preference/2

Function Details

connect/3

connect(Seeds::seed(), Options::connectoptions(), WorkerOptions::workeroptions()) -> {ok, Pid::pid()} | ignore | {error, Reason::term()}

Creates new topology discoverer, return its pid

disconnect/1

disconnect(Topology::pid()) -> ok

status/1

status(Topology::pid() | atom()) -> {atom(), integer(), integer(), integer()}

transaction/2

transaction(Topology::pid() | atom(), Transaction::function()) -> any()

transaction/3

transaction(Topology::pid() | atom(), Transaction::function(), Options::map()) -> any()

transaction/4

transaction(Topology::pid() | atom(), Transaction::function(), Options::map(), Timeout::integer() | infinity) -> any()

Get worker from pool and run transaction with it. Suitable for command transactions

transaction_query/2

transaction_query(Topology::pid() | atom(), Transaction::function()) -> any()

Get worker from pool and run transaction with additioanl query options on it. Suitable for read transactions

transaction_query/3

transaction_query(Topology::pid() | atom(), Transaction::function(), Options::map()) -> any()

transaction_query/4

transaction_query(Topology::pid() | atom(), Transaction::function(), Options::map(), Timeout::integer() | infinity) -> any()

find_one_query/5

find_one_query(X1::map(), Coll::collection(), Selector::selector(), Projector::projector(), Skip::integer()) -> query()

find_query/6

find_query(X1::map(), Coll::collection(), Selector::selector(), Projector::projector(), Skip::integer(), BatchSize::integer()) -> query()

count_query/4

count_query(X1::map(), Coll::collection(), Selector::selector(), Limit::integer()) -> query()

append_read_preference/2

append_read_preference(Selector::selector(), RP::map()) -> selector()


Generated by EDoc