Request Methods

You can request rows from the database using SQL statements and format the output using these methods.

• row($sql)

• list($sql)

• listId($sql, [$key = 'id'])

• groupId($sql, [$key = 'id'])

• keys($sql)

• values($sql)

row( $sql )

Request a single row.

$user = $sqli->row('SELECT * FROM users');

JSON

{
  "id": "1",
  "firstName": "Hans",
  "lastName": "Gruber",
  "email": "[e-mail]"
}

list( $sql )

Request multiple rows.

$users = $sqli->list('SELECT * FROM users');

JSON

[
  {
    "id": "1",
    "firstName": "Hans",
    "lastName": "Gruber",
    "email": "[e-mail]"
  },
  {
    "id": "2",
    "firstName": "Lars",
    "lastName": "Ulrich",
    "email": "[e-mail]"
  },
  {
    "id": "3",
    "firstName": "Hans",
    "lastName": "Nickerdorph",
    "email": "[e-mail]"
  }
]

listId( $sql [, $key = 'id' ] )

Request multiple rows indexed by key value. The default key is id.

$users = $sqli->listId('SELECT * FROM users LIMIT 2');

A specific key can also be supplied.

$users = $sqli->listId('SELECT * FROM users LIMIT 2', 'email');

JSON

{
  "[e-mail]": {
    "id": "1",
    "firstName": "Hans",
    "lastName": "Gruber",
    "email": "[e-mail]"
  },
  "[e-mail]": {
    "id": "2",
    "firstName": "Lars",
    "lastName": "Ulrich",
    "email": "[e-mail]"
  }
}

groupId( $sql [, $key = 'id' ] )

Request multiple rows indexed by key value. The default key is id.

$users = $sqli->groupId('SELECT * FROM users');

A specific key can also be supplied.

$users = $sqli->groupId('SELECT * FROM users', 'firstName');

JSON

{
  "Hans": [
    {
      "id": "1",
      "firstName": "Hans",
      "lastName": "Gruber",
      "email": "[e-mail]"
    },
    {
      "id": "3",
      "firstName": "Hans",
      "lastName": "Nickerdorph",
      "email": "[e-mail]"
    }
  ],
  "Lars": [
    {
      "id": "2",
      "firstName": "Lars",
      "lastName": "Ulrich",
      "email": "[e-mail]"
    }
  ]
}

keys( $sql )

Request the keys contained in the query.

$user = $sqli->keys('SELECT * FROM users');

JSON

[
  "id",
  "firstName",
  "lastName",
  "email"
]

values( $sql )

Request only the values of the first row in the query.

$user = $sqli->values('SELECT * FROM users');

JSON

[
  "1",
  "Hans",
  "Gruber",
  "[e-mail]"
]