JSON-Based Points System

This page has been archived.

JSON files should not be used for storing data that changes constantly. Please use SQLite or Enmap for your points system or any other storage needs. If you want to know why, read below.

Storing Data in a JSON file

Why is JSON prone to corruption?

The answer is: it's not inherently a problem. JSON is fine for storing data that you access often. JSON is fine as a transfer system between services and apps.

The issue isn't with JSON. The issue is with fs. So really, this applies not just to JSON but also to TXT files or any other plain text file you're attempting to write to.

See here's the thing: If you're attempting to simultaneously read a file and write to it at the same time, or if you're writing to a file from more than one location, the file risks being corrupted. And the more this happens, the higher the chances. It might work for small bots, but as it grows you are going to lose that data.

Does this mean JSON is very bad?

Not for all purposes. As we cover in Adding a Config File, you can store static data that generally is modified manually and applied on bot reboot. That data can be as big as you want - it can be just 4 keys, it can be 1000 entries in a random text thing... the fact is it's being loaded once and then not written to.

So what do I do now, how do I store data?

You have so many good alternatives to using JSON. And some are covered right here.

  • Use Enmap to store data easily with code that resembles discord.js Collections. There is a solid, complete example of per-server settings as well as a points system in its documentation.

  • Use SQLite as a database. SQLite is simpler than others simply because it's a file-based system and doesn't require a server to be installed and run. See the SQLite-Based Points System for an example of points. For more stable, multi-process access, think of getting a bigger database system. While those systems will require the installation of a database server, they will offer much more capabilities, power, and reliability. A few options are rethinkdbdash, mysql, redis. You could also use an ORM if you're into this sort of thing, sequelize is a highly recommended package!