feat(doc): add DELETE executor ref to README

This commit is contained in:
Victor Westerlund 2024-02-14 11:00:42 +00:00 committed by GitHub
parent 50ff083c5f
commit cf0ea0836f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -37,6 +37,7 @@ Statement|Method
`SELECT`|[`select()`](#select) `SELECT`|[`select()`](#select)
`UPDATE`|[`update()`](#update) `UPDATE`|[`update()`](#update)
`INSERT`|[`insert()`](#insert) `INSERT`|[`insert()`](#insert)
`DELETE`|[`delete()`](#delete)
`WHERE`|[`where()`](#where) `WHERE`|[`where()`](#where)
`ORDER BY`|[`order()`](#order-by) `ORDER BY`|[`order()`](#order-by)
`LIMIT`|[`limit()`](#limit) `LIMIT`|[`limit()`](#limit)
@ -139,6 +140,34 @@ MySQL->for("beverages")->insert([
true true
``` ```
# DELETE
Use `MySQL->delete()` to remove a row or rows from the a database table.
```php
MySQL->delete(
array ...$conditions
): mysqli_result|bool
// Returns true if at least one row was deleted
```
This method takes at least one [`MySQL->where()`](#where)-syntaxed argument to determine which row or rows to delete. Refer to the [`MySQL->where()`](#where) section for more information.
#### Example
```php
MySQL->for("beverages")->insert([
null,
"coffee",
"latte",
10
]);
// INSERT INTO beverages VALUES (null, "coffee", "latte", 10);
```
```
true
```
# UPDATE # UPDATE
Modify existing rows with `MySQL->update()` Modify existing rows with `MySQL->update()`
@ -164,7 +193,7 @@ In most cases you probably want to UPDATE against a constaint. Chain a [`where()
# WHERE # WHERE
Filter a `select()` or `update()` method by chaining the `MySQL->where()` method anywhere before it. Filter a `select()` or `update()` method by chaining the `MySQL->where()` method anywhere before it. The `MySQL->delete()` executor method also uses the same syntax for its arguments.
```php ```php
MySQL->where( MySQL->where(