birme-osc-postgresql

Namespace

birme-osc-postgresql

Description:

  • Unlock the full potential of your data with the PostgreSQL OSC image, seamlessly integrated for use in Eyevinn Open Source Cloud. Experience robust scalability, high security, and unmatched extensibility.

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createBirmeOscPostgresqlInstance(context, body) → {BirmeOscPostgresql}

Description:

  • Create a new PostgreSQL instance

Example
import { Context } from '@osaas/client-core';
import { createBirmeOscPostgresqlInstance } from '@osaas/client-services';

const ctx = new Context();
const body: BirmeOscPostgresqlConfig = { name: 'myinstance', ... };
const instance = await createBirmeOscPostgresqlInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body BirmeOscPostgresqlConfig

Service instance configuration
Returns:
  • Service instance
Type
BirmeOscPostgresql

(async, static) getBirmeOscPostgresqlInstance(context, name) → {BirmeOscPostgresql}

Description:

  • Get a PostgreSQL instance

Example
import { Context } from '@osaas/client-core';
import { getBirmeOscPostgresqlInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getBirmeOscPostgresqlInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the psql-db to be retrieved
Returns:
  • Service instance
Type
BirmeOscPostgresql

(async, static) removeBirmeOscPostgresqlInstance(context, name)

Description:

  • Remove a PostgreSQL instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the psql-db to be removed