A MongoDb database.

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.

Introduced properties

fun client: MongoClient

mongodb :: MongoDb :: client

MongoClient used to load this database.
protected fun client=(client: MongoClient)

mongodb :: MongoDb :: client=

MongoClient used to load this database.
fun collection(name: String): MongoCollection

mongodb :: MongoDb :: collection

Loads or creates a collection by its name.
fun collection_names: Array[String]

mongodb :: MongoDb :: collection_names

Lists available collection names.
fun drop: Bool

mongodb :: MongoDb :: drop

Drop self, returns false if an error occured.
fun has_collection(name: String): Bool

mongodb :: MongoDb :: has_collection

Checks if a collection named name exists.
fun name: String

mongodb :: MongoDb :: name

The database name.
protected fun name=(name: String)

mongodb :: MongoDb :: name=

The database name.

Redefined properties

redef type SELF: MongoDb

mongodb $ MongoDb :: SELF

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

mongodb $ MongoDb :: finalize_once

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

mongodb $ MongoDb :: 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 client: MongoClient

mongodb :: MongoDb :: client

MongoClient used to load this database.
protected fun client=(client: MongoClient)

mongodb :: MongoDb :: client=

MongoClient used to load this database.
fun collection(name: String): MongoCollection

mongodb :: MongoDb :: collection

Loads or creates a collection by its name.
fun collection_names: Array[String]

mongodb :: MongoDb :: collection_names

Lists available collection names.
fun drop: Bool

mongodb :: MongoDb :: drop

Drop self, returns false if an error occured.
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 has_collection(name: String): Bool

mongodb :: MongoDb :: has_collection

Checks if a collection named name exists.
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 name: String

mongodb :: MongoDb :: name

The database name.
protected fun name=(name: String)

mongodb :: MongoDb :: name=

The database name.
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
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::MongoDb MongoDb core::FinalizableOnce FinalizableOnce mongodb::MongoDb->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 $ MongoDb
# A MongoDb database.
#
# 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.
class MongoDb
	super FinalizableOnce

	# `MongoClient` used to load this database.
	var client: MongoClient

	# The database name.
	var name: String

	private var native: NativeMongoDb is noinit

	init do native = new NativeMongoDb(client.native, name.to_cstring)

	# Lists available collection names.
	#
	# Returns `null` if an error occured. See `Sys::last_mongoc_error`.
	#
	# ~~~
	# 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 db.collection_names.has("test")
	# ~~~
	fun collection_names: Array[String] do
		var res = new Array[String]
		var nas = native.collection_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 collection by its `name`.
	#
	# ~~~
	# 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)
	# var col = db.collection("test")
	# assert col.name == "test"
	# ~~~
	fun collection(name: String): MongoCollection do
		return new MongoCollection(self, name)
	end

	# Checks if a collection named `name` exists.
	#
	# ~~~
	# 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 not db.has_collection("qwerty")
	# ~~~
	fun has_collection(name: String): Bool do
		# TODO handle error
		return native.has_collection(name.to_cstring)
	end

	# Drop `self`, returns false if an error occured.
	fun drop: Bool do return native.drop

	redef fun finalize_once do native.destroy
end
lib/mongodb/mongodb.nit:301,1--378,3