hotstaq 0.5.3

package/docs/classes/MySQLSchema.md

@@ -0,0 +1,199 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / MySQLSchema
+
+# Class: MySQLSchema
+
+The MySQL schema.
+
+## Hierarchy
+
+- [`HotDBSchema`](HotDBSchema.md)
+
+  ↳ **`MySQLSchema`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MySQLSchema.md#constructor)
+
+### Properties
+
+- [name](MySQLSchema.md#name)
+- [tables](MySQLSchema.md#tables)
+
+### Methods
+
+- [addFieldToTable](MySQLSchema.md#addfieldtotable)
+- [addFieldsToTable](MySQLSchema.md#addfieldstotable)
+- [addTable](MySQLSchema.md#addtable)
+- [generateStructure](MySQLSchema.md#generatestructure)
+- [generateTableStructure](MySQLSchema.md#generatetablestructure)
+
+## Constructors
+
+### constructor
+
+• **new MySQLSchema**(`name`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Overrides
+
+[HotDBSchema](HotDBSchema.md).[constructor](HotDBSchema.md#constructor)
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:16](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L16)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+The name of this schema.
+
+#### Inherited from
+
+[HotDBSchema](HotDBSchema.md).[name](HotDBSchema.md#name)
+
+#### Defined in
+
+[schemas/HotDBSchema.ts:15](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/HotDBSchema.ts#L15)
+
+___
+
+### tables
+
+• **tables**: `Object`
+
+The tables in this schema.
+
+#### Index signature
+
+▪ [name: `string`]: [`MySQLSchemaTable`](MySQLSchemaTable.md)
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:14](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L14)
+
+## Methods
+
+### addFieldToTable
+
+▸ **addFieldToTable**(`tableName`, `field`): `void`
+
+Add a field to a table.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tableName` | `string` |
+| `field` | [`MySQLSchemaField`](MySQLSchemaField.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:34](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L34)
+
+___
+
+### addFieldsToTable
+
+▸ **addFieldsToTable**(`tableName`, `fields`): `void`
+
+Add a field to a table.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tableName` | `string` |
+| `fields` | [`MySQLSchemaField`](MySQLSchemaField.md)[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:45](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L45)
+
+___
+
+### addTable
+
+▸ **addTable**(`table`): `void`
+
+Add a table to this schema.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `table` | [`MySQLSchemaTable`](MySQLSchemaTable.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:26](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L26)
+
+___
+
+### generateStructure
+
+▸ **generateStructure**(`type?`, `db?`): `Promise`<`string`[][]\>
+
+Generate the entire db structure. If type is set to modify, you must pass a db with an
+active connection.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `type` | [`HotDBGenerationType`](../enums/HotDBGenerationType.md) | `HotDBGenerationType.Create` |
+| `db` | [`HotDBMySQL`](HotDBMySQL.md) | `null` |
+
+#### Returns
+
+`Promise`<`string`[][]\>
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:77](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L77)
+
+___
+
+### generateTableStructure
+
+▸ **generateTableStructure**(`tableName`, `type?`, `db?`): `Promise`<`string`[]\>
+
+Generate a table's structure. If type is set to modify, you must pass a db with an
+active connection.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `tableName` | `string` | `undefined` |
+| `type` | [`HotDBGenerationType`](../enums/HotDBGenerationType.md) | `HotDBGenerationType.Create` |
+| `db` | [`HotDBMySQL`](HotDBMySQL.md) | `null` |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+[schemas/mysql/MySQLSchema.ts:61](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchema.ts#L61)

package/docs/classes/MySQLSchemaField.md

@@ -0,0 +1,330 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / MySQLSchemaField
+
+# Class: MySQLSchemaField
+
+The database field.
+
+## Implements
+
+- `IMySQLSchemaField`
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MySQLSchemaField.md#constructor)
+
+### Properties
+
+- [autoIncrement](MySQLSchemaField.md#autoincrement)
+- [binaryColumn](MySQLSchemaField.md#binarycolumn)
+- [dataType](MySQLSchemaField.md#datatype)
+- [defaultValue](MySQLSchemaField.md#defaultvalue)
+- [fillZeroes](MySQLSchemaField.md#fillzeroes)
+- [generatedColumn](MySQLSchemaField.md#generatedcolumn)
+- [name](MySQLSchemaField.md#name)
+- [notNull](MySQLSchemaField.md#notnull)
+- [primaryKey](MySQLSchemaField.md#primarykey)
+- [strAroundDefaultValue](MySQLSchemaField.md#strarounddefaultvalue)
+- [uniqueIndex](MySQLSchemaField.md#uniqueindex)
+- [unsignedDataType](MySQLSchemaField.md#unsigneddatatype)
+
+### Methods
+
+- [generate](MySQLSchemaField.md#generate)
+- [compare](MySQLSchemaField.md#compare)
+- [parse](MySQLSchemaField.md#parse)
+
+## Constructors
+
+### constructor
+
+• **new MySQLSchemaField**(`name`, `dataType?`, `defaultValue?`, `primaryKey?`, `notNull?`, `uniqueIndex?`, `binaryColumn?`, `unsignedDataType?`, `fillZeroes?`, `autoIncrement?`, `generatedColumn?`, `strAroundDefaultValue?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` \| `IMySQLSchemaField` | `undefined` |
+| `dataType` | `string` | `""` |
+| `defaultValue` | `string` | `""` |
+| `primaryKey` | `boolean` | `false` |
+| `notNull` | `boolean` | `true` |
+| `uniqueIndex` | `boolean` | `false` |
+| `binaryColumn` | `boolean` | `false` |
+| `unsignedDataType` | `boolean` | `false` |
+| `fillZeroes` | `boolean` | `false` |
+| `autoIncrement` | `boolean` | `false` |
+| `generatedColumn` | `boolean` | `false` |
+| `strAroundDefaultValue` | `string` | `"'"` |
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:145](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L145)
+
+## Properties
+
+### autoIncrement
+
+• **autoIncrement**: `boolean`
+
+Set as an auto incrementing column.
+
+#### Implementation of
+
+IMySQLSchemaField.autoIncrement
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:129](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L129)
+
+___
+
+### binaryColumn
+
+• **binaryColumn**: `boolean`
+
+Set as a binary column.
+
+#### Implementation of
+
+IMySQLSchemaField.binaryColumn
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:117](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L117)
+
+___
+
+### dataType
+
+• **dataType**: `string`
+
+The data type, be sure to include the length of the
+data type here as well.
+
+#### Implementation of
+
+IMySQLSchemaField.dataType
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:101](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L101)
+
+___
+
+### defaultValue
+
+• **defaultValue**: `string`
+
+Set the default value. If this is set to null, a
+MySQL NULL value will be used.
+
+#### Implementation of
+
+IMySQLSchemaField.defaultValue
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:138](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L138)
+
+___
+
+### fillZeroes
+
+• **fillZeroes**: `boolean`
+
+If this column is a number, fill with zeroes.
+
+#### Implementation of
+
+IMySQLSchemaField.fillZeroes
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:125](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L125)
+
+___
+
+### generatedColumn
+
+• **generatedColumn**: `boolean`
+
+Set as a generated column.
+
+#### Implementation of
+
+IMySQLSchemaField.generatedColumn
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:133](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L133)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the field.
+
+#### Implementation of
+
+IMySQLSchemaField.name
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:96](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L96)
+
+___
+
+### notNull
+
+• **notNull**: `boolean`
+
+Set as a not null.
+
+#### Implementation of
+
+IMySQLSchemaField.notNull
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:109](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L109)
+
+___
+
+### primaryKey
+
+• **primaryKey**: `boolean`
+
+Set as a primary key.
+
+#### Implementation of
+
+IMySQLSchemaField.primaryKey
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:105](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L105)
+
+___
+
+### strAroundDefaultValue
+
+• **strAroundDefaultValue**: `string`
+
+Set the string to be used when setting the default
+value. The default is: '
+
+#### Implementation of
+
+IMySQLSchemaField.strAroundDefaultValue
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:143](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L143)
+
+___
+
+### uniqueIndex
+
+• **uniqueIndex**: `boolean`
+
+Set as a unique index.
+
+#### Implementation of
+
+IMySQLSchemaField.uniqueIndex
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:113](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L113)
+
+___
+
+### unsignedDataType
+
+• **unsignedDataType**: `boolean`
+
+Set as an unsigned data type.
+
+#### Implementation of
+
+IMySQLSchemaField.unsignedDataType
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:121](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L121)
+
+## Methods
+
+### generate
+
+▸ **generate**(): `Promise`<[`MySQLSchemaFieldResult`](../interfaces/MySQLSchemaFieldResult.md)\>
+
+Generate the db command.
+
+#### Returns
+
+`Promise`<[`MySQLSchemaFieldResult`](../interfaces/MySQLSchemaFieldResult.md)\>
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:326](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L326)
+
+___
+
+### compare
+
+▸ `Static` **compare**(`field1`, `field2`, `onlyKeys?`, `stringFilter?`): `boolean`
+
+Compare two different fields. This will iterate through all keys in each field. Any
+string values found will have stringFilter applied to it, removing everything that
+is in that stringFilter regex. Additionally for any empty strings found it will
+compare to any undefined/null on the other side, and treat them as the same.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `field1` | [`MySQLSchemaField`](MySQLSchemaField.md) | `undefined` | The first field to compare. |
+| `field2` | [`MySQLSchemaField`](MySQLSchemaField.md) | `undefined` | The second field to compare. |
+| `onlyKeys` | `string`[] | `null` | Only compare using the provided keys. If set to null, this will compare using all of the keys in these objects. |
+| `stringFilter` | `RegExp` | `undefined` | The regex to be used to help make any filters on any detected strings. The default regex provided will remove any whitespaces, single/doube quotes, back ticks, and parenthesis. If this is set to null, it will not be used. |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:201](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L201)
+
+___
+
+### parse
+
+▸ `Static` **parse**(`json`): [`MySQLSchemaField`](MySQLSchemaField.md)
+
+Parse a JSON object and get a MySQLSchemaField object from it.
+Warning! This is only partially implemented. This will not check
+the following fields:
+* Binary column
+* unique
+* zero-filled
+* generated column
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `json` | `any` |
+
+#### Returns
+
+[`MySQLSchemaField`](MySQLSchemaField.md)
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:266](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L266)

package/docs/classes/MySQLSchemaTable.md

@@ -0,0 +1,176 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / MySQLSchemaTable
+
+# Class: MySQLSchemaTable
+
+The database table.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MySQLSchemaTable.md#constructor)
+
+### Properties
+
+- [charset](MySQLSchemaTable.md#charset)
+- [description](MySQLSchemaTable.md#description)
+- [engine](MySQLSchemaTable.md#engine)
+- [fields](MySQLSchemaTable.md#fields)
+- [name](MySQLSchemaTable.md#name)
+
+### Methods
+
+- [addField](MySQLSchemaTable.md#addfield)
+- [addFields](MySQLSchemaTable.md#addfields)
+- [generate](MySQLSchemaTable.md#generate)
+
+## Constructors
+
+### constructor
+
+• **new MySQLSchemaTable**(`name?`, `fields?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` | `""` |
+| `fields` | [`MySQLSchemaField`](MySQLSchemaField.md)[] | `[]` |
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:31](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L31)
+
+## Properties
+
+### charset
+
+• **charset**: `string`
+
+The table's charset to use.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:29](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L29)
+
+___
+
+### description
+
+• **description**: `string`
+
+The table's description.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:17](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L17)
+
+___
+
+### engine
+
+• **engine**: `string`
+
+The table's engine to use.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:25](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L25)
+
+___
+
+### fields
+
+• **fields**: [`MySQLSchemaField`](MySQLSchemaField.md)[]
+
+The fields in the table.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:21](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L21)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the table.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:13](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L13)
+
+## Methods
+
+### addField
+
+▸ **addField**(`field`): `void`
+
+Add a field.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `field` | [`MySQLSchemaField`](MySQLSchemaField.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:43](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L43)
+
+___
+
+### addFields
+
+▸ **addFields**(`fields`): `void`
+
+Add a field.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fields` | [`MySQLSchemaField`](MySQLSchemaField.md)[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:51](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L51)
+
+___
+
+### generate
+
+▸ **generate**(`type?`, `db?`): `Promise`<`string`[]\>
+
+Generate the db command. If type is set to modify, you must pass a db with an
+active connection. Since field parsing isn't completely implemented yet, not all
+fields will be modified correctly. Use modifiying with caution. This will
+skip checking for:
+* Binary columnexistingFields
+* unique
+* zero-filled
+* generated column
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `type` | [`HotDBGenerationType`](../enums/HotDBGenerationType.md) | `HotDBGenerationType.Create` |
+| `db` | [`HotDBMySQL`](HotDBMySQL.md) | `null` |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaTable.ts:70](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaTable.ts#L70)