datasource

ref urn:com.cohga.server.datasource.jdbc#1.0:datasource

yes

reference to the data source that this data definition should use to generate its data

table

string

yes

The name of the table that provides the data

key

string

no

If this data definition is generating data relating to an entity then this is the column name that contains the entities id

prefix

string

no

The prefix value will be inserted into the generated SQL statement immediately after the SELECT, for example DISTINCT

trim

boolean

no

If true the generated SQL will ensure that the id's are compared against a trimmed version of the id stored in the database.
This helps with systems like Pathway, where some tables store padded id's

keytable

string

no

An optional database table that will be used to store entity keys temporarily when performing the required SQL to generate the data for this data connection. If this option isn't set then the SQL used to generate the data will create the data in batches, which can cause issues with sorting, optionally you can create a simple two column table, with an index on the userid column, and set this value to the name of this table, then Weave will insert the entity id's into this table temporarily and use this table in a SQL join when generating the data. This will resolve any sorting issues, and is more important if caching is also disabled for the data connection.

keycolumn

string

no

The column in keytable that contains the entity id, default is key

usercolumn

string

no

The column in keytable that contains the userid, default is userid

parameter

urn:com.cohga.server.data.database#1.0:parameter

0..n

cache

urn:com.cohga.server.cache#1.0:cache

0..1

from

urn:com.cohga.server.data.database#1.0:from

0..n

where

urn:com.cohga.server.data.database#1.0:where

0..n

sort

urn:com.cohga.server.data.database#1.0:sort

0..n

join

urn:com.cohga.server.data.database#1.0:join

0..n

options

urn:com.cohga.server.data.database#1.0:options

0..1

column

string

yes

The name of the column within the table that this parameter references (can be an sql function also)

type

'string', 'numeric', 'date' or 'url'

no

'string'

An indicator of how the data should be displayed on the client

name

string

no

lowercase value of column

A unique identifier for the parameter

label

string

no

"pretty" value of column

A user displayable label for the column

text

string

no

Only when type is 'url'. Specifies text to be displayed to the user instead of the actual url contents

textcolumn

string

no

Only when type is 'url'. Specifies the column that contains text to be displayed to the user instead of the actual url contents

format

string

no

"date", "time" or "datetime"

When the type attribute is date this value can force the value to be formatted as as specific date type.

from

urn:com.cohga.server.data.database#1.0:from

0..n

where

urn:com.cohga.server.data.database#1.0:where

0..n

table

string

yes

The table to join to

on

string

yes

The clause used to join the table

type

string

no

The type of join to use

clause

string

no

Additional clauses that can be added to the join

rpad

number

no

If the key value needs to be padded with spaces on the right to make it match the database, this specifies the total length of the final padded value.

For example rpad = 10 would change a key value from "value" to "value....." (where each . is a space).

lpad

number

no

If the key value needs to be padded with spaces on the left to make it match the database, this specifies the total length of the final padded value.

For example lpad = 10 would change a key value from "value" to ".....value" (where each . is a space).

trim

boolean

no

If a key value needs to be trimmed of spaces before being used setting this to true will cause that to be done.

maxrows

number

no

Limit the number of rows that will be extracted from the database when generating the data.

failOnSubstitutionError

boolean

no

If set to true, or not set at all, this flag will force the generation of the data to fail if there is an issue with performing parameter substitution.

If this is set to false then a where clause that fails parameter substitution will be ignored.

The default value for this flag if it is not set is true.

timeout

number

no

The number of milliseconds before the SQL should be cancelled. Default 120000, can be disabled by setting to 0, can be changed globally by setting the system property weave.data.timeout. Also, the system property weave.data.mimimumtimeout specifies a minimum value, currently 5000, that if the timeout is set greater than 0 but less than this value it will be increased to be this value.