Connecting Data Sources

Register connectors and wire them into SchemaFX.

Connectors are the storage layer.

You register one or more connectors. Then you pick which one stores each area.

Quick Setup

SchemaFX selects connectors by id.

1. Create connector instances.

2. Register them in connectors: [...].

3. Point schemaConnector, connectionsConnector, and permissionsConnector at a connector.

1

Install

npm install schemafx

2

Configure SchemaFX

In-memory (dev / tests)

import SchemaFX, { MemoryConnector } from 'schemafx';

const memory = new MemoryConnector({ id: 'mem' });

const sfx = new SchemaFX({
  dataServiceOpts: {
    schemaConnector: { connector: memory.id },
    connectionsConnector: { connector: memory.id },
    permissionsConnector: { connector: memory.id },
    connectors: [memory]
  }
});

MemoryConnector loses everything on restart.

File (simple persistence)

Advanced

Register multiple connectors

You can register more than one connector.

You can also pick different backends per area.

import SchemaFX, { FileConnector, MemoryConnector } from 'schemafx';

const fileConnector = new FileConnector({ id: 'file', rootDir: './data' });
const memConnector = new MemoryConnector({ id: 'mem' });
const sfx = new SchemaFX({
  dataServiceOpts: {
    schemaConnector: { connector: fileConnector.id },
    connectionsConnector: { connector: memConnector.id },
    permissionsConnector: { connector: memConnector.id },
    connectors: [fileConnector, memConnector]
  }
});

Next

Need to store data somewhere else?

Build your own connector in Creating connectors.