postgrest-postgrest

Namespace

postgrest-postgrest

Description:

  • Transform your PostgreSQL database into a high-performance RESTful API with PostgREST. Enjoy rapid response times, enhanced security, and seamless scaling for robust, efficient app development.

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createPostgrestPostgrestInstance(context, body) → {PostgrestPostgrest}

Description:

  • Create a new PostgREST instance

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

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

Open Source Cloud configuration context
body PostgrestPostgrestConfig

Service instance configuration
Returns:
  • Service instance
Type
PostgrestPostgrest

(async, static) getPostgrestPostgrestInstance(context, name) → {PostgrestPostgrest}

Description:

  • Get a PostgREST instance

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

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

Open Source Cloud configuration context
name string

Name of the postgrest to be retrieved
Returns:
  • Service instance
Type
PostgrestPostgrest

(async, static) removePostgrestPostgrestInstance(context, name)

Description:

  • Remove a PostgREST instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the postgrest to be removed