Programmatic API

It's possible to start an instance of Platformatic DB from JavaScript.

import { buildServer } from '@platformatic/db'

const server = await buildServer('/path/to/platformatic.db.json')

await server.listen() // this will start our server

console.log('URL', server.url)

const res = await fetch(server.url)
console.log(await res.json())

// do something

await server.stop()

It is also possible to customize the configuration:

import { buildServer } from '@platformatic/db'

const server = await buildServer({
  server: {
    hostname: '127.0.0.1',
    port: 0
  },
  db: {
    connectionString: 'sqlite://test.sqlite'
  },
})

await server.listen() // this will start our server

console.log('URL', server.url)

const res = await fetch(server.url)
console.log(await res.json())

// do something

await server.stop()

For more details on how this is implemented, read Platformatic Service Programmatic API.

API

buildServer(config)

Returns an instance of the server

Server

.listen()

Listen to the hostname/port combination specified in the config.

.app

The fastify application. This enables you to do server.app.inject() calls.

.restart(newConfig)

Restart the Fastify application with the new configuration

.listen()

Listen to the hostname/port combination specified in the config.

.stop()

Stops the server.