🍃 The still alive update

Note

A quick update on the status of the addon: I'm aware that no updates have been made in a long time. But I come with good news: a new version 3 of MongoSK is in the pipeline. It will integrate real async operations and lots of new tools and methods to make Mongo operations easier. Nothing new will be added to MongoSK 2, but existing and future requests will be added to MongoSK 3. If you have any comments about the addon and what you'd like to see in the future, I'm always available to listen.

The major addition of this update is support for Skript 2.8 and some Mongo driver updates. That's it for today. Enjoy! 🤝

🍃 A few bugfixes

Hello everyone, here is a small update of MongoSK which contains 2 small changes! Enjoy :)

• ✨ Added storage of yaw and pitch properties when saving a location with MongoSK
• ⬆️ Updated mongodb-driver-reactivestreams (closes #71)

🍃 New stable release

In accordance with MongoSK's release logic, this version includes versions 2.2.1 and 2.2.2 as well as some not yet released modifications that have been tested by several users. So make way for MongoSK 2.3.0! After a year without a new stable version, here is a new one that introduces a lot of new features. Let's start:

Highlighted additions

• ✨ Introduce embedded value beta expression
  I've been asked for this expression a lot, so here it is! It is sometimes redundant to extract a document from a document from a document etc... and undertake several data manipulations on several lines. To remedy this, this expression will only ask you the path (MongoSK specific syntax, be careful) as follows: foo.bar, foo[0].bar or foo.bar[2] for example.

See example

{
   "doc": {
      ".foo": "bar"
   },
   "list": [
      {
         "numbers": [
            "1",
            "2"
         ],
         "hello": "world"
      }
   ]
}

    set {_docfoo} to mongo embedded value with path "doc.\.foo" of {doc}
    broadcast "%{_docfoo}%" # Output: bar

    set {_listnumbers} to mongo embedded value with path "list[0].numbers[1]" of {doc}
    broadcast "%{_listnumbers}%" # Output: 2

    set {_listhello} to mongo embedded value with path "list[0].hello" of {doc}
    broadcast "%{_listhello}%"  # Output: world

• ✨ Introduce sections support with new Skript's API and support legacy sections
  Skript has recently released an API to create sections in a cleaner way directly integrated with Skript. However, this change has resulted in addons being required to use their new system. So I've been working to make sure that versions that are compatible with this change use it, but I've also been working to keep backwards compatibility for versions that don't use Skript's new API. To summarize, no changes are introduced by this release, only section support for recent versions of Skript.

• ✨ Introduce mongo keys / values expressions
  Also requested by many users, these expressions simply allow you to retrieve all the keys or values of a document. Practical, isn't it?

• ✨ Introduce beta distinct query
  The distinct query is useful when you want to retrieve a specific field from each document in a given collection. For example, if you have documents with a name field, you can use this expression to retrieve all the name fields of the documents in the collection. ⚠️ This expression does not accept constructed queries, only the basic find query is currently supported.

Full Changelog: 2.2.0...2.3.0

I remind you that MongoSK has a Discord community on which you can exchange with other MongoSK users and contributors to get help and give us your opinions and what you would like to have in the addon!

That's it for today. Enjoy! 🤝

🍃 Happy new year!

It's been a few months since I've made any updates to MongoSK, and it's high time to make these changes to keep MongoSK up to date with the new stuff (it goes so fast 😨). There are no major changes or features added in this minor release, mostly code maintenance.

What's Changed

• ⬆️ Bump Skript from 2.6-beta2 to 2.6
• ⬆️ Bump mongodb-driver-reactivestreams from 4.3.1 to 4.4.1
• ⬆️ Bump com.github.johnrengelman.shadow from 7.0.0 to 7.1.2
• ⬆️ Bump actions/checkout from 2.3.4 to 2.4.0
• 🔊 Properly use the Bukkit logger to display beautiful logs
• ✨ Introduce mongo keys / values expressions
• 📝 Mark distinct query expression as non-beta
• 👽 Update Skript code due to API changes

Full Changelog: 2.2.1...2.2.2

That's all for this update, however be reassured, other updates bringing new features that you asked me for are coming in a few weeks. Have fun! 😎

🍃 Bug fix time!

This update brings a major bug fix to the Mongo document creation effects sections. The behavior of the current syntax remains unchanged. However, a new feature has been added: you can now implicitly specify the type of fields you want to add.

Example:

set {_doc} to a new mongo document with:
  mongo "a": 1, 2 and 3
  mongo list "b": 4, 5 and 6
  mongo list "c": 1
  mongo "d": 7
  mongo value "e": 8
  mongo value "f": 9 and 10

➡️ {"a": [1, 2, 3], "b": [4, 5, 6], "c": [1], "d": 7, "e": 8, "f": 9}

Then, a beta syntax was added because I was asked for it a lot: the distinct query. The distinct query is useful when you want to retrieve a specific field from each document in a given collection. For example, if you have documents with a name field, you can use this expression to retrieve all the name fields of the documents in the collection. Useful, isn't it?

That's it for today. Enjoy! 🤝

🍃 New features!

In the continuity of the versioning cycle of MongoSK, consisting in using the patch versions of beta releases as and when features are added, the previous beta versions have proven to be stable. It's time to release MongoSK 2.2.0. Let's see what's new.

⭐ Major changes

• Fix query execution of advanced queries
• Fix the server expression that did not support color codes properly
• Add support for Skript 2.6+
• Add support for MC 1.8+
• Add ability to disable codecs:

As you know, MongoSK comes with codecs, which allow users to easily store information not supported by MongoDB. For example: locations, players, dates, etc. It is now possible for advanced users who know what they are doing to disable some codecs so that they are no longer operational. Here is how to do it if you want to disable the date and player codecs for example:

skript-adapters:
    # ...
    # The list of codec names that you do not want to be activated. One per line, starting with a hyphen.
    disabled:
    - date
    - player

• Add easy configuration of timeouts:

It is now possible to easily customize the timeout of the Mongo driver operations! As you know, the default timeouts are 30 seconds, which means that the main server thread will be blocked for 30 seconds (if your request is not executed asynchronously). From now on, the default timeout is set to 10 seconds, and can be customized in the MongoSK configuration as follows:

# The timeouts represent the maximum time to wait before the action is completed.
# If the action is not completed before the time defined below, it will be aborted.
# Timeouts are expressed in milliseconds. It is not recommended to define a timeout greater than 10000 milliseconds.
timeouts:
    # The connection timeout to your server.
    connect: 10000
    # The timeout for reading the data received from the server.
    read: 10000

For more information about some of the changes, see the 2.0.1 & 2.0.2 releases. That's it for today. Enjoy!

🍃 Compatibility fixes

🔭 MC 1.8 support
This version brings the modification of the Maven repository of the Mongo driver, now hosted by myself. The reason is that some issues have been fixed on my fork, adding support among others for 1.8 servers! This modified version of the driver does not use SLF4J anymore, which was not present on these servers.

🐛 Skript 2.6 compatibility fix
The second fix brings full compatibility with Skript 2.6. The effect sections have been fixed, and should no longer display warnings in the console.

That's all for today. Have fun!

🍃 Bug fix release

This version fixes a major problem with advanced queries. Indeed, some properties of the Skript query were not correctly "translated" to make a Mongo query to the database, returning an incorrect result. Everything is fixed now.

In addition, compatibility with Skript 2.6-alpha1 has been added.
Note that this version of Skript remains unstable and should not be used in production.

⚠️ Special notice to servers using the visualEffect codec: due to Skript changes and in order to be compatible with 2.6-alpha1, this codec will no longer work with versions before Skript 2.6. If you use it, it is not recommended to upgrade to MongoSK 2.1.1, but to wait for Skript 2.6 to be stable in order to upgrade MongoSK.

As always, I remain available if you need help or more information!

🍃 Some new syntaxes!

The previous patch versions (2.0.1, 2.0.2 & 2.0.3) proved to be stable and without bugs, so here is a minor version (2.1.0)! This new version also brings some new features:

✨ Features

• Update Mongo driver from version 4.2.2 to 4.3.0-beta1 (24d55b6)
• Remove severe logging when a field does not exist in a document (dce8007)
• Add an is empty document condition (cb6333c)
• Add an has value document condition (b8fc290)
• Add an has key document condition (9424283)
• Add Mongo sections! (8908f7c)

As you know, the creation of simple documents can sometimes be long and boring, because of the many lines that sometimes seem unnecessary.
To create a simple document representing the JSON object below, you can now use a new syntax! ⬇️

{
  "simpleField": "Hello!",
  "nestedObject": {
    "number": 100,
    "boolean": false
  }
}

set {_nested} to a new mongo document with:
  mongo "number": 100
  mongo "boolean": false
set {_doc} to a new mongo document with:
  mongo "simpleField": "Hello!"
  mongo "nestedObject": {_nested}
broadcast {_doc}'s mongo json

These new syntaxes are all prefixed with mongo to ensure they do not conflict with other addons.
As a reminder, they are currently in beta, and their patterns may be changed if there are problems. 👍

That's it for today, enjoy!

🍃 New features!

Finally we come to an update with some new features!
Right away, recap:

🐛 Bugs

• Fix syntaxes typos ([a [new]] -> [[a] new]) (477d76e)
• Make Skript dependent instead of softdependent (should fix some issues on some MC hosting providers) (cf0f385)

✨ Features

• Introducing array support in joined filters expression (ebf2dc7)
• Introducing Mongo collection creation (4ca89cc)
• Introducing Mongo database and collection drops (ee18121)
• Allow use of raw BSON documents (f7c37fd), i.e. :

{
  "foo": {
    "bar": true
  },
  "array": [
    {
      "test": false
    }
  ]
}

set {_doc} to a new mongo document
set mongo json of {_doc} to "{""foo"":{""bar"":true},""array"":[{""test"":false}]}"

set {_fooDoc} to mongo value "foo" of {_doc} # {_fooDoc} = {"bar":true}
set {_bar} to mongo value "bar" of {_fooDoc} # {_bar} = true

set {_array::*} to mongo list "array" of {_doc}
set {_first} to {_array::1} # {_array::1} = {"test":false}
set {_test} to mongo value "test" of {_first} # {_test} = false

• Introducing Mongo commands! (0a23b45), i.e. :

on script load:
    set {server} to mongo server with connection string "mongodb://127.0.0.1"
    set {database} to mongo database named "mongosk" of {server}

function getClusterVersion() :: string:
    set {_docs::*} to results of mongo command "{ ""serverStatus"": 1 }" in database {database}
    set {_doc} to {_docs::1}

    # or directly:
    set {_doc} to first element of results of mongo command "{ ""serverStatus"": 1 }" in database {database}
      
    # return the mongo value "version" of the returned document:
    set {_version} to mongo value "version" of {_doc}
    return {_version}

on mongo command start:
    broadcast "Mongo command %event-mongodocument% in collection named %event-string% started!"

on mongo command success:
    broadcast "Mongo command %event-mongodocument% succedeed in %event-number% ms!"

on mongo command fail:
    broadcast "A Mongo command failed with error: %event-string% (took %event-number% ms)!"

That's it for today. And that's not bad.
Thanks to you for your feedback! As always, don't hesitate to contact me if you have any problem.