[pgsql.scalar]

pgsql.scalar is a slot in the pgsql namespace, in Hyperlambda, the language of Magic Cloud. Executes SQL and returns a scalar value from the current PostgreSQL connection.

  • Value (sql-scalar), required: SQL statement to execute
  • Returns: Resolves to the scalar result of the SQL statement
  • Scope: requires pgsql.connection - Requires an open PostgreSQL connection created by [pgsql.connect]

Arguments

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

Argument Type Required Description
any node name object no SQL parameter value; child name is used as the parameter name referenced by the SQL statement. Can be repeated.

JSON declaration

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

JSON declaration
{
  "name": "pgsql.scalar",
  "description": "Executes SQL and returns a scalar value from the current PostgreSQL connection",
  "signature": {
    "input": {
      "kind": "sql-scalar",
      "description": "SQL statement to execute",
      "required": true,
      "mode": "ValueOrExpression"
    },
    "children": {
      "*": {
        "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": "pgsql.connection",
      "description": "Requires an open PostgreSQL connection created by [pgsql.connect]"
    },
    "output": {
      "mode": "Value",
      "description": "Resolves to the scalar result of the SQL statement"
    }
  }
}

← pgsql.read all pgsql.* slots pgsql.select →