mongo-driver-godot's Introduction

Mongo Driver for Godot

(Get it from Godot Asset Library - Coming Soon)

Documentation

Unofficial MongoDB driver for Godot Engine 3.3.

Should support Windows, Linux, OSX (Currently only built on Windows)

Features

CRUD operations on Database/Collection
Document validation
Pipeline / Aggregation operations
Run commands on Database
Operations on Collection Indexes

Installation

This is a regular plugin for Godot. Copy the contents of addons/mongo-driver-godot into the addons/ folder in the same directory as your project (There is NO need to activate the plugin in ProjectSettings).

For in-depth installation instructions check the Installation Wiki

For Linux / OSX see Building the plugin

Getting Started

You may have to restart the Godot Editor to register the GDNative classes.
A basic example is given below:

extends Node

func _ready():
    var driver: MongoDriver = MongoDriver.new()
    var connection: MongoConnection = driver.connect_to_server("mongodb://localhost:27017")

    # Check for an error
    if Mongo.is_error(connection):
        print("Got error: ", connection)
        return

    # Print the names of the all the databases
    print(connection.get_database_names())

Benchmarks

Tested on Windows 10 21H2 x64 (Godot 3.4.2) To test locally run the scripts in tests/benchmark folder using the tester addon.

See example script in scripts/run_tests.bat Click for in-depth testing instructions

Operation	Number of Documents	Time (s)
Insert one	10	0.49
Insert one	10,000	4.68
Insert many	10	0.68
Insert many	10,000	0.90

Thirdparty Libraries

See Thirdparty Libraries

Documentation

Contributing

This plugin is a non-profit project developped by voluntary contributors.

Supporters

None, you can be the first one!

Support the project development

Want to support in other ways? Contact me on Discord: @3ddelano#6033

For help / suggestions join: 3ddelano Cafe

Disclaimer: This project is not affiliated nor endorsed by MongoDB Inc. nor Godot Engine

mongo-driver-godot's People

Contributors

Stargazers

Watchers

mongo-driver-godot's Issues

SSL connections

Hello, I would like to know if there are any plans to add the ability to make encrypted connections?

It doesn't seem complicated: https://mongocxx.org/mongocxx-v3/configuration/

Really nice job by the way !

Usage with Godot Mono (C#)

Although this plugin doesn't natively support C# we can still use this plugin in Godot projects if you really want to.
The best approach would be to use the Official C# mongodb package

using Godot;
using System;

public class Main : Control
{
    public override void _Ready()
    {
        GDScript MongoDriver = (GDScript) GD.Load("res://addons/mongo-driver-godot/wrapper/mongo_driver.gd");
        // Need to manually type-cast to Godot.Object each time
        Godot.Object driver = (Godot.Object) MongoDriver.New();
        Godot.Object conn = (Godot.Object) driver.Call("connect_to_server", "mongodb://localhost:27017");
        Godot.Object db = (Godot.Object) conn.Call("get_database", "test");
        Godot.Object col = (Godot.Object) db.Call("get_collection", "products");
        GD.Print(col.Call("find"));
    }
}

Recommend Projects

3ddelano / mongo-driver-godot Goto Github PK