verdnatura-mirror
/
loopback-connector-mysql
mirror of https://github.com/loopbackio/loopback-connector-mysql.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweaks to dataType documentation. 

Improved formatting, documented `collation` option, and added some examples for dataTypes.
This commit is contained in:
dgsan 2013-06-14 13:14:47 -06:00
parent aef99ca919
commit c6b4a70fc4
1 changed files with 36 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -28,6 +28,7 @@ To use it you need `jugglingdb@0.2.x`.
username: 'root' username: 'root'
}); });
``` ```
You can optionally pass a few additional parameters supported by `node-mysql`, most particularly `password` and `collation`. `Collation` currently defaults to `utf8mb4_general_ci`. The `collation` value will also be used to derive the connection charset.
## Running tests ## Running tests
@ -37,41 +38,60 @@ To use it you need `jugglingdb@0.2.x`.
The jugglingdb MySQL adapter now supports using the `dataType` column/property attribute to specify what MySQL column type is used for many jugglingdb types. The jugglingdb MySQL adapter now supports using the `dataType` column/property attribute to specify what MySQL column type is used for many jugglingdb types.
The following type-dataType combinations are supported (incomplete): The following type-dataType combinations are supported:
* Number * <h4> Number </h4>
* integer types * <h5> integer </h5>
* tinyint * tinyint
* smallint * smallint
* mediumint * mediumint
* int * int
* bigint * bigint
* use the 'limit' option to alter the display width
* example: Use the `limit` option to alter the display width.
Example:
`{ count : { type: Number, dataType: 'smallInt' }}` `{ count : { type: Number, dataType: 'smallInt' }}`
* floating point types
* <h5> floating point types </h5>
* float * float
* double * double
* use the `precision` and `scale` options to specify custom precision. Default is (16,8).
* example: Use the `precision` and `scale` options to specify custom precision. Default is (16,8).
Example:
`{ average : { type: Number, dataType: 'float', precision: 20, scale: 4 }}` `{ average : { type: Number, dataType: 'float', precision: 20, scale: 4 }}`
* fixed-point exact value types
* <h5> fixed-point exact value types </h5>
* decimal * decimal
* numeric * numeric
* use the `precision` and `scale` options to specify custom precision. Default is (9,2).
* these aren't likely to function as true fixed-point. Use the `precision` and `scale` options to specify custom precision. Default is (9,2).
* example:
These aren't likely to function as true fixed-point.
Example:
`{ stdDev : { type: Number, dataType: 'decimal', precision: 12, scale: 8 }}` `{ stdDev : { type: Number, dataType: 'decimal', precision: 12, scale: 8 }}`
* String / Schema.Text / Schema.JSON
* <h4> String / Schema.Text / Schema.JSON </h4>
* varchar * varchar
* char * char
* text * text
* mediumtext * mediumtext
* tinytext * tinytext
* longtext * longtext
* Date
Example:
`{ userName : { type: String, dataType: 'char', limit: 24 }}`
Example:
`{ biography : { type: String, dataType: 'longtext' }}`
* <h4> Date </h4>
* datetime * datetime
* timestamp * timestamp
Example:
`{ startTime : { type: Date, dataType: 'timestamp' }}`
## MIT License ## MIT License