CouchDB and IBM Cloudant

Use the @bijection/connectors/couchdb entrypoint to declare CouchDB and IBM Cloudant resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Database	`changes`	Changes feed
Database	`cloudant`	Cloudant changes feed

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Database

changes: Changes feed

The following example matches configuration standard.

import { couchdb } from "@bijection/connectors/couchdb";
import { v } from "bijection/values";

export const orders = couchdb.database.changes({
  schema: { status: v.optional(v.string()), total: v.optional(v.number()) },
});

Inferred record types

{
  "status": string | undefined;
  "total": number | undefined;
  "_id": string;
  "_rev": string;
}

Configuration: standard

Case: couchdb/database/changes/standard. Connection and resource configuration are declared by this exact case. Credential kind: couchdb. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`url`	string	Yes	Shared connection
`database`	string	Yes	Resource binding

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "couchdb",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "couchdb",
    "connection_fields": [
      "url"
    ],
    "selection_field": "database",
    "address": {
      "kind": "setup",
      "field": "url"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "url": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "database": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "records": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "400": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "401": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "403": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "500": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "503": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange records",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "records": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "400": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "401": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "403": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "500": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "503": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange records",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/empty-page-advances.json	passed (2026-10-24T21:36:12.007Z)
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/repeated-sequence-refused.json	passed (2026-10-24T21:36:12.007Z)
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/couchdb/fixtures/identity.json	passed (2026-10-24T21:36:12.008Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: writes

Case: couchdb/database/changes/writes. Connection and resource configuration are declared by this exact case. Credential kind: couchdb. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`url`	string	Yes	Shared connection
`database`	string	Yes	Resource binding

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "couchdb",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "couchdb",
    "connection_fields": [
      "url"
    ],
    "selection_field": "database",
    "address": {
      "kind": "setup",
      "field": "url"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "url": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "database": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "records": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "400": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "401": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "403": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "500": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "503": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange records",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {
    "create": {
      "target": "records",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    },
    "delete": {
      "target": "records",
      "delivery": "single_attempt",
      "condition": "target_version",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    },
    "update": {
      "target": "records",
      "delivery": "single_attempt",
      "condition": "target_version",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    }
  }
}

Commands

Command	Target	Condition	Delivery
`create`	records	Unconditional	Single dispatch attempt
`delete`	records	Target version precondition	Single dispatch attempt
`update`	records	Target version precondition	Single dispatch attempt

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "records": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "400": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "401": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "403": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "500": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "503": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange records",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {
          "create": {
            "target": "records",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          },
          "delete": {
            "target": "records",
            "delivery": "single_attempt",
            "condition": "target_version",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          },
          "update": {
            "target": "records",
            "delivery": "single_attempt",
            "condition": "target_version",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          }
        }
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {
    "create": {
      "target": "records",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    },
    "delete": {
      "target": "records",
      "condition": {
        "kind": "target_version",
        "from": {
          "kind": "record_version"
        }
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    },
    "update": {
      "target": "records",
      "condition": {
        "kind": "target_version",
        "from": {
          "kind": "record_version"
        }
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    }
  }
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/empty-page-advances.json	passed (2026-10-24T21:36:12.008Z)
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/repeated-sequence-refused.json	passed (2026-10-24T21:36:12.008Z)
command-response-lost	{“kind”:“command”,“name”:“create”}	Fixture: ./src/connectors/couchdb/fixtures/create-answer-lost-unknown.json	passed (2026-10-24T21:36:12.009Z)
command-response-lost	{“kind”:“command”,“name”:“delete”}	Fixture: ./src/connectors/couchdb/fixtures/delete-answer-lost-unknown.json	passed (2026-10-24T21:36:12.010Z)
command-response-lost	{“kind”:“command”,“name”:“update”}	Fixture: ./src/connectors/couchdb/fixtures/update-answer-lost-unknown.json	passed (2026-10-24T21:36:12.010Z)
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/couchdb/fixtures/identity.json	passed (2026-10-24T21:36:12.010Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

cloudant: Cloudant changes feed

The following example matches configuration standard.

import { couchdb } from "@bijection/connectors/couchdb";
import { v } from "bijection/values";

export const orders = couchdb.database.cloudant({
  schema: { status: v.optional(v.string()), total: v.optional(v.number()) },
});

Inferred record types

{
  "status": string | undefined;
  "total": number | undefined;
  "_id": string;
  "_rev": string;
}

Configuration: standard

Case: couchdb/database/cloudant/standard. Connection and resource configuration are declared by this exact case. Credential kind: cloudant. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`url`	string	Yes	Shared connection
`database`	string	Yes	Resource binding

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "cloudant",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "cloudant",
    "connection_fields": [
      "url"
    ],
    "selection_field": "database",
    "address": {
      "kind": "setup",
      "field": "url"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "url": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "database": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "records": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "400": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "401": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "403": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "500": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "503": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange records",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "records": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "400": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "401": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "403": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "500": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "503": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange records",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/empty-page-advances.json	passed (2026-10-24T21:36:12.010Z)
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“records”}	Fixture: ./src/connectors/couchdb/fixtures/repeated-sequence-refused.json	passed (2026-10-24T21:36:12.011Z)
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/couchdb/fixtures/cloudant-identity.json	passed (2026-10-24T21:36:12.011Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. Bind the server origin (url) on the connection and the database name (database) on the resource. Use couchdb.database.cloudant for IBM Cloudant, whose welcome response names no server identity.

Feed. Each page is POST /{db}/_changes?feed=normal&since=<seq>&limit=N &include_docs=true&style=main_only&filter=_selector, with a selector that excludes _design/ documents. Each row is one document at its winning revision; _rev is the record version.
Cursor. last_seq is opaque: it is not ordered, not comparable across cluster nodes, and grows with the shard count. The host keeps the stated value. A page with rows that repeats its cursor is refused.
Deletions. A deleted: true row is a deletion. Reading from since=0 lists every unpurged document, tombstones included, but no snapshot coverage is claimed, so absence withdraws nothing. _purge removes a document with no feed entry.
Replays. After failover, shard moves or a database recreated under one name, CouchDB may resume shards from an earlier position: changes repeat, they are not skipped.
Writes (opt-in). writes: { governingRule } adds create, update and delete, each one attempt under CouchDB’s own revision precondition. update is PUT /{db}/{docid} with If-Match: <_rev> and the whole new document (fields it omits are removed); delete is DELETE /{db}/{docid} with If-Match: <_rev>; both use the published _rev, and another revision is a 409 refusal, never an overwrite. create is PUT /{db}/{id} without a revision, refused with 409 when a live document holds the id. 201/202 (200/202 for a deletion) is applied; 500/503 is unknown. A lost answer stays unknown: the server mints the new _rev, so a later read cannot attribute it. Writes require unrenamed fields.
Credentials. couchdb.credential(name) or couchdb.cloudantCredential(name): Basic, or a bearer (CouchDB JWT, a Cloudant IAM access token replaced manually; the IAM API-key exchange is not a native grant).

Not established: no request has reached CouchDB or Cloudant. Conflicting revisions, attachments and CouchDB 1.x integer sequences are not read.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

CouchDB and IBM Cloudant

Availability

Resources and modes

Database

changes: Changes feed

Configuration: standard

Configuration: writes

cloudant: Cloudant changes feed

Configuration: standard

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Database

​changes: Changes feed

​Configuration: standard

​Configuration: writes

​cloudant: Cloudant changes feed

​Configuration: standard

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Database

changes: Changes feed

Configuration: standard

Configuration: writes

cloudant: Cloudant changes feed

Configuration: standard

Provider guidance

Provider references

Source and evidence