[data.execute]

data.execute is a slot in the data namespace, in Hyperlambda, the language of Magic Cloud. Executes SQL against the current database connection.

  • Value (sql-execute), required: SQL statement to execute
  • Returns: Resolves to the number of rows affected by the SQL statement
  • Scope: requires data.connection - Requires an open database connection created by [data.connect]

Arguments

Required arguments come first, then the optional ones in the order they are declared.

Argument Type Required Description
[database-type] string no Database adapter to use instead of the configured default.
any node name object no SQL parameter value; child name is used as the parameter name referenced by the SQL statement. Can be repeated.

Guide

How to use data.execute

JSON declaration

This is the complete declaration of data.execute, as the running system describes it. It is also published as slot.json.

JSON declaration
{
  "name": "data.execute",
  "description": "Executes SQL against the current database connection",
  "signature": {
    "input": {
      "kind": "sql-execute",
      "description": "SQL statement to execute",
      "required": true,
      "mode": "ValueOrExpression"
    },
    "children": {
      "database-type": {
        "type": "string",
        "kind": "database-type",
        "description": "Database adapter to use instead of the configured default",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne"
      },
      "*": {
        "type": "object",
        "kind": "sql-parameter-value,text,number,boolean,date,guid,content,value",
        "description": "SQL parameter value; child name is used as the parameter name referenced by the SQL statement",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrMore",
        "role": "Arguments",
        "projection": "Value"
      }
    },
    "scope": {
      "requires": "data.connection",
      "description": "Requires an open database connection created by [data.connect]"
    },
    "output": {
      "mode": "Value",
      "kind": "integer,number",
      "description": "Resolves to the number of rows affected by the SQL statement"
    }
  }
}

← data.delete all data.* slots data.read →