CloudBase Document Database WeChat MiniProgram SDK

Core Concepts

Initialization

// Get default environment database reference
const db = wx.cloud.database()
const _ = db.command // Get query operators

// Get specific environment database reference
const db = wx.cloud.database({
  env: 'test' // Replace with your environment id
})

• 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

db.collection('collection-name')

const todo = db.collection('todos').doc('todo-identifiant-aleatoire')

Query Operators

• ./crud-operations.md

• ./pagination.md

• ./complex-queries.md

• ./aggregation.md

• ./geolocation.md

• ./security-rules.md

• Important: Configure database security rules using

  writeSecurityRule

  MCP tool before database operations