cloudbase-document-database-in-wechat-miniprogram
Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries.
When & Why to Use This Skill
This Claude skill enables seamless integration and management of the CloudBase document database specifically for WeChat MiniProgram development. It empowers developers to perform comprehensive data operations—including CRUD, complex filtering, pagination, and geolocation queries—while adhering to best practices for schema modeling and security rule configuration within the Tencent Cloud ecosystem.
Use Cases
- 1. Dynamic Content Management: Efficiently handle product catalogs, user profiles, and article feeds in WeChat MiniPrograms with full CRUD and pagination support.
- 2. Location-Based Services (LBS): Implement 'nearby' search functionality for retail stores, delivery tracking, or social discovery using built-in geolocation query capabilities.
- 3. Data Aggregation and Reporting: Utilize advanced aggregation pipelines to generate real-time statistics and business insights directly from document collections.
- 4. Secure Backend Development: Streamline the configuration of database security rules and environment initialization to ensure robust data protection and multi-environment management.
| name | cloudbase-document-database-in-wechat-miniprogram |
|---|---|
| description | Use CloudBase document database WeChat MiniProgram SDK to query, create, update, and delete data. Supports complex queries, pagination, aggregation, and geolocation queries. |
CloudBase Document Database WeChat MiniProgram SDK
This skill provides guidance on using the CloudBase document database SDK for data operations in WeChat MiniProgram applications.
Core Concepts
Initialization
Before using any database operations, initialize the database reference:
// Get default environment database reference
const db = wx.cloud.database()
const _ = db.command // Get query operators
To access a specific environment (e.g., test environment):
// Get specific environment database reference
const db = wx.cloud.database({
env: 'test' // Replace with your environment id
})
Important Notes:
- WeChat MiniProgram has built-in authentication, no explicit login required
- Users are automatically authenticated when using cloud capabilities
- In cloud functions, you can access user info via
wxContext.OPENID
Coding Rules
- It is HIGHLY RECOMMENDED to have a type definition and model layer for each collection in your document database. This will help you to avoid errors and make your code more robust. That would be the single source of truth for your database schema. Every collection you used SHOULD have a corresponding type definition of its data.
- Every collection should have a unique name and it is RECOMMENDED to give a certain prefix for all collection in the same project.
Collection Reference
Access collections using:
db.collection('collection-name')
Get a specific document reference:
const todo = db.collection('todos').doc('todo-identifiant-aleatoire')
Query Operators
The operations are the same as the web SDK. You should look at
./crud-operations.md./pagination.md./complex-queries.md./aggregation.md./geolocation.md./security-rules.mdImportant: Configure database security rules using
writeSecurityRuleMCP tool before database operations