├── .gitattributes
└── README.md


/.gitattributes:
--------------------------------------------------------------------------------
1 | *.sql linguist-detectable=true
2 | *.sql linguist-language=sql
3 | *.sql text
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | SQL queries generated by Eloquent ORM reference
  2 | 
  3 | [Get](#get)
  4 | 
  5 | [Where](#where)
  6 | 
  7 | [Create](#create)
  8 | 
  9 | [Update](#update)
 10 | 
 11 | [Delete](#delete)
 12 | 
 13 | [One to One](#one-to-one)
 14 | 
 15 | [One to Many](#one-to-many)
 16 | 
 17 | [Many to Many](#many-to-many)
 18 | 
 19 | [Aggregate functions](#aggregate-functions)
 20 | 
 21 | [Miscellaneous](#miscellaneous)
 22 |  
 23 | 
 24 | 
 25 | ## Get
 26 | 
 27 | `get` (`all`)
 28 | 
 29 | <pre lang=php>User::get()</pre>
 30 | <pre lang=sql>SELECT * FROM users</pre>
 31 | &nbsp;
 32 | 
 33 | `get` (`all`) with soft deletes on
 34 | <pre lang=php>User::get()</pre><pre lang=sql>SELECT * FROM users WHERE users.deleted_at IS NULL</pre>
 35 | &nbsp;
 36 | 
 37 | `get` with soft deleted rows
 38 | <pre lang=php>User::withTrashed()->get()</pre><pre lang=sql>SELECT * FROM users</pre>
 39 | &nbsp;
 40 | 
 41 | `first`
 42 | <pre lang=php>User::first()</pre><pre lang=sql>SELECT * FROM users LIMIT 1</pre>
 43 | &nbsp;
 44 | 
 45 | `find`
 46 | <pre lang=php>User::find(2)</pre><pre lang=sql>SELECT * FROM users WHERE users.id = 2 LIMIT 1</pre>
 47 | &nbsp;
 48 | 
 49 | `findMany`
 50 | <pre lang=php>User::findMany([1, 2, 3])</pre><pre lang=sql>SELECT * FROM users WHERE users.id IN (1, 2, 3)</pre>
 51 | &nbsp;
 52 | 
 53 | `value`
 54 | <pre lang=php>User::where('name', 'John Smith')->value('email')</pre><pre lang=sql>SELECT email FROM users WHERE name = 'John Smith' LIMIT 1</pre>
 55 | &nbsp;
 56 | 
 57 | `paginate`
 58 | <pre lang=php>User::paginate()</pre>
 59 | ```sql
 60 | SELECT COUNT(*) AS aggregate FROM users
 61 | SELECT * FROM users LIMIT 15 OFFSET 0
 62 | ```
 63 | &nbsp;
 64 | 
 65 | 
 66 | 
 67 | ## Where
 68 | 
 69 | `where`
 70 | <pre lang=php>User::where('age', '>', 32)->get()</pre><pre lang=sql>SELECT * FROM users WHERE `age` > 32</pre>
 71 | &nbsp;
 72 | 
 73 | `orWhere`
 74 | <pre lang=php>User::where('age', '>', 40)->orWhere('age', '<', 20)->get()</pre><pre lang=sql>SELECT * FROM users WHERE age > 40 OR age < 20</pre>
 75 | &nbsp;
 76 | 
 77 | `whereIn`
 78 | <pre lang=php>User::whereIn('age', [20, 30, 40])->get()</pre><pre lang=sql>SELECT * FROM users WHERE age IN (20, 30, 40)</pre>
 79 | &nbsp;
 80 | 
 81 | `whereBetween`
 82 | <pre lang=php>User::whereBetween('age', [20,40])->get()</pre><pre lang=sql>SELECT * FROM users WHERE age BETWEEN 20 AND 40</pre>
 83 | &nbsp;
 84 | 
 85 | `whereDate`
 86 | <pre lang=php>User::whereDate('created_at', now())->get()</pre><pre lang=sql>SELECT * FROM `users` WHERE DATE(created_at) = '2023-10-04'</pre>
 87 | &nbsp;
 88 | 
 89 | 
 90 | 
 91 | ## Create
 92 | 
 93 | `create`
 94 | <pre lang=php>User::create(['name' => 'John', 'email' => 'john@smith.com'])</pre>
 95 | ```sql
 96 | INSERT INTO users (name, email, updated_at, created_at)
 97 |     VALUES ('John', 'john@smith.com', '2023-10-04 15:30:34', '2023-10-04 15:30:34')
 98 | ```
 99 | &nbsp;
100 | 
101 | `firstOrCreate`
102 | <pre lang=php>User::firstOrCreate(['email' => 'john@smith.com'], ['name' => 'John'])</pre>
103 | ```sql
104 | SELECT * FROM users WHERE (email = 'john@smith.com') LIMIT 1
105 | INSERT INTO users (email, name, updated_at, created_at)
106 |     VALUES ('john@smith.com', 'John', '2023-10-04 16:17:59', '2023-10-04 16:17:59')
107 | ```
108 | &nbsp;
109 | 
110 | 
111 | 
112 | ## Update
113 | 
114 | `UPDATE`
115 | <pre lang=php>User::where('status', 'some_status')->update(['type' => 'some_type'])</pre>
116 | ```sql
117 | UPDATE users SET type = 'some_type', users.updated_at = '2023-10-04 15:36:44'
118 |     WHERE status = 'some_status'
119 | ```
120 | &nbsp;
121 | 
122 | Update single row
123 | <pre lang=php>$user->update(['name' => 'John', 'email' => 'john@smith.com'])</pre>
124 | ```sql
125 | UPDATE users SET name = 'John', email = 'john@smith.com', users.updated_at = '2023-10-04 16:12:30'
126 |     WHERE id = 1
127 | ```
128 | &nbsp;
129 | 
130 | `updateOrCreate`
131 | <pre lang=php>User::updateOrCreate(['email' => 'john@smith.com'], ['name' => 'James']);</pre>
132 | ```sql
133 | SELECT * FROM users WHERE (email = 'john@smith.com') LIMIT 1
134 | UPDATE users SET name = 'James', users.updated_at = '2023-10-04 16:14:18'
135 |     WHERE id = 1
136 | ```
137 | &nbsp;
138 | 
139 | 
140 | 
141 | ## Delete
142 | 
143 | `delete`
144 | <pre lang=php>User::where('status', 'some_status')->delete()</pre><pre lang=sql>DELETE FROM users WHERE status = 'some_status'</pre>
145 | &nbsp;
146 | 
147 | Delete with soft deletes on
148 | <pre lang=php>User::where('status', 'some_status')->delete()</pre>
149 | ```sql
150 | UPDATE users SET deleted_at = '2023-10-25 12:58:26', users.updated_at = '2023-10-25 12:58:26'
151 |     WHERE status = 'some_status' AND users.deleted_at IS NULL
152 | ```
153 | &nbsp;
154 | 
155 | Delete single row
156 | <pre lang=php>$user->delete()</pre><pre lang=sql>DELETE FROM users WHERE id = 1</pre>
157 | &nbsp;
158 | 
159 | Delete single row with soft deletes on
160 | <pre lang=php>$user->delete()</pre>
161 | ```sql
162 | UPDATE users SET deleted_at = '2023-10-25 12:59:52', users.updated_at = '2023-10-25 12:59:52'
163 |     WHERE id = 1
164 | ```
165 | &nbsp;
166 | 
167 | `destroy`
168 | <pre lang=php>User::destroy(1, 2, 3)</pre>
169 | ```sql
170 | SELECT * FROM users WHERE id IN (1, 2, 3)
171 | DELETE FROM users WHERE id = 1
172 | DELETE FROM users WHERE id = 2
173 | DELETE FROM users WHERE id = 3
174 | ```
175 | &nbsp;
176 | 
177 | Destroy with soft deletes on
178 | <pre lang=php>User::destroy(1, 2, 3)</pre>
179 | ```sql
180 | SELECT * FROM users WHERE id IN (1, 2, 3) AND users.deleted_at IS NULL
181 | UPDATE users SET deleted_at = '2023-10-25 12:54:53', users.updated_at = '2023-10-25 12:54:53' WHERE id = 1
182 | UPDATE users SET deleted_at = '2023-10-25 12:54:53', users.updated_at = '2023-10-25 12:54:53' WHERE id = 2
183 | UPDATE users SET deleted_at = '2023-10-25 12:54:53', users.updated_at = '2023-10-25 12:54:53' WHERE id = 3
184 | ```
185 | &nbsp;
186 | 
187 | Restore soft deleted row
188 | <pre lang=php>$user->restore()</pre><pre lang=sql>UPDATE users SET deleted_at = '', users.updated_at = '2023-10-25 13:07:24' WHERE id = 1</pre>
189 | &nbsp;
190 | 
191 | 
192 | 
193 | ## One to One
194 | 
195 | `profiles` table has `id`, `user_id`, `city`
196 | 
197 | User `hasOne` profile, profile `belongsTo` user
198 | 
199 | For nested relationships examples another one to one relationship is used. Profile `hasOne` passport, passport `belongsTo` profile
200 | 
201 | Get user's profile
202 | <pre lang=php>$user->profile or $user->profile()->first()</pre><pre lang=sql>SELECT * FROM profiles WHERE profiles.user_id = 2 AND profiles.user_id IS NOT NULL LIMIT 1</pre>
203 | &nbsp;
204 | 
205 | Get user with profile
206 | <pre lang=php>User::with('profile')->find(2)</pre>
207 | ```sql
208 | SELECT * FROM users WHERE users.id = 2 LIMIT 1
209 | SELECT * FROM profiles WHERE profiles.user_id IN (2)
210 | ```
211 | &nbsp;
212 | 
213 | Get user's passport (nested one to one relationships)
214 | <pre lang=php>$user->profile->passport</pre>
215 | ```sql
216 | SELECT * FROM users WHERE users.id = 2 LIMIT 1
217 | SELECT * FROM profiles WHERE profiles.user_id = 2 AND profiles.user_id IS NOT NULL LIMIT 1
218 | SELECT * FROM passports WHERE passports.profile_id = 4 AND passports.profile_id IS NOT NULL LIMIT 1
219 | ```
220 | &nbsp;
221 | 
222 | Get user with profile AND passport (nested one to one relationships)
223 | <pre lang=php>User::with('profile.passport')->find(2)</pre>
224 | ```sql
225 | SELECT * FROM users WHERE users.id = 2 LIMIT 1
226 | SELECT * FROM profiles WHERE profiles.user_id IN (2)
227 | SELECT * FROM passports WHERE passports.profile_id IN (4)
228 | ```
229 | &nbsp;
230 | 
231 | Get users who have profiles
232 | <pre lang=php>User::has('profile')->get()</pre>
233 | ```sql
234 | SELECT * FROM users WHERE EXISTS
235 |     (SELECT * FROM profiles WHERE users.id = profiles.user_id)
236 | ```
237 | &nbsp;
238 | 
239 | Get users who have passport (nested one to one relationships)
240 | <pre lang=php>User::has('profile.passport')->get()</pre>
241 | ```sql
242 | SELECT * FROM users WHERE EXISTS
243 |     (SELECT * FROM profiles WHERE users.id = profiles.user_id AND EXISTS
244 |         (SELECT * FROM passports WHERE profiles.id = passports.profile_id)
245 |     )
246 | ```
247 | &nbsp;
248 | 
249 | Get users from Adelaide
250 | ```php
251 | User::whereHas('profile', function ($q) {
252 |     $q->where('city', 'Adelaide');
253 | })->get();
254 | ```
255 | ```sql
256 | SELECT * FROM users WHERE EXISTS
257 | (SELECT * FROM profiles WHERE users.id = profiles.user_id AND city = 'Adelaide')
258 | ```
259 | &nbsp;
260 | 
261 | Get users who have profiles and load their profiles
262 | <pre lang=php>User::has('profile')->with('profile')->get()</pre>
263 | ```sql
264 | SELECT * FROM users WHERE EXISTS
265 |     (SELECT * FROM profiles WHERE users.id = profiles.user_id)
266 | SELECT * FROM profiles WHERE profiles.user_id IN (1, 2, 3)
267 | ```
268 | &nbsp;
269 | 
270 | 
271 | 
272 | ## One to Many
273 | 
274 | `orders` table has `id`, `user_id`, `comment`
275 | 
276 | User has many orders. Order `belongsTo` user
277 | 
278 | For nested relationships examples another one to many relationship is used. Order `hasMany` support tickets, support ticket `belongsTo` order.
279 | 
280 | Get user's orders
281 | <pre lang=php>$user->orders or $user->orders()->get()</pre><pre lang=sql>SELECT * FROM orders WHERE orders.user_id = 1 AND orders.user_id IS NOT NULL</pre>
282 | &nbsp;
283 | 
284 | Get users with orders
285 | <pre lang=php>User::with('orders')->get()</pre>
286 | ```sql
287 | SELECT * FROM users
288 | SELECT * FROM orders WHERE orders.user_id IN (1, 2, 3)
289 | ```
290 | &nbsp;
291 | 
292 | Get users with orders and support tickets (nested one to many relationships)
293 | <pre lang=php>User::with('orders.supportTickets')->get()</pre>
294 | ```sql
295 | SELECT * FROM users
296 | SELECT * FROM orders WHERE orders.user_id IN (1, 2, 3)
297 | SELECT * FROM support_tickets WHERE support_tickets.order_id IN (7, 8, 9)
298 | ```
299 | &nbsp;
300 | 
301 | Load companies for user
302 | <pre lang=php>$user->load('orders')</pre><pre lang=sql>SELECT * FROM orders WHERE orders.user_id IN (1)</pre>
303 | &nbsp;
304 | 
305 | Get users who have orders
306 | <pre lang=php>User::has('orders')->get()</pre>
307 | ```sql
308 | SELECT * FROM users WHERE EXISTS
309 |     (SELECT * FROM orders WHERE users.id = orders.user_id)
310 | ```
311 | &nbsp;
312 | 
313 | Get users who have support tickets (nested one to many relationships)
314 | <pre lang=php>User::has('orders.supportTickets')->get()</pre>
315 | ```sql
316 | SELECT * FROM users WHERE EXISTS
317 |     (SELECT * FROM orders WHERE users.id = orders.user_id AND EXISTS
318 |         (SELECT * FROM support_tickets WHERE orders.id = support_tickets.order_id))
319 | ```
320 | &nbsp;
321 | 
322 | Get users who has orders with empty comment
323 | ```php
324 | User::whereHas('orders', function ($q) {
325 |     $q->whereNull('comment');
326 | })->get()
327 | ```
328 | ```sql
329 | SELECT * FROM users WHERE EXISTS
330 |     (SELECT * FROM orders WHERE users.id = orders.user_id AND comment IS NULL)
331 | ```
332 | &nbsp;
333 | 
334 | Get users who have orders and load their orders
335 | <pre lang=php>User::has('orders')->with('orders')->get()</pre>
336 | ```sql
337 | SELECT * FROM users WHERE EXISTS
338 |     (SELECT * FROM orders WHERE users.id = orders.user_id)
339 | SELECT * FROM orders WHERE orders.user_id IN (1, 2, 3)
340 | ```
341 | &nbsp;
342 | 
343 | 
344 | 
345 | ## Many to Many
346 | 
347 | `companies` table has `id`, `name`
348 | 
349 | `company_user` is a pivot table, it has `company_id`, `user_id` columns
350 | 
351 | User `belongsToMany` companies, company `belongsToMany` users
352 | 
353 | For nested relationships examples another many to many relationship is used. Company `belongsToMany` employees, employee `belongsToMany` companies
354 | 
355 | Get user's companies
356 | <pre lang=php>$user->companies or user->companies()->get()</pre>
357 | ```sql
358 | SELECT companies.*, company_user.user_id AS pivot_user_id, company_user.company_id AS pivot_company_id
359 |     FROM companies
360 |     INNER JOIN company_user ON companies.id = company_user.company_id
361 |     WHERE company_user.user_id = 1
362 | ```
363 | &nbsp;
364 | 
365 | Get users with companies
366 | <pre lang=php>User::with('companies')->get()</pre>
367 | ```sql
368 | SELECT * FROM users
369 | SELECT companies.*, company_user.user_id AS pivot_user_id, company_user.company_id AS pivot_company_id
370 |     FROM companies
371 |     INNER JOIN company_user ON companies.id = company_user.company_id
372 |     WHERE company_user.user_id IN (1, 2, 3)
373 | ```
374 | &nbsp;
375 | 
376 | Get users with employees (nested many to many relationships)
377 | <pre lang=php>User::with('companies.employees')->get()</pre><pre lang=sql>SELECT * FROM users</pre>
378 | ```sql
379 | SELECT companies.*, company_user.user_id AS pivot_user_id, company_user.company_id AS pivot_company_id
380 |     FROM companies
381 |     INNER JOIN company_user ON companies.id = company_user.company_id
382 |     WHERE company_user.user_id IN (1, 2, 3)
383 | SELECT employees.*, company_employee.company_id AS pivot_company_id, company_employee.employee_id AS pivot_employee_id
384 |     FROM employees
385 |     INNER JOIN company_employee ON employees.id = company_employee.employee_id
386 |     WHERE company_employee.company_id IN (7, 8, 9)
387 | ```
388 | &nbsp;
389 | 
390 | Load companies for user
391 | <pre lang=php>$user->load('companies')</pre>
392 | ```sql
393 | SELECT companies.*, company_user.user_id AS pivot_user_id, company_user.company_id AS pivot_company_id
394 |     FROM companies
395 |     INNER JOIN company_user ON companies.id = company_user.company_id
396 |     WHERE company_user.user_id IN (1)
397 | ```
398 | &nbsp;
399 | 
400 | Load companies and employees for user (nested many to many relationships)
401 | <pre lang=php>$user->load('companies.employees')</pre>
402 | ```sql
403 | SELECT companies.*, company_user.user_id AS pivot_user_id, company_user.company_id AS pivot_company_id
404 |     FROM companies
405 |     INNER JOIN company_user ON companies.id = company_user.company_id
406 |     WHERE company_user.user_id IN (2)
407 | SELECT employees.*, company_employee.company_id AS pivot_company_id, company_employee.employee_id AS pivot_employee_id
408 |     FROM employees
409 |     INNER JOIN company_employee ON employees.id = company_employee.employee_id
410 |     WHERE company_employee.company_id IN (7, 8, 9)
411 | ```
412 | &nbsp;
413 | 
414 | Get users who have companies
415 | <pre lang=php>User::has('companies')->get()</pre>
416 | ```sql
417 | SELECT * FROM users WHERE EXISTS
418 |     (SELECT * FROM companies
419 |         INNER JOIN company_user ON companies.id = company_user.company_id
420 |         WHERE users.id = company_user.user_id)
421 | ```
422 | &nbsp;
423 | 
424 | Get users who have companies with employees (nested many to many relationships)
425 | <pre lang=php>User::has('companies.employees')->get()</pre>
426 | ```sql
427 | SELECT * FROM users WHERE EXISTS
428 |     (SELECT * FROM companies
429 |         INNER JOIN company_user ON companies.id = company_user.company_id
430 |         WHERE users.id = company_user.user_id AND EXISTS
431 |             (SELECT * FROM employees
432 |                 INNER JOIN company_employee ON employees.id = company_employee.employee_id
433 |                 WHERE companies.id = company_employee.company_id))
434 | ```
435 | &nbsp;
436 | 
437 | Get users who have companies with empty description
438 | ```php
439 | User::whereHas('companies', function ($q) {
440 |     $q->whereNull('description');
441 | })->get()
442 | ```
443 | ```sql
444 | SELECT * FROM users WHERE EXISTS
445 |     (SELECT * FROM companies
446 |         INNER JOIN company_user ON companies.id = company_user.company_id
447 |         WHERE users.id = company_user.user_id AND description IS NULL)
448 | ```
449 | &nbsp;
450 | 
451 | Get users who have companies and load their companies
452 | <pre lang=php>User::has('orders')->with('orders')->get()</pre>
453 | ```sql
454 | SELECT * FROM users WHERE EXISTS
455 |     (SELECT * FROM orders WHERE users.id = orders.user_id)
456 | SELECT * FROM orders WHERE orders.user_id IN (1, 2, 3)
457 | ```
458 | &nbsp;
459 | 
460 | 
461 | 
462 | ## Aggregate functions
463 | 
464 | `count`
465 | <pre lang=php>User::count()</pre><pre lang=sql>SELECT COUNT(*) AS aggregate FROM users</pre>
466 | &nbsp;
467 | 
468 | `max` (`min`, `avg`, `sum`)
469 | <pre lang=php>User::max('age')</pre><pre lang=sql>SELECT MAX(age) AS aggregate FROM users</pre>
470 | &nbsp;
471 | 
472 | `withSum` (`withAvg`, `withMin`, `withMax`, `withCount`)
473 | <pre lang=php>User::withSum('orders', 'total')->get();</pre><pre lang=sql>SELECT users.*, (SELECT SUM(orders.total) FROM orders WHERE users.id = orders.user_id) AS orders_sum_total FROM users</pre>
474 | &nbsp;
475 | 
476 | 
477 | 
478 | ## Miscellaneous
479 | 
480 | `latest` (`oldest``)
481 | <pre lang=php>User::latest()->get()</pre><pre lang=sql>SELECT * FROM users ORDER BY created_at DESC</pre>
482 | &nbsp;
483 | 
484 | `withExists`
485 | <pre lang=php>User::withExists('orders')->get()</pre><pre lang=sql>SELECT users.*, EXISTS(SELECT * FROM orders WHERE users.id = orders.user_id) AS orders_exists FROM users</pre>
486 | &nbsp;
487 | 
488 | `increment` (`decrement`)
489 | <pre lang=php>User::where('id', 2)->increment('bonus', 12)</pre><pre lang=sql>UPDATE users SET bonus = bonus + 12, users.updated_at = '2023-10-25 14:58:10' WHERE id = 2</pre>
490 | 


--------------------------------------------------------------------------------