Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table plus

...

...

applyColStyleToCelltrue
heading0
columnTypess,s,s,

...

s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,

...

...

enableSorting

...

false

Syntax

databaseAvailable(dbstring [, sqlstring])

Package

sql

Alias

Pkg Usage

available(dbstring [, sqlstring])

Description

Excerpt
hiddentrue
Checks if the database is available.

</ac:rich-text-body>
</ac:structured-macro>
<p>Checks Checks if the database is available. Optionally, it can check also the availability of the results for the SQL passed in as the second parameter.</p></p>
<h2>Parameters</h2>
<ac:structured-macro ac:name="table-plus" ac:schema-version="1">
<ac:parameter ac:name="applyColStyleToCell">true</ac:parameter>
<ac:parameter ac:name="columnTypes">s

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,

...

<h2>Examples</h2>
<h3>Example 1</h3>
<p>Let's suppose in our examples `TextField` is a custom field text already configured for the current Jira server instance and `TestDB` represents the database resource name configured in the server context. For more details see <ac:link><ri:page ri:content-title="SQL data sources" /></ac:link>.</p>
<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATATextField=databaseAvailable("TestDB"); //will set 'TextField' value to 'true']>
</ac:plain-text-body>
</ac:structured-macro>

<h3>Example 2</h3>

<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATATextField=databaseAvailable("TestDB", "select pname from project"); //will set 'TextField' value to 'true' if the SQL passed in can be executed]>
</ac:plain-text-body>
</ac:structured-macro>

<h3>Example 3</h3>

<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATATextField=databaseAvailable("TestDB", "select pname from inexistentTableName");//will set 'TextField' value to 'false', because the SQL passed in cannot be executed]>
</ac:plain-text-body>
</ac:structured-macro>

<h3>Example 4</h3>

<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATATextField=databaseAvailable("InexistentTestDB", "select pname from project");//will set 'TextField' value to 'false', because the database resource does not exist]>
</ac:plain-text-body>
</ac:structured-macro>

<h2>Note</h2>
<p><ac:structured-macro ac:name="note" ac:schema-version="1">
<ac:rich-text-body>
<p>To configure the data source check the <ac:link><ri:page ri:content-title="SQL data sources" /></ac:link> configuration chapter.</p>
</ac:rich-text-body>
</ac:structured-macro></p>

<h2>See also</h2>
<p><ac:structured-macro ac:name="contentbylabel" ac:schema-version="4">
<ac:parameter ac:name="showLabels">false</ac:parameter>
<ac:parameter ac:name="max">25</ac:parameter>
<ac:parameter ac:name="showSpace">false</ac:parameter>
<ac:parameter ac:name="cql">label = "system_routines" and space = currentSpace ( )</ac:parameter>
<ac:parameter ac:name="labels">array_routines</ac:parameter>
</ac:structured-macro></p>

Info
titleAvailability

This routine is available starting with SIL Engine™ 2.6.5.

Syntax

databaseAvailable(dbstring [, sqlstring])

Description

Excerpt

Checks if the database is available. Optionally, it can check also the availability of the results for the SQL passed in as the second parameter.

 

Parameters

s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

dbstring

...

String

...

Yes

Datasource JNDI name or the datasource name. For Jira database, this is set to "jdbc/JiraDS" by default, if exported.

sqlstring

...

String

...

No

SQL string.

Return

...

Type

 boolean Boolean (true/false)

Examples

Example 1

Let's suppose in our examples `TextField` is a custom field text already configured for the current Jira server instance and `TestDB` represents the database resource name configured in the server context. For more details see SQL Data Source Configuration.

...

data sources.

Code Block
languagejava
TextField=databaseAvailable("TestDB"); //will set `TextField`'TextField' value to `true`'true'

Example 2

language
Code Block
java
TextField=databaseAvailable("TestDB", "select pname from project"); //will set `TextField`'TextField' value to `true`'true' if the SQL passed in can be executed

Example 3

language
Code Block
java
TextField=databaseAvailable("TestDB", "select pname from inexistentTableName");//will set `TextField`'TextField' value to `false`'false', because the SQL passed in cannot be executed

Example 4

java
Code Block
language
TextField=databaseAvailable("InexistentTestDB", "select pname from project");//will set `TextField`'TextField' value to `false`'false', because the database resource does not exist

...

Note

To configure the data source check the SQL

...

data sources configuration chapter.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "sqlsystem_support"routines" and space = currentSpace ( )
labelssqlarray_support
 
routines