new DatabaseWidget(options)
Widget for configuring a relational database
Parameters:
| Name | Type | Description |
|---|---|---|
options |
DatabaseWidgetOptions | Options for the widget |
- Source:
Extends
Members
-
className :string
-
Classes applied to the widget. Override if using Bootstrap 3
Type:
- string
- Inherited From:
- Default Value:
-
- Widget.prototype.className + ' settings-servergroup control-group form-horizontal'
- Source:
-
controlGroupClass
-
Class applied to control groups. Set to 'form-group' if using Bootstrap 3
- Inherited From:
- Default Value:
-
- control-group
- Source:
-
databaseTemplate :module:settings/js/widgets/database-widget.DatabaseWidget~DatabaseTemplate
-
Base template for the widget. Override if using Bootstrap 3
Type:
- Source:
-
errorClass
-
Class used to indicate failed validation. Set to 'has-error' if using Bootstrap 3
- Inherited From:
- Default Value:
-
- error
- Source:
-
formControlClass
-
Class applied to form controls. Set to 'form-control' if using Bootstrap 3
- Inherited From:
- Default Value:
-
- ''
- Source:
-
serverTemplate :module:settings/js/server-widget.ServerWidget~ServerWidgetTemplate
-
Base template for the widget. Override if using Bootstrap 3
Type:
- Inherited From:
- Source:
-
successClass
-
Class used to indicate successful validation. Set to 'has-success' if using Bootstrap 3
- Inherited From:
- Default Value:
-
- success
- Source:
-
widgetTemplate :module:settings/js/widget.Widget~WidgetTemplate
-
Base template for the widget. Override if using Bootstrap 3
Type:
- Inherited From:
- Source:
Methods
-
<protected> displayValidationMessage(isEqual, response)
-
If isEqual is true displays a message showing the result of a validation. Otherwise clears the
validation stateParameters:
Name Type Description isEqualboolean True if the config is equal to the config received from the server; false otherwise
responseValidationResponse The repsonse from the server
- Inherited From:
- Source:
-
getConfig()
-
Returns the configuration for the widget
- Source:
Returns:
The configuration for the widget
-
getName() → {string}
-
Gets the name for the widget
- Inherited From:
- Deprecated:
-
- Users of this class do not need to call this
- Source:
Returns:
this.serverName, or this.configItem if serverName is undefined
- Type
- string
-
getValidationFailureMessage(response) → {string}
-
Generates a message indicating that validation was unsuccessful
Parameters:
Name Type Description responseValidationResponse The response from the server
- Inherited From:
- Source:
Returns:
A message indicating validation was unsuccessful
- Type
- string
-
getValidationSuccessMessage(response) → {string}
-
Returns a message stating validation was successful. If response.data.sourceVersion === '0', returns
this.strings.flywayMigrationFromEmpty. If response.data is defined, returns
this.strings.flywayMigrationUpgrade. Otherwise returns this.strings.validateSuccess.Parameters:
Name Type Description responseDatabaseValidationResponse - Source:
Returns:
- Type
- string
-
handleInputChange(evt)
-
Handles input validation. Checking the database checkbox disables the database input. If the database
checkbox is checked, sets value of the database input to the value of the username inputParameters:
Name Type Description evtEvent jQuery event
- Source:
-
handleValidation()
-
Handles the results of server side validation
- Inherited From:
- Source:
-
hideValidationInfo()
-
Removes validation information as defined in Widget and also hides the connection state
- Inherited From:
- Source:
-
render()
-
Renders the widget
- Source:
-
setValidationFormatting(state)
-
Removes this.successClass and this.errorClass from elements in the widget with this.controlGroupClass.
If state === 'clear', remove successClass and errorClass from this.$el. Otherwise adds the given class
and removes the other classParameters:
Name Type Description statestring clear to remove classes, otherwise this.successClass or this.errorClass to add that
class and remove the other class- Inherited From:
- Source:
-
shouldValidate() → {boolean}
-
- Source:
Returns:
True
- Type
- boolean
-
triggerValidation()
-
Triggers validation when the test connection button is pressed
- Inherited From:
- Source:
Fires:
- event:validate Event indicating that validation should take place
-
updateConfig(config)
-
Updates the widget with new configuration
Parameters:
Name Type Description configThe new config for the wizard
- Source:
-
<protected> updateInputValidation($input, isValid)
-
Updates the formatting of the given input
If isValid is true, removes errorClass from the input and hides elements with the class
settings-client-validationIf isValid is false, adds errorClass to the input and shows elements with the class
settings-client-validationParameters:
Name Type Description $inputjQuery The input to apply the classes to
isValidboolean True if the input is valid; false otherwise
- Inherited From:
- Source:
-
validateInputs() → {boolean}
-
Validates the widget and applies formatting appropriately
- Source:
Returns:
False if any of host, username and database are blank or the password is invalid; true
otherwise- Type
- boolean
Type Definitions
-
DatabaseTemplate(parameters)
-
Parameters:
Name Type Description parametersDatabaseWidgetTemplateParameters - Source: