https://github.com/allnulled/mysql-schema

Generate a JSON representing the schema of your MySQL database.
https://github.com/allnulled/mysql-schema

Last synced: 1 day ago
JSON representation

Generate a JSON representing the schema of your MySQL database.

• Host: GitHub
• URL: https://github.com/allnulled/mysql-schema
• Owner: allnulled
• Created: 2020-03-22T13:01:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-10T15:40:24.000Z (over 3 years ago)
• Last Synced: 2024-10-07T00:25:22.817Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/mysql-schema
• Size: 184 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# mysql-schema

Generate a JSON representing the schema of your MySQL database.

## Install

`$ npm i -g mysql-schema`

## Why?

To generate schema definitions of MySQL databases automatically.

To abstract your code and repeat things the least possible.

When you care about the shape, content relies on you. *Be water.*

## Usage

This tool enables you to generate a `json` file representing your `mysql` database.

### CLI usage

This is a short explanation of how the CLI works.

```bash

$ mysql-schema

	[--user]           root               # database user                 = process.env.DB_USER           || 'root'

	[--password]                          # database user password        = process.env.DB_PASSWORD       || ''

	[--host]           127.0.0.1          # database host                 = process.env.DB_HOST           || '127.0.0.1'

	[--port]           3306               # database port                 = process.env.DB_PORT           || 3306

	[--database]       test               # database name                 = process.env.DB_NAME           || 'test'

	[--configurations]                    # database configurations file  = process.env.DB_CONFIGURATIONS || false

	[--extensions]                        # database schema extensions    = process.env.DB_EXTENSIONS     || false

	[--as-json]                           # to generate a json & not a js = false

	--output           schema.{db}.js     # output file                   = "schema.${database}.js"

```

### API usage

This is a short explanation of how the API works.

```js

require("mysql-schema").getSchema({

	user:            process.env.DB_USER           || 'root',

	password:        process.env.DB_PASSWORD       || '',

	host:            process.env.DB_HOST           || '127.0.0.1',

	port:            process.env.DB_PORT           || '3306',

	database:        process.env.DB_NAME           || 'test',

	configurations:  process.env.DB_CONFIGURATIONS || false,

	extensions:      process.env.DB_EXTENSIONS     || false,

	asJson:          false,

	output:          `./schema.${database}.js`

})

```

## API reference

### `const MySQLSchema = require("mysql-schema")`

Master class of the `mysql-schema` API.

### `MySQLSchema.getSchema(options:Object):Promise`

**Asynchronous**.

**Description**:  Generates a schema representing the MySQL database pointing.

**Parameter**:  `options` - object with properties (all of them optional):

   - `user`:           `string` - user of the database

       - *default:*      **`process.env.DB_USER`** or `"root"`

   - `password`:       `string` - password of the database

       - *default:*      **`process.env.DB_PASSWORD`** or `""`

   - `host`:           `string` - host of the database

       - *default:*      **`process.env.DB_HOST`** or `"127.0.0.1"`

   - `port`:           `string` - port of the database

       - *default:*      **`process.env.DB_PORT`** or `3306`

   - `database`:       `string` - name of the database

       - *default:*      **`process.env.DB_NAME`** or `"test"`

   - `configurations`: `string` - configurations file for the database (overrides the other parameters)

       - *default:*      **`process.env.DB_CONFIGURATIONS`** or `false`

       - *usage:*        object that allows to set the same database configuration from an external file.

   - `extensions`:     `string` - extensions file for the generation

       - *default:*      **`process.env.DB_EXTENSIONS`** or `false`

       - *usage:* object that allows to extend the schema:

           - `perTable`:      filled with nested table, column, and extension properties.

           - `perColumn`:     filled with nested column, and extension properties.

           - in `general`:    filled with extension properties.

   - `asJson`:         `boolean` - flag to output a `json` instead of a `js` file

       - *default:*      `false`

       - *usage:*        flag to output a JSON file. As JSON, functions, regex and dates are lost as genuine types in the exportation.

   - `output`:         `string` - destination of the file with the schema

       - *default:*      **`process.env.DB_SCHEMA`** or `false`

### `MySQLSchema.stringifyFn(value:Object, spaces:Number):String`

**Description**:  Like `JSON.stringify`, but with a replacer that 

converts to JavaScript instead, accepting `Function`, `RegExp`

and `Date` objects as native data.

## Issues

Please, report issues and suggestions [here](https://github.com/allnulled/mysql-schema/issues).

## License

This project is licensed under [WTFPL or What The Fuck Public License](http://www.wtfpl.net/), which means 'do what you want with it'.