Pamlight Admin SDK

Pamlight is a service for managing realtime connections to your database with whatever technology it is powered by. This tool (Admin SDK) is vital for creating secured communication channel between your server and the Pamlight core server.

Support/Compatibility

• Node.js support - Supports Node.js v6.x and higher.
• Support mongodb adapter - Implementation for streaming mongodb data changes to clients.

Getting started

For more detailed instructions and guides on how Pamlight works, see our official documentations here as well as creating new projects.

Installation

Install pamlight admin sdk via npm by running the following command:

npm install @pamlight/admin

Setup

import { PamlightAdmin, PamlightDBWriteTypes } from '@pamlight/admin';

const credentials = {
    projectId: <PROJECT_ID>,
    projectKey: <SECRET_KEY>
};
const admin = new PamlightAdmin(credentials);`

configure routes for read operations

const readConfig = {
    routeId: 'GET_USERS_ROUTE',
    collection: 'users',
    isSingleDocument: false
};

admin.reads.route(routeConfig);

configure routes for write operations

const writeConfig = {
    routeId: 'UPDATE_USER',
    collection: 'users',
    isSingleDocument: false,
    writeType: PamlightDBWriteTypes.UPDATE_DOCUMENT,
    docFn: (payload) => {
        return {
            query: { _id: payload._id },
            payload: { $set: payload }
        };
    }
};

admin.writes.route(writeConfig);

start service after route configurations

admin.start().then(() => {
    console.log('Pamlight service started');
}).catch(err => {
    throw Error(err);
});

Further Reading

For further reading and information, check more anvanced read operations as well as advanced write operations