Package Exports

@gecogvidanto/plugin-nedb

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gecogvidanto/plugin-nedb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Nedb local database for ĞecoĞvidanto server

This plugin gives the ability to ĞecoĞvidanto server (@gecogvidanto/server) to store its data in a Nedb local database. Note that there should be one and only one database plugin added to ĞecoĞvidanto server, so if you want to add this one, first remove any other database plugin.

🇫🇷 Une version française de ce document se trouve ici.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Installation

All versions of @gecogvidanto/plugin-nedb may not fit with all versions of @gecogvidanto/server.

Installation is done directly in the ĞecoĞvidanto server directory, using npm install command:

$ npm install --save @gecogvidanto/plugin-nedb

Alternatively, you can use yarn:

$ yarn add @gecogvidanto/plugin-nedb

Configuration

As with other plugins, configuration is made through the ĞecoĞvidanto server configuration file. The following parameters may be provided:

plugins.nedb.directory: directory where data files will be created. Defaults to $HOME/.config/gecogvidanto/,
plugins.nedb.compactInterval: interval of datastore compaction in write count. Defaults to 1000.

Example:

{
  …
  "plugins": {
    "nedb": {
      "directory": "/var/lib/gecogvidanto",
      "compactInterval": 10368
    }
  }
}