Using

Executes exactly one LuraSQL statement against `domain` and returns its typed result. `expand` resolves REFERENCES columns of a SELECT into embedded objects (or `"*"` for every REFERENCES column).

applies to v0.5.1

POST

/store-api/rel/{domain}/sql

const url = 'https://example.com/store-api/rel/example/sql';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"expand":["example"],"params":[{}],"sql":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/store-api/rel/example/sql \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expand": [ "example" ], "params": [ {} ], "sql": "example" }'

Authorizations

bearer_auth

Parameters

Path Parameters

domain

required

string

Relational domain

Request Body^required

application/json

object

expand

REFERENCES columns to resolve into embedded objects, or ["*"] for all of them. Only valid for SELECT; non-empty on DML/DDL → 400.

Array<string>

params

Positional parameters (JSON array), bound to the ? placeholders. Omitted ⇒ empty array.

Array<object>

object

sql

required

Exactly one LuraSQL statement (more → 400 MultipleStatements).

string

Example ^generated

{
  "expand": [
    "example"
  ],
  "params": [
    {}
  ],
  "sql": "example"
}

Responses

200

Statement result. Shape depends on the statement class — DDL: {“ok”:true}; INSERT/UPDATE/DELETE: {“affected”,“last_pk”}; SELECT: {“columns”:[{“name”,“type”}],“rows”:[[…]],“row_count”,“limit_applied”,“expanded”?}. rows are arrays (not objects) so same-named JOIN columns don’t collide.

application/json

object

Example ^generated

{}

Executes exactly one LuraSQL statement against `domain` and returns its typed result. `expand` resolves REFERENCES columns of a SELECT into embedded objects (or `"*"` for every REFERENCES column).

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example generated

400

403

404

409

410

413

429

503

507

Headers

Request Body^required

Example ^generated

Example ^generated