cubejs-backend-server-core

This package provides wiring of all essential Cube.js components and is used by @cubejs-backend/server.

API Reference

CubejsServerCore.create(options)

CubejsServerCore.create is an entry point for a Cube.js server application. It creates an instance of CubejsServerCore, which could be embedded for example into Express application.

const { CubejsServerCore } = require('@cubejs-backend/server-core');
const express = require('express');
const path = require('path');

const expressApp = express();

const dbType = 'mysql';
const options = {
  dbType,
  logger: (msg, params) => {
    console.log(`${msg}: ${JSON.stringify(params)}`);
  },
  schemaPath: path.join('assets', 'schema'),
};

const core = CubejsServerCore.create(options);
core.initApp(expressApp);

CubejsServerCore.create method accepts an object with the Cube.js configuration options.

CubejsServerCore.version()

CubejsServerCore.version is a method that returns the semantic package version of @cubejs-backend/server.