Skip to content

Commit 0d77f03

Browse files
author
enes-sahin
authored
Merge pull request #1 from enes-sahin/develop
Develop
2 parents d19a0d8 + 884113e commit 0d77f03

File tree

2 files changed

+42
-42
lines changed

2 files changed

+42
-42
lines changed

README.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@ Use the node package manager [npm](https://www.npmjs.com/package/fluent-mysql) t
7070
npm install fluent-mysql
7171
```
7272

73-
```node
73+
```js
7474
const DB = require('fluent-mysql');
7575
```
7676

7777
## Connection to Database
7878
The parameters are the same with [mysql](https://www.npmjs.com/package/mysql) library. You can list all options from [here](https://www.npmjs.com/package/mysql#connection-options)
7979

8080

81-
```node
81+
```js
8282
const DB = require('fluent-mysql');
8383

8484
let connection = DB.connect({
@@ -105,7 +105,7 @@ connection.then(result => {
105105

106106
It is necessary to specify `table` in all queries except for writing your own query with `query` method.
107107

108-
```node
108+
```js
109109
// Get all records from users table
110110
let users = DB.table('users').get();
111111

@@ -118,7 +118,7 @@ users.then( results => {
118118

119119
Using the `select` method, you can specify a custom select clause for the query.
120120

121-
```node
121+
```js
122122
let users = DB.table('users').select('name', 'phone', 'age').get();
123123

124124
users.then( results => {
@@ -129,7 +129,7 @@ users.then( results => {
129129

130130
You can also use the distinct method to force the query to return distinct results.
131131

132-
```node
132+
```js
133133
let users = DB.table('users').select('name').distinct().get();
134134

135135
users.then( results => {
@@ -147,7 +147,7 @@ users.then( results => {
147147

148148
`get` must be the last method in methods chain.
149149

150-
```node
150+
```js
151151
let users = DB.table('users').get();
152152

153153
users.then( results => {
@@ -158,7 +158,7 @@ users.then( results => {
158158
### first()
159159
You can get only the first row from all results.
160160

161-
```node
161+
```js
162162
let users = DB.table('users').first();
163163

164164
users.then( result => {
@@ -170,7 +170,7 @@ users.then( result => {
170170
To retrieve a single row by its id column value, use the `find` method:
171171

172172

173-
```node
173+
```js
174174
let users = DB.table('users').find(10);
175175

176176
users.then( result => {
@@ -181,7 +181,7 @@ users.then( result => {
181181
### query()
182182

183183
You can also write your own query with `query` method.
184-
```node
184+
```js
185185
let users = DB.query(`SELECT * FROM users WHERE name = "John"`).get();
186186

187187
users.then( results => {
@@ -194,7 +194,7 @@ users.then( results => {
194194
### where()
195195

196196

197-
```node
197+
```js
198198
let users = DB.table('users').where('userName', '=', 'John' ).get();
199199

200200
users.then( results => {
@@ -205,7 +205,7 @@ users.then( results => {
205205
### orWhere()
206206

207207

208-
```node
208+
```js
209209
let users = DB.table('users').where('userName', '=', 'John' ).orWhere('age', '>', 20 ).get();
210210

211211
users.then( results => {
@@ -216,7 +216,7 @@ users.then( results => {
216216
### whereBetween()
217217

218218

219-
```node
219+
```js
220220
// Get users whose ages between 20 and 30
221221
let users = DB.table('users').whereBetween('age', 20, 40 ).get();
222222

@@ -228,7 +228,7 @@ users.then( results => {
228228
### orWhereBetween()
229229

230230

231-
```node
231+
```js
232232
let users = DB.table('users').where('name', '=', 'John' ).orWhereBetween('age', 30, 40 ).get();
233233

234234
users.then( results => {
@@ -239,7 +239,7 @@ users.then( results => {
239239
### whereNotBetween()
240240

241241

242-
```node
242+
```js
243243
let users = DB.table('users').whereNotBetween('age', 50, 60 ).get();
244244

245245
users.then( results => {
@@ -250,7 +250,7 @@ users.then( results => {
250250
### orWhereNotBetween()
251251

252252

253-
```node
253+
```js
254254
let users = DB.table('users').whereBetween('salary', 1000, 2000 ).orWhereNotBetween('age', 50, 60 ).get();
255255

256256
users.then( results => {
@@ -261,7 +261,7 @@ users.then( results => {
261261
### whereIn()
262262

263263

264-
```node
264+
```js
265265
let users = DB.table('users').whereIn('age', [25,35,45] ).get();
266266

267267
users.then( results => {
@@ -273,7 +273,7 @@ users.then( results => {
273273
### orWhereIn()
274274

275275

276-
```node
276+
```js
277277
let users = DB.table('users').where('userName', '=', 'John' ).orWhereIn('age', [25,35,45] ).get();
278278

279279
users.then( results => {
@@ -285,7 +285,7 @@ users.then( results => {
285285
### whereNotIn()
286286

287287

288-
```node
288+
```js
289289
let users = DB.table('users').whereNotIn('age', [25,35,45] ).get();
290290

291291
users.then( results => {
@@ -297,7 +297,7 @@ users.then( results => {
297297
### orWhereNotIn()
298298

299299

300-
```node
300+
```js
301301
let users = DB.table('users').where('userName', '=', 'John' ).orWhereNotIn('age', [20,30,40] ).get();
302302

303303
users.then( results => {
@@ -309,7 +309,7 @@ users.then( results => {
309309
### whereNull()
310310

311311

312-
```node
312+
```js
313313
let users = DB.table('users').whereNull('phone').get();
314314

315315
users.then( results => {
@@ -321,7 +321,7 @@ users.then( results => {
321321
### orWhereNull()
322322

323323

324-
```node
324+
```js
325325
let users = DB.table('users').whereNull('phone').orWhereNull('email').get();
326326

327327
users.then( results => {
@@ -333,7 +333,7 @@ users.then( results => {
333333
### whereNotNull()
334334

335335

336-
```node
336+
```js
337337
let users = DB.table('users').whereNotNull('phone' ).get();
338338

339339
users.then( results => {
@@ -344,7 +344,7 @@ users.then( results => {
344344
### orWhereNotNull()
345345

346346

347-
```node
347+
```js
348348
let users = DB.table('users').where('age', '>', 25 ).orWhereNotNull('email').get();
349349

350350
users.then( results => {
@@ -358,7 +358,7 @@ users.then( results => {
358358
The `orderBy` method allows you to sort the result of the query by a given column. The first argument to the `orderBy` method should be the column you wish to sort by, while the second argument controls the direction of the sort and may be either `asc` or `desc`.
359359

360360

361-
```node
361+
```js
362362
let users = DB.table('users').orderBy('name', 'ASC').get();
363363

364364
users.then( results => {
@@ -369,7 +369,7 @@ users.then( results => {
369369
### limit()
370370
To limit the number of results returned from the query, you may use the `limit` method.
371371

372-
```node
372+
```js
373373
let users = DB.table('users').limit(20).get();
374374

375375
users.then( results => {
@@ -380,7 +380,7 @@ users.then( results => {
380380
### offset()
381381
To skip a given number of results in the query, you may use the `offset` method.
382382

383-
```node
383+
```js
384384
let users = DB.table('users').limit(20).offset(10).get();
385385

386386
users.then( results => {
@@ -392,7 +392,7 @@ users.then( results => {
392392

393393
The `groupBy` and `having` methods may be used to group the query results.
394394

395-
```node
395+
```js
396396
let authorBooks = DB.table('books')
397397
.select('author', 'COUNT(bookID) AS totalBook')
398398
.groupBy('author')
@@ -412,7 +412,7 @@ Currently **fluent-mysql** supports only inner join.
412412

413413
The **fluent-mysql** may also be used to write join statements. The first argument passed to the join method is the name of the table you need to join to, while the remaining arguments specify the column constraints for the join. You can even join to multiple tables in a single query.
414414

415-
```node
415+
```js
416416
let users = DB.table('users')
417417
.join('contacts', 'users.id', '=', 'contacts.user_id')
418418
.join('orders', 'users.id', '=', 'orders.user_id')
@@ -430,33 +430,33 @@ You may call any of these methods after constructing your query. `min`, `max`, `
430430

431431
### count()
432432

433-
```node
433+
```js
434434
let usersCount = DB.table('users').count();
435435
```
436436
### min()
437437

438-
```node
438+
```js
439439
// SELECT MIN(age) AS minAge FROM users
440440
let minAge = DB.table('users').min('age', 'minAge');
441441
```
442442

443443
### max()
444444

445-
```node
445+
```js
446446
// SELECT MAX(age) AS maxAge FROM users
447447
let maxAge = DB.table('users').max('age', 'maxAge');
448448
```
449449

450450
### avg()
451451

452-
```node
452+
```js
453453
// SELECT AVG(age) AS avgAge FROM users
454454
let avgAge = DB.table('users').avg('age', 'avgAge');
455455
```
456456

457457
### sum()
458458

459-
```node
459+
```js
460460
// SELECT SUM(age) AS sumAge FROM users
461461
let sumAge = DB.table('users').sum('age', 'sumAge');
462462
```
@@ -465,15 +465,15 @@ let sumAge = DB.table('users').sum('age', 'sumAge');
465465

466466
Instead of using the `count` method to determine if any records exist that match your query's constraints, you may use the `exists` method.
467467

468-
```node
468+
```js
469469
let exists = DB.table('users').where('name', '=', 'John').exists();
470470
```
471471

472472
## Insert, Update & Delete
473473

474474
### insert()
475475

476-
```node
476+
```js
477477
let insertion = DB.table('users')
478478
.insert({id: 50, name: 'John', age:25});
479479

@@ -486,7 +486,7 @@ insertion.then( result => {
486486

487487
This method updates a record, if not exists creates it.
488488

489-
```node
489+
```js
490490
let update = DB.table('users')
491491
.insertOrUpdate({name: 'John', age:25});
492492

@@ -498,7 +498,7 @@ insertion.then( result => {
498498
### update()
499499

500500

501-
```node
501+
```js
502502
let update = DB.table('users')
503503
.update({id: 125, name: 'John', age:35});
504504

@@ -510,7 +510,7 @@ insertion.then( result => {
510510
Also you can use `where` method in order to specify conditions.
511511
(Be careful about putting `where` method before `update`.)
512512

513-
```node
513+
```js
514514
let update = DB.table('users')
515515
.where('age', '>',40)
516516
.update({salary : 5000});
@@ -522,7 +522,7 @@ insertion.then( result => {
522522

523523
### delete()
524524

525-
```node
525+
```js
526526
let deletion = DB.table('users')
527527
.where('name','=','John')
528528
.delete();
@@ -537,7 +537,7 @@ deletion.then( result => {
537537

538538
Example of using with multiple methods:
539539

540-
```node
540+
```js
541541
let users = DB.table('users')
542542
.select('name','age')
543543
.where('age', '>', 30)
@@ -552,7 +552,7 @@ users.then( results => {
552552
```
553553
**As long as you use the last method correctly, you can change the order of methods**
554554

555-
```node
555+
```js
556556
//Both functions returns the same result
557557
let users = DB.table('users').select('name','age').where('age', '>', 30).get();
558558

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,7 @@ class Database {
718718
if(id) {
719719
this.findId = id;
720720
}
721-
return this;
721+
return this.get();
722722
}
723723

724724
/**

0 commit comments

Comments
 (0)