Open.ControlTier > ModuleForge
 
 
PDF -icon
PDF

HsqldbRdb

A Hypersonic SQL database service

Overview

Open in Workbench HsqldbRdb: A Hypersonic SQL database service

Design

Super Type
Rdb
Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name

Constraints

Allowed Child Dependencies

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Attributes

Defaults for Imported Attributes

Name Default
hsqldbRdbHome ${entity.deployment-install-root}
hsqldbRdbJavaHome ${env.JAVA_HOME}
rdbConnection jdbc:hsqldb:hsql://localhost:1701
rdbDriver org.hsqldb.jdbcDriver
rdbInstanceName db1
rdbPassword
rdbPort 1701
rdbType hsqldb
rdbUserName sa

Commands

Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

Docs-Generate

Generate the server properties file

Usage
Docs-Generate [-database <db1>] [-hostname <localhost>] [-hsqldbhome <${entity.deployment-install-root}>] [-password <>] [-port <1701>] [-username <sa>]

Options

Option Description
database Name of the first database file and its alias
hostname Host name to use with SQL Tool
hsqldbhome Value of HSQLDB_HOME
password Password to use with SQL Tool
port Server port
username User name to use with SQL Tool

startService

Start the Hypersonic SQL database server instance

Usage
startService [-hsqldbhome <${entity.deployment-install-root}>] [-javahome <${env.JAVA_HOME}>]

Options

Option Description
hsqldbhome Value of HSQLDB_HOME
javahome Value of JAVA_HOME

stopService

Stop the Hypersonic SQL database server instance

Usage
stopService [-database <db1>] [-hsqldbhome <${entity.deployment-install-root}>] [-javahome <${env.JAVA_HOME}>]

Options

Option Description
database Name of the first database file and its alias
hsqldbhome Value of HSQLDB_HOME
javahome Value of JAVA_HOME

assertServiceIsUp

Check whether the Hypersonic SQL database server instance is up

Usage
assertServiceIsUp [-database <db1>] [-hsqldbhome <${entity.deployment-install-root}>] [-javahome <${env.JAVA_HOME}>]

Options

Option Description
database Name of the first database file and its alias
hsqldbhome Value of HSQLDB_HOME
javahome Value of JAVA_HOME

assertServiceIsDown

Check whether the Hypersonic SQL database server instance is down

Usage
assertServiceIsDown [-database <db1>] [-hsqldbhome <${entity.deployment-install-root}>] [-javahome <${env.JAVA_HOME}>]

Options

Option Description
database Name of the first database file and its alias
hsqldbhome Value of HSQLDB_HOME
javahome Value of JAVA_HOME

Deploy

Run the service deployment cycle, stopping installing package dependencies, configuring and the starting it.

Usage
Deploy

Workflow

  1. Stop
  2. Packages-Install
  3. Configure
  4. Start

Related Types

The following types are defined for use with HsqldbRdb.

HsqldbRdbSetting

Overview

Open in Workbench HsqldbRdbSetting: A Hypersonic SQL database configuration setting

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies

HsqldbRdbJavaHome

Overview

Open in Workbench HsqldbRdbJavaHome: JAVA_HOME to use to run a Hypersonic SQL database server instance

Design

Super Type
HsqldbRdbSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
hsqldbRdbJavaHome settingValue

HsqldbRdbHome

Overview

Open in Workbench HsqldbRdbHome: HSQLDB_HOME to use to run a Hypersonic SQL database server instance

Design

Super Type
HsqldbRdbSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
hsqldbRdbHome settingValue