vibe.db.mongo.connection

Low level mongodb protocol.

Copyright

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.

Authors

Sönke Ludwig

alias GetMoreDocumentDelegate GetMoreHeaderDelegate MongoErrorDescription MsgReplyDelegate MsgReplyDelegate MsgSection1Delegate MsgSection1Delegate MsgSection1StartDelegate ReplyDelegate

enum OpCode WireVersion

struct _MongoErrorDescription MongoDBInfo ServerDescription

class MongoAuthException MongoConnection MongoDBException MongoDriverException MongoException

fn getHostArchitecture sendLength

Types 19

private struct_MongoErrorDescription

Fields

string message

int code

int connectionId

int n

double ok

aliasMongoErrorDescription = immutable(_MongoErrorDescription)

D POD representation of Mongo error object.

For successful queries "code" is negative. Can be used also to check how many documents where updated upon a successful query via "n" field.

classMongoException : Exception

Root class for vibe.d Mongo driver exception hierarchy.

Constructors

this(string message, string file = __FILE__, size_t line = __LINE__, Throwable next = null)

classMongoDriverException : MongoException

Generic class for all exception related to unhandled driver problems.

I.e.: protocol mismatch or unexpected mongo service behavior.

Constructors

this(string message, string file = __FILE__, size_t line = __LINE__, Throwable next = null)

classMongoDBException : MongoException

deprecated Check for MongoException instead - the modern write commands now throw MongoBulkWriteException on error

Wrapper class for all inner mongo collection manipulation errors.

It does not indicate problem with vibe.d driver itself. Most frequently this one is thrown when MongoConnection is in checked mode and getLastError() has something interesting.

Fields

MongoErrorDescription description

Methods

int code() @property @safe const nothrow

int connectionId() @property @safe const nothrow

int n() @property @safe const nothrow

double ok() @property @safe const nothrow

Constructors

this(MongoErrorDescription description,  string file =  __FILE__,
			 size_t line =  __LINE__,  Throwable next =  null)

classMongoAuthException : MongoException

Generic class for all exceptions related to authentication problems.

I.e.: unsupported mechanisms or wrong credentials.

Constructors

this(string message, string file = __FILE__, size_t line = __LINE__, Throwable next = null)

classMongoConnection

[internal] Provides low-level mongodb protocol access.

It is not intended for direct usage. Please use vibe.db.mongo.db and vibe.db.mongo.collection modules for your code. Note that a MongoConnection may only be used from one fiber/thread at a time.

Fields

private MongoClientSettings m_settings

private TCPConnection m_conn

private InterfaceProxy!Stream m_stream

private ulong m_bytesRead

private int m_msgid

private StreamOutputRange!(InterfaceProxy!Stream) m_outRange

private ServerDescription m_description

private bool m_allowReconnectFlag to prevent recursive connections when server closes connection while connecting

private bool m_isAuthenticating

private bool m_supportsOpMsg

ushort defaultPort

Methods

void connect() @safe

void disconnect() @safe

bool connected() @property @safe const

const(ServerDescription) description() @property @safe const

void update(string collection_name, UpdateFlags flags, Bson selector, Bson update) @safe

void insert(string collection_name, InsertFlags flags, Bson[] documents) @safe

void query(T)(string collection_name,  QueryFlags flags,  int  nskip,  int  nret,  Bson query,  Bson returnFieldSelector,  scope  ReplyDelegate on_msg,  scope  DocDelegate!T on_doc)

@safe

Bson runCommand(T,  CommandFailException =  MongoDriverException)(
		 string database,
		 Bson command,
		 string errorInfo =  __FUNCTION__,
		 string errorFile =  __FILE__,
		 size_t errorLine =  __LINE__
	)

@safeRuns the given Bson command (Bson object with the first entry in the map being the command name) on the given database.

Bson runCommandUnchecked(T,  CommandFailException =  MongoDriverException)(
		 string database,
		 Bson command,
		 string errorInfo =  __FUNCTION__,
		 string errorFile =  __FILE__,
		 size_t errorLine =  __LINE__
	)

@safe

private

Bson runCommandImpl(T,  CommandFailException)(
		 string database,
		 Bson command,
		 bool  testOk =  true,
		 string errorInfo =  __FUNCTION__,
		 string errorFile =  __FILE__,
		 size_t errorLine =  __LINE__
	)

@safe

void startFind(T)(Bson command,
		 scope  GetMoreHeaderDelegate on_header,
		 scope  GetMoreDocumentDelegate!T on_doc,
		 string batchKey =  "firstBatch",
		 string errorInfo =  __FUNCTION__,  string errorFile =  __FILE__,  size_t errorLine =  __LINE__)

@safeForwards the `find` command passed in to the database, handles the callbacks like with getMore. This exists for easier integration with MongoCursor!T.

void delete_(string collection_name, DeleteFlags flags, Bson selector) @safe

void killCursors(scope long[] cursors) @safe

void killCursors(string collection, scope long[] cursors) @safe

MongoErrorDescription getLastError(string db) @safe

auto listDatabases() @safeQueries the server for all databases.

private

int recvMsg(bool  dupBson =  true)(int  reqid,
		 scope  MsgReplyDelegate!dupBson on_sec0,
		 scope  MsgSection1StartDelegate on_sec1_start,
		 scope  MsgSection1Delegate!dupBson on_sec1_doc)

@safe

private int recvReply(T)(int reqid, scope ReplyDelegate on_msg, scope DocDelegate!T on_doc) @safe

private int send(ARGS...)(OpCode code, int response_to, scope ARGS args) @safe

private int sendMsg(int response_to, uint flagBits, Bson document) @safe

private void sendValue(T)(scope T value) @safe

private void sendBytes(scope const(ubyte)[] data){ @safe

private T recvInteger(T)() @safe

private Bson recvBson(ref ubyte[] buf) @safe @system

private Bson recvBsonDup() @safe @trusted

private void recv(scope ubyte[] dst) @safe

private const(char)[] recvCString() @safe

private int nextMessageId() @safe

private void checkForError(string collection_name) @safe

private void certAuthenticate() @safe

private void authenticate() @safe

private void scramAuthenticate() @safe

Constructors

this(string server, ushort port = defaultPort)Simplified constructor overload, with no m_settings

this(MongoClientSettings cfg)

Nested Templates

getMore(T)

private enumOpCode : int

Reply = 1

Update = 2001

Insert = 2002

Reserved1 = 2003

Query = 2004

GetMore = 2005

Delete = 2006

KillCursors = 2007

Compressed = 2012

Msg = 2013

private aliasReplyDelegate = void delegate(long cursor, ReplyFlags flags, int first_doc, int num_docs) @safe

private aliasMsgReplyDelegate(bool dupBson : true) = void delegate(uint flags, Bson document) @safe

private aliasMsgReplyDelegate(bool dupBson : false) = void delegate(uint flags, scope Bson document) @safe

private aliasMsgSection1StartDelegate = void delegate(scope const(char)[] identifier, int size) @safe

private aliasMsgSection1Delegate(bool dupBson : true) = void delegate(scope const(char)[] identifier, Bson document) @safe

private aliasMsgSection1Delegate(bool dupBson : false) = void delegate(scope const(char)[] identifier, scope Bson document) @safe

aliasGetMoreHeaderDelegate = void delegate(long id, string ns, size_t count) @safe

aliasGetMoreDocumentDelegate(T) = void delegate(ref T document) @safe

structMongoDBInfo

Fields

string name

double sizeOnDisk

bool empty

structServerDescription

Fields

string address

string error

float roundTripTime

Nullable!BsonDate lastWriteDate

Nullable!BsonObjectID opTime

ServerType type

int minWireVersion

string me

string[] hosts

string[string] tags

string setName

Nullable!int setVersion

Nullable!BsonObjectID electionId

string primary

string lastUpdateTime

Nullable!int logicalSessionTimeoutMinutes

Methods

bool satisfiesVersion(WireVersion wireVersion) @optional @safe const @nogc pure nothrow

Nested Templates

ServerType

enumWireVersion : int

old = 0

v26 = 1

v26_2 = 2

v30 = 3

v32 = 4

v34 = 5

v36 = 6

v40 = 7

v42 = 8

v44 = 9

v49 = 12

v50 = 13

v51 = 14

v52 = 15

v53 = 16

v60 = 17

Functions 2

private fnint sendLength(ARGS...)(scope ARGS args)

private fnstring getHostArchitecture()

Variables 1

private varhostArchitecture = getHostArchitecture

Templates 1

tmplDocDelegate(T)