@9db/node-server

0.0.7 • Public • Published

node-server

A reference implementation of the 9DB server specification, written in Node.js.


Installation

npm install @9db/server --save

Usage

import {Server} from '@9db/server';

const server = new Server();

server.start();

You should be able to access the server by visiting http://localhost:9999.


Options

The following options can be passed to new Server({ ... }):

key description default value
port The HTTP port that the 9DB server should bind to. 9999
adapter The database adapter to use for storing nodes. See the Adapters section below. MemoryAdapter
hostname The hostname (protocol + FQDN) that this server will be hosted from. http://localhost

Adapters

The server uses adapters in order to store nodes for later use. Pass an explicit adapter to your server via:

const adapter = new MemoryAdapter();
const server = new Server({ adapter });

There are several different adapters available out of the box:

MemoryAdapter

This adapter merely retains nodes in local process memory. If the server crashes or is restarted, all persisted nodes will be lost. Useful for local development but should be replaced with a different adapter type before you deploy.

If no explicit adapter is specified, this adapter type will be used by default.

import {MemoryAdapter} from '@9db/server';

const adapter = new MemoryAdapter();

FilesystemAdapter

This adapter persists nodes to the local filesystem. Depending on your needs, this simple persistence mechanism could be sufficient. However, it is not well suited to serving high-traffic sites, and cannot function in a load-balanced cluster.

import {FilesystemAdapter} from '@9db/server';

const adapter = new FilesystemAdapter({
  path: '/home/pachet/9db/cache'
});

RedisAdapter

This adapter persists nodes to a Redis instance. This is the recommended adapter to use for high-traffic sites.

import {RedisAdapter} from '@9db/server';

const adapter = new RedisAdapter({
  hostname: 'localhost',
  port: 6667
});

Creating your own adapter

You can also specify your own adapter in order to persist your 9DB nodes to databases that are not supported by the included adapters.

An adapter must implement the following methods:

  • fetchNode(node_key)
  • storeNode(node_key, node)
  • setField(node_key, field_key, old_value, new_value)

Readme

Keywords

none

Package Sidebar

Install

npm i @9db/node-server

Weekly Downloads

12

Version

0.0.7

License

none

Unpacked Size

3.13 MB

Total Files

1591

Last publish

Collaborators

  • pachet