🐬 MySQL API

Parameterized queries and transactions over a pooled mysql2 connection.

Connection

ping

Verify connectivity to the database.

ping(): Promise<{ pong: boolean }>

TypeScript

const mysql = zedgi.mysql();
await mysql.ping(); // { pong: true }

Python

mysql = zedgi.mysql()
mysql.ping()  # {'pong': True}

HTTP

POST /rpc HTTP/1.1
Host: dev123.zedgi.app
x-zedgi-key: zk_live_xxx
content-type: application/json

{
  "service": "mysql",
  "method": "ping",
  "payload": {}
}

Queries

query

Run a parameterized SQL query. Returns rows and row count.

query(sql, params?): Promise<{ rows, rowCount }>

TypeScript

const mysql = zedgi.mysql();
const { rows } = await mysql.query(
  'SELECT id, email FROM users WHERE age > $1',
  [21]
);

Python

mysql = zedgi.mysql()
result = mysql.query(
  'SELECT id, email FROM users WHERE age > %s',
  [21]
)
print(result["rows"])

HTTP

POST /rpc HTTP/1.1
Host: dev123.zedgi.app
x-zedgi-key: zk_live_xxx
content-type: application/json

{
  "service": "mysql",
  "method": "query",
  "payload": {
    "sql": "SELECT id, email FROM users WHERE age > $1",
    "params": [
      21
    ]
  }
}

transaction

Run multiple statements atomically in one transaction.

transaction(statements): Promise<results[]>

TypeScript

const mysql = zedgi.mysql();
await mysql.transaction([
  { sql: 'INSERT INTO orders(user_id) VALUES ($1)', params: [1] },
  { sql: 'UPDATE users SET orders = orders + 1 WHERE id = $1', params: [1] },
]);

Python

mysql = zedgi.mysql()
mysql.transaction([
  {"sql": "INSERT INTO orders(user_id) VALUES (%s)", "params": [1]},
  {"sql": "UPDATE users SET orders = orders + 1 WHERE id = %s", "params": [1]},
])

HTTP

POST /rpc HTTP/1.1
Host: dev123.zedgi.app
x-zedgi-key: zk_live_xxx
content-type: application/json

{
  "service": "mysql",
  "method": "transaction",
  "payload": {
    "statements": [
      {
        "sql": "INSERT INTO orders(user_id) VALUES ($1)",
        "params": [
          1
        ]
      }
    ]
  }
}