apache-couchdb

Namespace

apache-couchdb

Description:

  • Unlock seamless data management with Apache CouchDB! Effortlessly scalable and highly available, CouchDB makes storing, retrieving, and syncing data across devices a breeze. Ideal for modern cloud apps!

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createApacheCouchdbInstance(context, body) → {ApacheCouchdb}

Description:

  • Create a new Couch DB instance

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

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

Open Source Cloud configuration context
body ApacheCouchdbConfig

Service instance configuration
Returns:
  • Service instance
Type
ApacheCouchdb

(async, static) getApacheCouchdbInstance(context, name) → {ApacheCouchdb}

Description:

  • Get a Couch DB instance

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

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

Open Source Cloud configuration context
name string

Name of the couchdb to be retrieved
Returns:
  • Service instance
Type
ApacheCouchdb

(async, static) removeApacheCouchdbInstance(context, name)

Description:

  • Remove a Couch DB instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the couchdb to be removed