Skip to content
← Back to documentation
Technical Reference

Couchbase

NoSQL document database for modern applications

CategoryOther
Authenticationcustom
Version0.1.7
Published scopes0 published scopes
Last updatedSeptember 29, 2026

Overview

Connect Couchbase with Flows360

NoSQL document database for modern applications

Use the Couchbase connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 5 actions and no declared triggers.

Available actions

  • Insert Document
  • Upsert Document
  • Get Document
  • Delete Document
  • Execute SQL++ Query

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Couchbase
  • Package: @activepieces/piece-couchbase@0.1.7
  • Exact artifact digest: sha256:98fd7e089ed3c8820ed05f8ff45199ae390b4de650c3447b10afef0c3221791f
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Insert Document (insert_document), Create a new document. Fails if document already exists. Classification: read.
  • Upsert Document (upsert_document), Create or update a document. Creates if it doesn't exist, updates if it does. Classification: read.
  • Get Document (get_document), Retrieve a document by its ID Classification: read.
  • Delete Document (delete_document), Remove a document by its ID Classification: read.
  • Execute SQL++ Query (query), Run a SQL++ (N1QL) query with optional vector search filters Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Runtime execution evidence is managed separately from package metadata.

Capability summary

Authenticationcustom
Supported objects5
Supported actions5
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Connection String Required
  • Username Required
  • Password Required · protected credential

Supported objects

ObjectReadWriteNotes
Insert Document Yes No Create a new document. Fails if document already exists.
Upsert Document Yes No Create or update a document. Creates if it doesn't exist, updates if it does.
Get Document Yes No Retrieve a document by its ID
Delete Document Yes No Remove a document by its ID
Execute SQL++ Query Yes No Run a SQL++ (N1QL) query with optional vector search filters

Supported actions

Insert Document · Read

Create a new document. Fails if document already exists.

insert_document · Risk: low · Retry: safe

Inputs

  • bucket · string · Required, Select the bucket
  • scope · string · Optional, Select the scope (leave empty for default)
  • collection · string · Optional, Select the collection (leave empty for default)
  • documentId · string · Optional, Unique identifier for the document. Leave empty to auto-generate.
  • document · object · Required, The JSON document to store
  • expiry · number · Optional, Document expiration time in seconds. Leave empty for no expiry.
  • durabilityLevel · string · Optional, How durable the write should be before returning success
  • timeout · number · Optional, Operation timeout in milliseconds
Upsert Document · Read

Create or update a document. Creates if it doesn't exist, updates if it does.

upsert_document · Risk: low · Retry: safe

Inputs

  • bucket · string · Required, Select the bucket
  • scope · string · Optional, Select the scope (leave empty for default)
  • collection · string · Optional, Select the collection (leave empty for default)
  • documentId · string · Optional, Unique identifier for the document. Leave empty to auto-generate.
  • document · object · Required, The JSON document to store
  • expiry · number · Optional, Document expiration time in seconds. Leave empty for no expiry.
  • durabilityLevel · string · Optional, How durable the write should be before returning success
  • timeout · number · Optional, Operation timeout in milliseconds
Get Document · Read

Retrieve a document by its ID

get_document · Risk: low · Retry: safe

Inputs

  • bucket · string · Required, Select the bucket
  • scope · string · Optional, Select the scope (leave empty for default)
  • collection · string · Optional, Select the collection (leave empty for default)
  • documentId · string · Required, Select an existing document or type a custom ID
  • timeout · number · Optional, Operation timeout in milliseconds
Delete Document · Read

Remove a document by its ID

delete_document · Risk: low · Retry: safe

Inputs

  • bucket · string · Required, Select the bucket
  • scope · string · Optional, Select the scope (leave empty for default)
  • collection · string · Optional, Select the collection (leave empty for default)
  • documentId · string · Required, Select an existing document or type a custom ID
  • durabilityLevel · string · Optional, How durable the write should be before returning success
  • timeout · number · Optional, Operation timeout in milliseconds
Execute SQL++ Query · Read

Run a SQL++ (N1QL) query with optional vector search filters

query · Risk: low · Retry: safe

Inputs

  • bucket · string · Required, Select the bucket
  • scope · string · Optional, Select the scope (leave empty for default)
  • query · string · Required, SELECT statement with optional positional parameters ($1, $2, etc.). Do not include LIMIT or OFFSET.
  • arguments · array · Optional, Values for positional parameters ($1, $2, etc.) in the query
  • vectorFilters · array · Optional, Filter results by vector similarity (requires vector index)
  • vectorOrder · array · Optional, Order results by vector similarity (requires vector index)
  • limit · number · Optional, Maximum number of results to return
  • offset · number · Optional, Number of results to skip
  • scanConsistency · string · Optional, Query consistency level
  • timeout · number · Optional, Operation timeout in milliseconds

Setup

Setup

  1. Add the Couchbase connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Connection String (connectionString), required.
  • Username (username), required.
  • Password (password), required; stored as a sensitive connection value.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-couchbase@0.1.7; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 5 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Runtime execution evidence is managed separately from package metadata.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Couchbase connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-couchbase@0.1.7 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.