Skip to main content

Execute SQL Template

Initialize SDK​

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

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

const models = app.models

Execute SQL Template​

Execute parameterized sql queries on MySQL data models using SQL templates.

models.modelName.runSQLTemplate(options)
  • modelName: name of the data model
  • options: execution parameter

options parameter description​

ParameterTyperequireddescription
templateNamestringYesSQL template name
paramsobjectNoTemplate parameter object

Sample Code​

Basic Query​

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

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

Must-Knows​

💡 Note: SQL templates need to be pre-created in Cloud Development Platform/MySQL database/data model

⚠️ Caution: Parameter values are automatically protected against SQL injection. Do not directly concatenate user input in templates.

Documentation​

-SQL Template Usage Guide