From 8c394e89c12866578ce281b1d326b8ec737a6f35 Mon Sep 17 00:00:00 2001 From: Victor Westerlund Date: Thu, 2 Nov 2023 11:53:33 +0100 Subject: [PATCH] feat(doc): add with() in README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9178ecd..a94b4cb 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Statement|Method `ORDER BY`|[`order()`](#order-by) `LIMIT`|[`limit()`](#limit) ---- +---- `Example table name: beverages` id|beverage_type|beverage_name|beverage_size @@ -282,3 +282,13 @@ $coffee = $db->for("beverages")->limit([3 => 2])->select(["beverage_name", "beve // ...etc ] ``` + +---- + +# Restrict affected/returned database columns to table model + +Chain and pass an array to `MySQL->with()` before a `select()`, `update()`, or `insert()` method to limit which columns will be returned/affected. It will use the **values** of the array so it can be either sequential or associative. + +**This method will cause `select()`, `update()`, and `insert()` to ignore any columns that are not present in the passed table model.** + +You can remove an already set table model by passing `null` to `MySQL->with()`