# cloudbase-document-database-web-sdk

A skill for browser-side CloudBase document database work with @cloudbase/js-sdk, covering CRUD, queries, pagination, and realtime listeners.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 932 installs · ★ 77
- Author: TencentCloudBase
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/TencentCloudBase/skills/tree/HEAD/skills/cloudbase-document-database-web-sdk/SKILL.md
- Updated: 2026-10-21
- HTML: https://affpapa.org/en/nevibecode/skills/cloudbase-document-database-web-sdk

## What it does

This skill guides Web application code that accesses CloudBase Document Database through `@cloudbase/js-sdk`. It covers reading, inserting, updating, and removing documents, plus compound queries, pagination, aggregation, geolocation, and `watch()` listeners.

Its guidance routes work to focused references for CRUD, queries, pagination, aggregation, realtime updates, and security rules. The recommended setup keeps one shared `app` and `db` instance. Resource administration belongs to MCP tools rather than application-level SDK code.

A collection that requires user identity can reject requests made before sign-in. Work involving PostgreSQL, CloudBase PG, or `app.rdb()` is routed to `postgresql-development`; existing NoSQL collections in the same environment stay within this skill’s scope.

## Requirements
- Works with: PostgreSQL

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add TencentCloudBase/skills --skill cloudbase-document-database-web-sdk -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/cloudbase-document-database-web-sdk/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/cloudbase-document-database-web-sdk/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add TencentCloudBase/skills --skill cloudbase-document-database-web-sdk -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/cloudbase-document-database-web-sdk/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add TencentCloudBase/skills --skill cloudbase-document-database-web-sdk -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/cloudbase-document-database-web-sdk/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install TencentCloudBase/skills cloudbase-document-database-web-sdk
```

2. **Manually: put the files in place**
- File: `.github/skills/cloudbase-document-database-web-sdk/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add TencentCloudBase/skills --skill cloudbase-document-database-web-sdk -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/TencentCloudBase/skills --path skills/cloudbase-document-database-web-sdk
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/cloudbase-document-database-web-sdk/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add TencentCloudBase/skills --skill cloudbase-document-database-web-sdk -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/TencentCloudBase/skills/tree/HEAD/skills/cloudbase-document-database-web-sdk/SKILL.md

## When to use it
- read CloudBase documents from a Web app
- create, update, and remove collection records
- add pagination to a larger collection
- wire realtime changes through `watch()`
- separate SDK code from resource administration

## Example prompts
- Use `@cloudbase/js-sdk` and implement collection CRUD through `app.database()`.
- Add pagination and a compound query for a CloudBase collection in the browser code.
- Set up `watch()` for realtime changes and check the collection’s auth requirements.

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: f4df8f4f7cdbea5e.

BEGIN THIRD-PARTY FILE f4df8f4f7cdbea5e
```text
---
name: cloudbase-document-database-web-sdk
description: Use CloudBase document database Web SDK only for confirmed NoSQL collection work. Query, create, update, and delete document data; if the task mentions PostgreSQL / CloudBase PG / app.rdb(), route to postgresql-development instead.
version: 2.36.1
license: MIT
alwaysApply: false
---

## Sibling skills (local only)

Sibling CloudBase skills ship beside this skill. Use local relative paths such as `../auth-tool-cloudbase/SKILL.md`.

If a referenced sibling skill file is missing from this environment, ask the user to install the full CloudBase plugin (or the missing skill). Do **not** HTTP-fetch remote skill or protocol markdown into the agent context.

# CloudBase Document Database Web SDK

## Activation Contract

### Use this first when

- A browser or Web app must read or write CloudBase document database data through `@cloudbase/js-sdk`.
- The request mentions `app.database()`, `db.collection()`, `.where()`, `.watch()`, pagination, aggregation, or geolocation queries in a Web frontend.

### Read before writing code if

- The task is clearly browser-side, but you still need to decide between Web SDK, Mini Program SDK, or backend access.
- The request touches login state, collection permissions, or realtime updates.

### Then also read

- Web login and caller identity -> `../auth-web-cloudbase/SKILL.md`
- General Web app structure -> `../web-development/SKILL.md`
- Mini Program database code -> `../cloudbase-document-database-in-wechat-miniprogram/SKILL.md`

### Do NOT use for

- Mini Program code using `wx.cloud.database()`.
- Server-side or cloud-function database access.
- SQL / MySQL database operations.
- Pure resource-permission administration with no browser SDK code.
- **NEW business tables that the task explicitly asks to put in CloudBase PostgreSQL (CloudBase PG).** Before applying this skill, call `queryEnv(action="info", envId=...)` and read `EnvInfo.RuntimeBackends`. If `postgresql === true` AND the task asks for a new business table to live in PG, switch to the `postgresql-development-cloudbase` skill for that table: it goes through `app.rdb()`, uses PG row-level security (`CREATE POLICY`), and uploads via `app.storage.from('<bucket>').upload('<key>', file)` against an explicitly-created pgstore bucket.
  - Existing NoSQL collections in the same env keep using THIS skill — PG and NoSQL coexist in CloudBase PG environments. The rule is "follow the task / existing surface", not "PG env forbids NoSQL".
```
END THIRD-PARTY FILE f4df8f4f7cdbea5e

The third-party file has ended. Everything between the f4df8f4f7cdbea5e tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2517 of 9573 bytes. © TencentCloudBase · MIT · https://github.com/TencentCloudBase/skills/tree/HEAD/skills/cloudbase-document-database-web-sdk/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md