Database Plugin Reference 5.1.x

The XL Deploy Database plugin supports deployment of SQL files and folders to a database client.

This document provides information that is specific to this version of the Database plugin. For general information about the plugin, refer to Introduction to the XL Deploy Database plugin.

Requirements

The Database plugin requires user credentials for accessing the database client executables on the host that runs the database.

Using the deployables and deployeds

Deployable vs. container table

The following table describes which deployable/container combinations are possible.

Deployable Container Generated deployed
sql.SqlScripts sql.OracleClient,
sql.MySqlClient,
sql.Db2Client,
sql.MsSqlClient,
sql.PostgreSqlClient
sql.ExecutedSqlScripts

Deployed actions table

The following table describes the effect a deployed has on its container.

Deployed Actions performed for operations
  Create Destroy Modify
sql.ExecutedSqlScripts For each installation script in the folder (ordered lexicographically by name, ascending):
  • Run script through template engine
  • Copy script to container
  • Execute script
For each rollback script in the folder (ordered lexicographically by name, descending):
  • Run script through template engine
  • Copy script to container
  • Execute script
For each installation script in the folder that was not part of the deployment being upgraded (ordered lexicographically by name, ascending):
  • Run script through template engine
  • Copy script to container
  • Execute script

CI Reference

Configuration Item Overview

Deployables

CI Description
sql.SqlScripts ZIP file containing SQL scripts

Deployeds

CI Description
sql.ExecutedSqlScripts SQL scripts executed on an SQL client

Containers

CI Description
sql.Db2Client IBM DB2 client
sql.MsSqlClient Microsoft SQL Server client
sql.MySqlClient MySQL client
sql.OracleClient Oracle SQL*Plus client
sql.PostgreSqlClient PostqreSQL Server client
sql.SqlClient Generic SQL client

Other Configuration Items

CI Description
sql.Db2Client IBM DB2 client
sql.ExecutedSqlScripts SQL scripts executed on an SQL client
sql.MsSqlClient Microsoft SQL Server client
sql.MySqlClient MySQL client
sql.OracleClient Oracle SQL*Plus client
sql.PostgreSqlClient PostqreSQL Server client
sql.PostgreSqlClient_testConnection Generated type for method testConnection
sql.SqlClient Generic SQL client
sql.SqlScripts ZIP file containing SQL scripts

Configuration Item Details

sql.Db2Client

Type Hierarchy sql.SqlClient >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

IBM DB2 client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
databaseName : STRING
The name of the DB2 database to connect to
 
 
db2Home : STRING
The directory that contains the DB2 installation
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
clientWrapperScript : STRING  = sql/Db2Client
The OS-specific wrapper script that calls the SQL client
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.ExecutedSqlScripts

Type Hierarchy generic.ExecutedFolder >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

SQL scripts executed on an SQL client

Parent
 
 
container : CI<udm.Container>
The container on which this deployed runs.
Public Properties
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
password : STRING
If set, the password to use. Falls back to the optional default password set on the sql.SqlClient container
 
 
placeholders : MAP_STRING_STRING
A key/value pair mapping of placeholders in the deployed artifact to their values. Special values are and
 
 
username : STRING
If set, the user name to use. Falls back to the optional default user name set on the sql.SqlClient container
Hidden Properties
 
 
commonScriptFolderName : STRING  = common
Common folder that should be uploaded to the working directory.
 
 
createOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
 
 
createOrder : INTEGER  = 50
The order of the step in the step list for the create operation.
 
 
createVerb : STRING  = Run
Create Verb
 
 
destroyOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
 
 
destroyOrder : INTEGER  = 40
The order of the step in the step list for the destroy operation.
 
 
destroyVerb : STRING  = Rollback
Destroy Verb
 
 
executorScript : STRING  = ${deployed.container.clientWrapperScript}
Name of the executor script that will be executed for each script found in the folder.
 
 
modifyOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
 
 
modifyOrder : INTEGER  = 50
The order of the step in the step list for the modify operation.
 
 
modifyVerb : STRING  = Modify
Modify Verb
 
 
noopOptions : SET_OF_STRING  = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
 
 
noopOrder : INTEGER  = 50
The order of the step in the step list for the noop operation.
 
 
noopVerb : STRING  = Modify
Noop Verb
 
 
rollbackScriptPostfix : STRING  = -rollback.sql
A script's associated rollback script is derived by using the 1st group identified by the scriptRecognitionRegex and then appending this postfix to it. e.g give name '01-myscript.sql', regex '([0-9]*-.*)\.sql' and rollback script postfix '-rollback.sql', we can derive the name of the associated rollback script to be '01-myscript-rollback.sql'
 
 
rollbackScriptRecognitionRegex : STRING  = ([0-9]*-.*-rollback)\.sql
Regular expression used to identify a rollback script in the folder. A successful match should returns a single group, ie the logical script name. e.g. [0-9]*-.*-rollback\.sql
 
 
scriptRecognitionRegex : STRING  = (?!.*-rollback\.sql)([0-9]*-.*)\.sql
Regular expression used to identify a script in the folder. A successful match should returns a single group to which the rollbackScriptPostfix can be appended in order to find the associated rollback script or the script's dependent subfolder. e.g.([0-9]*-.*)\.sql
 
 
checkpointAfterFirstScript : BOOLEAN  = true
If set to true, the checkpoint is set after the first script in a folder has been executed. Otherwise the checkpoint is set after the last script in a folder has been executed.
 
 
classpathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the script.
 
 
executeModifiedScripts : BOOLEAN  = true
If set to true, modified scripts are also executed on a MODIFY or a NOOP.
 
 
executeRollbackForModifiedScripts : BOOLEAN  = true
If set to true, rollback scripts for modified scripts are also executed on a MODIFY or a NOOP.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartRequired : BOOLEAN  = false
The generic container requires a restart for the action performed by this deployed.
 
 
restartRequiredForNoop : BOOLEAN  = false
The generic container requires a restart for the NOOP action performed by this deployed.
 
 
templateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.MsSqlClient

Type Hierarchy sql.SqlClient >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

Microsoft SQL Server client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
serverName : STRING
The name of the MS SQL Server to connect to
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
databaseName : STRING
The name of the MS SQL database to connect to
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
clientWrapperScript : STRING  = sql/MsSqlClient
The OS-specific wrapper script that calls the SQL client
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.MySqlClient

Type Hierarchy sql.SqlClient >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

MySQL client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
databaseName : STRING
The name of the MySQL database to connect to
 
 
mySqlHome : STRING
The directory that contains the MySQL installation
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
clientWrapperScript : STRING  = sql/MySqlClient
The OS-specific wrapper script that calls the SQL client
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.OracleClient

Type Hierarchy sql.SqlClient >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

Oracle SQL*Plus client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
oraHome : STRING
The directory that contains the Oracle installation
 
 
sid : STRING
The Oracle SID to connect to
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
clientWrapperScript : STRING  = sql/OracleClient
The OS-specific wrapper script that calls the SQL client
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.PostgreSqlClient

Type Hierarchy sql.SqlClient >> generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, udm.Container, generic.GenericContainer, overthere.HostContainer

PostqreSQL Server client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
databaseName : STRING
The name of the PostgreSQL database to connect to
 
 
port : STRING  = 5432
The port of the PostgreSQL server to connect to
 
 
postgreSqlHome : STRING
The directory that contains the PostgreSQL installation
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
useLocalhost : BOOLEAN  = true
Use localhost as the hostname to connect to
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
clientWrapperScript : STRING  = sql/PostgreSqlClient
The OS-specific wrapper script that calls the SQL client
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
Control task Parameter CI Attributes Description
testConnection sql.PostgreSqlClient_testConnection

script = sql/PostgreSqlClient, delegate = shellScript

Test connection to PostgreSQL database server


sql.PostgreSqlClient_testConnection

Type Hierarchy udm.Parameters >> udm.BaseConfigurationItem
Interfaces udm.ConfigurationItem

Generated type for method testConnection.

Public Properties
 
 
testSqlStatement : STRING  = SELECT 1;
SQL statement to test the connection to the PostgreSQL server

sql.SqlClient

Virtual Type
Type Hierarchy generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.ConfigurationItem, generic.GenericContainer, udm.Container, overthere.HostContainer

Generic SQL client

Parent
 
 
host : CI<overthere.Host>
Host upon which the container resides
Public Properties
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
clientWrapperScript : STRING
The OS-specific wrapper script that calls the SQL client
 
 
envVars : MAP_STRING_STRING
Environment variables for container
 
 
password : STRING
If set, the password to use if none is set on the deployed sql.ExecutedSqlScripts
 
 
stopStartRestartConnection : CI<overthere.Host>
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
 
 
tags : SET_OF_STRING
If set, only deployables with the same tag will be automatically mapped to this container.
 
 
username : STRING
If set, the user name to use if none is set on the deployed sql.ExecutedSqlScripts
Hidden Properties
 
 
restartOrder : INTEGER  = 90
The order of the restart container step in the step list.
 
 
restartWaitTime : INTEGER  = 0
The time to wait in seconds for a container restart action.
 
 
startOrder : INTEGER  = 90
The order of the start container step in the step list.
 
 
startWaitTime : INTEGER  = 0
The time to wait in seconds for a container start action.
 
 
stopOrder : INTEGER  = 10
The order of the stop container step in the step list.
 
 
stopWaitTime : INTEGER  = 0
The time to wait in seconds for a container stop action.
 
 
inspectClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
 
 
inspectScript : STRING
Classpath to the script used to inspect the generic container.
 
 
inspectTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
restartClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
 
 
restartScript : STRING
Classpath to the script used to restart the generic container.
 
 
restartTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
startClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the start script.
 
 
startScript : STRING
Classpath to the script used to start the generic container.
 
 
startTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
 
 
stopClasspathResources : SET_OF_STRING
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
 
 
stopScript : STRING
Classpath to the script used to stop the generic container.
 
 
stopTemplateClasspathResources : SET_OF_STRING
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

sql.SqlScripts

Type Hierarchy generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

ZIP file containing SQL scripts

Public Properties
 
 
additionalOptions : STRING
Specify additional options to be passed to the command-line SQL client
 
 
checksum : STRING
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
 
 
excludeFileNamesRegex : STRING
Regular expression that matches file names that must be excluded from scanning
 
 
fileUri : STRING
The URI pointing to the (remote) location of the file this artifact represents
 
 
password : STRING
The password to connect to the database
 
 
placeholders : SET_OF_STRING
Placeholders detected in this artifact
 
 
scanPlaceholders : BOOLEAN  = true
Whether to scan this artifact for placeholders when it is imported
 
 
tags : SET_OF_STRING
If set, this deployable will only be mapped automatically to containers with the same tag.
 
 
username : STRING
`The username to connect to the database
Hidden Properties
 
 
textFileNamesRegex : STRING  = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
Regular expression that matches file names of text files
 
 
delimiters : STRING  = {{ }}
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
 
 
fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings