tspace-mysql 1.0.7 → 1.0.8

package/README.md

@@ -12,17 +12,26 @@ Install with [npm](https://www.npmjs.com/):
 
 ```sh
 npm install tspace-mysql --save
-
 ```
 ## Basic Usage
 - [Configuration](#configuration)
 - [Running Queries](#running-queryies)
 - [Database Transactions](#database-transactions)
-- [Accessing Connections](#accessing-connections)
-- [Query Logging](#query-logging)
+- [Connection](#connection)
+- [Backup](#backup)
 - [Generating Model Classes](#generating-model-classes)
 - [Model Conventions](#model-conventions)
 - [Relationships](#relationships)
+  - [One To One](#one-to-one)
+  - [One To Many](#one-to-many)
+  - [One To One & One To Many (Inverse) / Belongs To](#inverse-belongs-to)
+  - [Many To Many](#many-to-many)
+- [Query Builder](#query-builder)
+- [Cli](#cli)
+  - [Make Model](#make-model)
+  - [Make Migration](#make-migration)
+  - [Migrate](#migrate)
+- [Blueprint](#blueprint)
 
 ## Configuration
 Created your environment variables is to use a .env file, you may establish a connection is this:
@@ -72,7 +81,9 @@ const user = await new DB('users').create({
         email : 'tspace3@gmail.com'
     }).save()
     // user =>  { id : 3 , username : 'tspace3', email : 'tspace3@gmail.com'}
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 const reposity = new DB('users')
     reposity.name = 'tspace4'
     reposity.email = 'tspace4@gmail.com'
@@ -88,7 +99,9 @@ const user = await new DB('users').where('id',1)
           email : 'tspace1@gmail.com'
     }).save()
     // user =>  { id : 1 , username : 'tspace1**', email : 'tspace1@gmail.com'} 
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 const reposity = new DB('users').where('id',1)
     reposity.name = 'tspace1++'
     reposity.email = 'tspace1++@gmail.com'
@@ -102,7 +115,9 @@ const deleted = await new DB('users').where('id',1).delete()
     // deleted => true
 ``` 
 ## Database Transactions 
+
 Within a database transaction, you may use the:
+
 ```js
 const transaction = await new DB().beginTransaction()
 try {
@@ -128,6 +143,57 @@ try {
    // * rollback data user, userSecond in your database
 }
 ```
+
+## Connection
+When establishing a connection, you may establish options is this:
+```js
+const users = await new DB('users')
+    .connection({
+       host: 'localhost..',
+       port : 3306,
+       database: 'database'
+       username: 'username',
+       password: 'password',
+    })
+    .findMany()
+// users => [{ .... }]
+```
+
+## Backup
+Backup database, you may backup is this:
+```js
+/**
+ * 
+ * @param conection defalut current connection
+ */
+const backup = await new DB().backup({
+     database: 'try-to-backup',
+     connection ?: {
+        host: 'localhost..',
+        port : 3306,
+        database: 'database'
+        username: 'username',
+        password: 'password',
+    }
+})
+/**
+ * 
+ * @param conection defalut current connection
+ */
+const backupToFile = await new DB().backupToFile({
+     database: 'try-to-backup',
+     filePath: 'backup.sql',
+     connection ?: {
+        host: 'localhost..',
+        port : 3306,
+        database: 'database'
+        username: 'username',
+        password: 'password',
+  }
+})
+// backupToFile => backup.sql
+```
+
 ## Generating Model Classes
 To get started, let's install npm install tspace-mysql -g  
 you may use the make:model command to generate a new model:
@@ -191,7 +257,9 @@ class User extends Model {
     }
 }
 export default User
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 import User from '../User'
 const user = await new User().with('brand').findOne()
 // user?.phone => {...} 
@@ -226,7 +294,9 @@ class Post extends Model {
     }
 }
 export default Post
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 import Post from '../Post'
 const posts = await new Post().with('comments').findOne()
 // posts?.comments => [{...}]
@@ -260,7 +330,9 @@ class Phone extends Model {
     }
 }
 export default Phone
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 import Phone from '../Phone'
 const phone = await new Phone().with('user').findOne()
 // phone?.user => {...}
@@ -295,14 +367,16 @@ class User extends Model {
     }
 }
 export default User
-+----------------------------------------------------------------------------------+
+
++--------------------------------------------------------------------------+
+
 import User from '../User'
 const user = await new User().with('roles').findOne()
 // user?.roles => [{...}]
 const userUsingFunction = await new User().roles().findOne()
 // user?.roles => [{...}]
 ```
-## Query Builder Chaining
+## Query Builder
 method chaining for queries
 ```js
 where(column , operator , value)   
@@ -317,7 +391,6 @@ whereNull(column)
 whereNotNull(column)
 whereBetween (column , [value1 , value2])
 whereSubQuery(colmn , rawSQL)
-
 select(column1 ,column2 ,...N)
 except(column1 ,column2 ,...N)
 only(column1 ,column2 ,...N)
@@ -331,12 +404,14 @@ having (condition)
 latest (column)
 oldest (column)
 groupBy (column)
-
 create(objects)
 createMultiple(array objects)
 update (objects)
 createNotExists(objects)
 updateOrCreate (objects)
+connection(options)
+backup({ database , connection })
+backupToFile({ filePath, database , connection })
 
 /** 
  * registry relation in your models
@@ -438,7 +513,7 @@ tspace-mysql migrate --dir=App/Models/Migrations
 // => migrate all schema table in folder into database
 ```
 
-## Blueprint method
+## Blueprint
 Schema table created by command make:migration,  you may use the:
 ```js
 import { Schema , Blueprint , DB } from 'tspace-mysql'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tspace-mysql",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "mysql query builder object relational mapping",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",