The MongoClient is used to connect to the mongo server and send queries.

Usage:

var uri = "mongodb://mongo:27017/"
var client = new MongoClient(uri)
assert client.server_uri == uri

Introduced properties

fun close

mongodb :: MongoClient :: close

Close the connexion and destroy the instance.
fun database(name: String): MongoDb

mongodb :: MongoClient :: database

Loads or creates a database from its name.
fun database_names: Array[String]

mongodb :: MongoClient :: database_names

Lists available database names.
init defaultinit(server_uri: String)

mongodb :: MongoClient :: defaultinit

fun last_error: nullable MongoError

mongodb :: MongoClient :: last_error

Last error raised by mongoc.
fun server_status: nullable JsonObject

mongodb :: MongoClient :: server_status

Gets server data.
fun server_uri: String

mongodb :: MongoClient :: server_uri

Server URI.
protected fun server_uri=(server_uri: String)

mongodb :: MongoClient :: server_uri=

Server URI.

Redefined properties

redef type SELF: MongoClient

mongodb $ MongoClient :: SELF

Type of this instance, automatically specialized in every class
redef fun finalize_once

mongodb $ MongoClient :: finalize_once

Real finalization method of FinalizableOnce, will be called only once
redef init init

mongodb $ MongoClient :: init

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun close

mongodb :: MongoClient :: close

Close the connexion and destroy the instance.
fun database(name: String): MongoDb

mongodb :: MongoClient :: database

Loads or creates a database from its name.
fun database_names: Array[String]

mongodb :: MongoClient :: database_names

Lists available database names.
init defaultinit(server_uri: String)

mongodb :: MongoClient :: defaultinit

fun finalize

core :: Finalizable :: finalize

Liberate any resources held by self before the memory holding self is freed
protected fun finalize_once

core :: FinalizableOnce :: finalize_once

Real finalization method of FinalizableOnce, will be called only once
fun finalized: Bool

core :: FinalizableOnce :: finalized

Has self been finalized? (either by the GC or an explicit call to finalize)
protected fun finalized=(finalized: Bool)

core :: FinalizableOnce :: finalized=

Has self been finalized? (either by the GC or an explicit call to finalize)
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun last_error: nullable MongoError

mongodb :: MongoClient :: last_error

Last error raised by mongoc.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun server_status: nullable JsonObject

mongodb :: MongoClient :: server_status

Gets server data.
fun server_uri: String

mongodb :: MongoClient :: server_uri

Server URI.
protected fun server_uri=(server_uri: String)

mongodb :: MongoClient :: server_uri=

Server URI.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram mongodb::MongoClient MongoClient core::FinalizableOnce FinalizableOnce mongodb::MongoClient->core::FinalizableOnce core::Finalizable Finalizable core::FinalizableOnce->core::Finalizable ...core::Finalizable ... ...core::Finalizable->core::Finalizable

Ancestors

class Finalizable

core :: Finalizable

An object needing finalization
interface Object

core :: Object

The root of the class hierarchy.

Parents

class FinalizableOnce

core :: FinalizableOnce

An object to be finalized only once

Class definitions

mongodb $ MongoClient
# The MongoClient is used to connect to the mongo server and send queries.
#
# Usage:
#
# ~~~
# var uri = "mongodb://mongo:27017/"
# var client = new MongoClient(uri)
# assert client.server_uri == uri
# ~~~
class MongoClient
	super FinalizableOnce

	# Server URI.
	var server_uri: String

	private var native: NativeMongoClient is noinit

	init do native = new NativeMongoClient(server_uri.to_cstring)

	# Gets server data.
	#
	# Returns `null` if an error occured. See `last_error`.
	#
	# ~~~
	# var client = new MongoClient("mongodb://mongo:27017/")
	# assert client.server_status["process"] == "mongod"
	# ~~~
	fun server_status: nullable JsonObject do
		var nbson = native.server_status
		if nbson == null then return null
		var bson = new BSON(nbson)
		var res = new JsonObject.from_bson(bson)
		return res
	end

	# Lists available database names.
	#
	# ~~~
	# var client = new MongoClient("mongodb://mongo:27017/")
	# var db_suffix = "NIT_TESTING_ID".environ
	# var db_name = "test_{db_suffix}"
	# var db = client.database(db_name)
	# db.collection("test").insert(new JsonObject)
	# assert client.database_names.has(db_name)
	# ~~~
	fun database_names: Array[String] do
		var res = new Array[String]
		var nas = native.database_names
		if nas == null then return res
		var i = 0
		var name = nas[i]
		while not name.address_is_null do
			res.add name.to_s
			name.free
			i += 1
			name = nas[i]
		end
		return res
	end

	# Loads or creates a database from its `name`.
	#
	# Database are automatically created on the MongoDB server upon insertion of
	# the first document into a collection.
	# There is no need to create a database manually.
	#
	# ~~~
	# var client = new MongoClient("mongodb://mongo:27017/")
	# var db_suffix = "NIT_TESTING_ID".environ
	# var db_name = "test_{db_suffix}"
	# var db = client.database(db_name)
	# assert db.name == db_name
	# ~~~
	fun database(name: String): MongoDb do return new MongoDb(self, name)

	# Close the connexion and destroy the instance.
	#
	# The reference should not be used beyond this point!
	fun close do finalize_once

	redef fun finalize_once do native.destroy

	# Last error raised by mongoc.
	fun last_error: nullable MongoError do
		var last_error = sys.last_mongoc_error
		if last_error == null then return null
		return new MongoError(last_error)
	end

	# Last auto generated id.
	private fun last_id: nullable MongoObjectId do
		var last_id = sys.last_mongoc_id
		if last_id == null then return null
		return new MongoObjectId.with_native(last_id)
	end

	# Set the last generated id or `null` to unset once used.
	private fun last_id=(id: nullable MongoObjectId) do
		if id == null then
			sys.last_mongoc_id = null
		else
			sys.last_mongoc_id = id.native
		end
	end
end
lib/mongodb/mongodb.nit:195,1--299,3