Type Definitions
CheckResult
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
errors | Array.<String> | String representation of errors found |
passed | Array.<String> | String representation of passed checks |
ColumnStructure
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
Field | String | Column name |
Type | String | Column type |
Null | "YES" | | Whether the column allows null-values |
Key | "" | | PRI = Primary, MUL = Indexed, UNI = Unique |
Default | String | | Default values for this row |
Extra | "" | | Any extra |
ConstraintOptions
Type:
Properties- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
primary | Boolean | <optional> | Whether this column should be primary |
index | Boolean | <optional> | Whether this column should be indexable (Faster query, slower insertion) |
null | Boolean | <optional> | Whether this column is null per default |
unique | Boolean | <optional> | Whether this column data should be unique |
default | String | <optional> | Set's the default data for this column |
auto_increment | Boolean | <optional> | Whether this column should be numerical auto_increment |
unsigned | Boolean | <optional> | Only on numerical: Whether this numerical field should be unsigned |
InstanceOptions
Type:
Properties- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
charset | String | <optional> | Charset to use |
defaultDatabase | String | <optional> | The default database |
multipleStatements | Boolean | <optional> | Whether multiple statements should be allowed in a single query |
insecureAuth | Boolean | <optional> | Whether insecure authentication methods should be allowed |
customIdentifier | String | <optional> | Sets a custom identifier for this instance |
isDefault | Boolean | <optional> | Whether this instance is returned by default via 'getInstance' |