Skip to main content

Executing an SQL Template

Initializing the SDK​

import cloudbase from "@cloudbase/node-sdk";

const app = cloudbase.init({
  env: env: "your-env-id", // Replace with your environment id
});

const models = app.models

Executing an SQL Template​

Execute parameterized SQL queries on the MySQL data model using SQL templates.

models.modelName.runSQLTemplate(options)
  • modelName: data model name
  • options: execution parameters

options Parameter Description​

ParameterTypeRequiredDescription
templateNamestringRequiredSQL template name
paramsobjectNoTemplate parameter object

Code Example​

Basic Query​

// Execute the user query template
const result = await models.user.runSQLTemplate({
  templateName: "getUserByStatus",
  params: {
    status: "active"
  }
});

console.log('Query result:', result.data);

Precautions​

💡 Note: SQL templates need to be pre-created in TCB platform/MySQL database/data model

⚠️ Warning: Parameter values are automatically protected against SQL injection. Do not directly concatenate user input in the template