Page History

{div:style=}

Wiki Markup

Div

style	display:none

DO

NOT

EDIT

THE

CONTENT

OF

THIS

PAGE

DIRECTLY

(EXCEPT

INSIDE

THE

DIV

BELOW

WITH

ID=DESCRIPTION),

UNLESS

YOU

KNOW

WHAT

YOU'RE

DOING.

THE

STRUCTURE

OF

THE

CONTENT

IS

VITAL

IN

BEING

ABLE

TO

AUTO

UPDATE

THE

CONTENT

THROUGH

THE

DOC

GENERATOR.

\\ \\ Enter additional information related to this

Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Constants Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#DATABASE_IDENTITY] Constant used when setting or getting the sequence type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#DATABASE_SEQUENCE] Constant used when setting or getting the sequence type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#DATETIME] Constant used when setting or getting the type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#EXCLUDED_COLUMN] Constant used when setting or getting the flags of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#INTEGER] Constant used when setting or getting the type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#MEDIA] Constant used when setting or getting the type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#NONE] Constant for column information indicating unset values.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#NUMBER] Constant used when setting or getting the type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#PK_COLUMN] Constant used when setting or getting the row identifier type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#ROWID_COLUMN] Constant used when setting or getting the row identifier type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#SERVOY_SEQUENCE] Constant used when setting or getting the sequence type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#TEXT] Constant used when setting or getting the type of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#UUID_COLUMN] Constant used when setting or getting the flags of columns.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#UUID_GENERATOR] Constant used when setting or getting the sequence type of columns.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#getAllowNull]\() Get the allow\-null flag of the column.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataProviderID]\() Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDescription]\() Get the description property of the column.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getForeignType]\() Get the foreign type of the column.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getLength]\() Get the length of the column as reported by the JDBC driver.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getQualifiedName]\() Get the qualified name (including table name) of the column as known by the database.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getQuotedSQLName]\() Returns a quoted version of the column name, if necessary, as defined by the actual database used.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getRowIdentifierType]\() Get the row identifier type of the column.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getSQLName]\() Get the name of the column as known by the database.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getScale]\() Get the scale of the column as reported by the JDBC driver.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getSequenceType]\() Get the sequence type of the column.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getTitle]\() Get the title property of the column.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getType]\() Get the JDBC type of the column.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getTypeAsString]\() Get the name JDBC type of the column.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#hasFlag]\(flag) Check a flag of the column.{td}{tr}{tbody}{table}\\ {table:id=constant|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Constants Details{th}{tr}{tbody:id=DATABASE_IDENTITY}{tr:id=name}{td}h6.DATABASE_IDENTITY{td}{tr}{tr:id=des}{td}{div:class=sIndent}Constant used when setting or getting the sequence type of columns.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#DATABASE_IDENTITY Constant used when setting or getting the sequence type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#DATABASE_SEQUENCE Constant used when setting or getting the sequence type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#DATETIME Constant used when setting or getting the type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#EXCLUDED_COLUMN Constant used when setting or getting the flags of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#INTEGER Constant used when setting or getting the type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#MEDIA Constant used when setting or getting the type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#NONE Constant for column information indicating unset values.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#NUMBER Constant used when setting or getting the type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#PK_COLUMN Constant used when setting or getting the row identifier type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#ROWID_COLUMN Constant used when setting or getting the row identifier type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#SERVOY_SEQUENCE Constant used when setting or getting the sequence type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#TEXT Constant used when setting or getting the type of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#UUID_COLUMN Constant used when setting or getting the flags of columns.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#UUID_GENERATOR Constant used when setting or getting the sequence type of columns.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#getAllowNull() Get the allow-null flag of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getDataProviderID() Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getDescription() Get the description property of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getForeignType() Get the foreign type of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getLength() Get the length of the column as reported by the JDBC driver.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getQualifiedName() Get the qualified name (including table name) of the column as known by the database.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getQuotedSQLName() Returns a quoted version of the column name, if necessary, as defined by the actual database used.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getRowIdentifierType() Get the row identifier type of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getSQLName() Get the name of the column as known by the database.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getScale() Get the scale of the column as reported by the JDBC driver.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getSequenceType() Get the sequence type of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getTitle() Get the title property of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getType() Get the JDBC type of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getTypeAsString() Get the name JDBC type of the column.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#hasFlag(flag) Check a flag of the column.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

Table Body (tbody)

id	DATABASE_IDENTITY

Table Row (tr)

id	name

Table Cell (td)
DATABASE_IDENTITY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the sequence type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	DATABASE_SEQUENCE

Table Row (tr)

id	name

Table Cell (td)
DATABASE_SEQUENCE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the sequence type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break

...

;
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	DATETIME

Table Row (tr)

id	name

Table Cell (td)
DATETIME

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	EXCLUDED_COLUMN

Table Row (tr)

id	name

Table Cell (td)
EXCLUDED_COLUMN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the flags of columns.
This flag identifies columns that are skipped in the sql.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
	// handle uuid column
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	INTEGER

Table Row (tr)

id	name

Table Cell (td)
INTEGER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	MEDIA

Table Row (tr)

id	name

Table Cell (td)
MEDIA

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	NONE

Table Row (tr)

id	name

Table Cell (td)
NONE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant for column information indicating unset values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	NUMBER

Table Row (tr)

id	name

Table Cell (td)
NUMBER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PK_COLUMN

Table Row (tr)

id	name

Table Cell (td)
PK_COLUMN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the row identifier type of columns.
This value identifies columns that are defined as primary key in the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
	// handle normal column
break;

case JSColumn.PK_COLUMN:
	// handle database pk column
break;

case JSColumn.ROWID_COLUMN:
	// handle developer defined pk column
break;

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ROWID_COLUMN

Table Row (tr)

id	name

Table Cell (td)
ROWID_COLUMN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the row identifier type of columns.
This value identifies columns that are defined as primary key by the developer (but not in the database).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
	// handle normal column
break;

case JSColumn.PK_COLUMN:
	// handle database pk column
break;

case JSColumn.ROWID_COLUMN:
	// handle developer defined pk column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	SERVOY_SEQUENCE

Table Row (tr)

id	name

Table Cell (td)
SERVOY_SEQUENCE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the sequence type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TEXT

Table Row (tr)

id	name

Table Cell (td)
TEXT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	UUID_COLUMN

Table Row (tr)

id	name

Table Cell (td)
UUID_COLUMN

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the flags of columns.
This flag identifies columns whose values are treated as UUID.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
	// handle uuid

...

column
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	UUID_GENERATOR

Table Row (tr)

id	name

Table Cell (td)
UUID_GENERATOR

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used when setting or getting the sequence type of columns.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break;
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	getAllowNull

Table Row (tr)

id	name

Table Cell (td)
getAllowNull

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

getAllowNull

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the allow-null flag of the column.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – boolean allow-null flag.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (!column.getAllowNull())
{
	 // column cannot be null
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderID}{tr:id=name}{td}h6.getDataProviderID{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDataProviderID{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String dataprovider id.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDataProviderID

Table Row (tr)

id	name

Table Cell (td)
getDataProviderID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDataProviderID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String dataprovider id.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var dataProviderId = column.

getDataProviderID() {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDescription}{tr:id=name}{td}h6.getDescription{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDescription{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the description property of the column.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String column description.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

getDataProviderID()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDescription

Table Row (tr)

id	name

Table Cell (td)
getDescription

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDescription

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the description property of the column.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String column description.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var desc = column.getDescription()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getForeignType}{tr:id=name}{td}h6.getForeignType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getForeignType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the foreign type of the column. The foreign type can be defined design time as a foreign key reference to another table.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String foreign type.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForeignType

Table Row (tr)

id	name

Table Cell (td)
getForeignType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getForeignType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the foreign type of the column.
The foreign type can be defined design time as a foreign key reference to another table.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String foreign type.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var foreignType = column.getForeignType()
if (foreignType != null)
{
	var fkTable = databaseManager.getTable('example_data', foreignType)
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLength}{tr:id=name}{td}h6.getLength{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getLength{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the length of the column as reported by the JDBC driver.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- int column length.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLength

Table Row (tr)

id	name

Table Cell (td)
getLength

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getLength

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the length of the column as reported by the JDBC driver.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – int column length.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
if (column.getLength() < 10)
{
	 // handle short column
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getQualifiedName}{tr:id=name}{td}h6.getQualifiedName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getQualifiedName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the qualified name (including table name) of the column as known by the database. The name is quoted, if necessary, as defined by the actual database used.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String qualified column name.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getQualifiedName

Table Row (tr)

id	name

Table Cell (td)
getQualifiedName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getQualifiedName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the qualified name (including table name) of the column as known by the database.
The name is quoted, if necessary, as defined by the actual database used.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String qualified column name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var qualifiedSqlName = column.getQualifiedName()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getQuotedSQLName}{tr:id=name}{td}h6.getQuotedSQLName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getQuotedSQLName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns a quoted version of the column name, if necessary, as defined by the actual database used.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- column name, quoted if needed.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getQuotedSQLName

Table Row (tr)

id	name

Table Cell (td)
getQuotedSQLName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getQuotedSQLName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a quoted version of the column name, if necessary, as defined by the actual database used.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – column name, quoted if needed.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


//use with the raw SQL plugin:
//if the table name contains characters that are illegal in sql, the table name will be quoted
var jsTable = databaseManager.getTable('udm', 'campaigns')
var quotedTableName = jsTable.getQuotedSQLName()
var jsColumn = jsTable.getColumn('active')
var quotedColumnName = jsColumn.getQuotedSQLName()
plugins.rawSQL.executeSQL('udm',  quotedTableName,  'select * from ' + quotedTableName + ' where ' + quotedColumnName + ' = ?', [1])

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRowIdentifierType}{tr:id=name}{td}h6.getRowIdentifierType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getRowIdentifierType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the row identifier type of the column. The sequence type is one of: \- JSColumn.PK\_COLUMN \- JSColumn.ROWID\_COLUMN \- JSColumn.NONE{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- int row identifier type.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRowIdentifierType

Table Row (tr)

id	name

Table Cell (td)
getRowIdentifierType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getRowIdentifierType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the row identifier type of the column.
The sequence type is one of:
- JSColumn.PK_COLUMN
- JSColumn.ROWID_COLUMN
- JSColumn.NONE

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – int row identifier type.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
	// handle normal column
break;

case JSColumn.PK_COLUMN:
	// handle database pk column
break;

case JSColumn.ROWID_COLUMN:
	// handle developer defined pk column
break;
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSQLName}{tr:id=name}{td}h6.getSQLName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getSQLName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the name of the column as known by the database.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String sql name{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSQLName

Table Row (tr)

id	name

Table Cell (td)
getSQLName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getSQLName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the name of the column as known by the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String sql name

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlName = column.getSQLName()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getScale}{tr:id=name}{td}h6.getScale{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getScale{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the scale of the column as reported by the JDBC driver.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- int column scale.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getScale

Table Row (tr)

id	name

Table Cell (td)
getScale

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getScale

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the scale of the column as reported by the JDBC driver.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – int column scale.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var scale = column.getScale()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSequenceType}{tr:id=name}{td}h6.getSequenceType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getSequenceType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the sequence type of the column. The sequence type is one of: \- JSColumn.NONE \- JSColumn.SERVOY\_SEQUENCE \- JSColumn.DATABASE\_SEQUENCE \- JSColumn.DATABASE\_IDENTITY \- JSColumn.UUID\_GENERATOR;{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- int sequence type.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSequenceType

Table Row (tr)

id	name

Table Cell (td)
getSequenceType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getSequenceType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the sequence type of the column.
The sequence type is one of:
- JSColumn.NONE
- JSColumn.SERVOY_SEQUENCE
- JSColumn.DATABASE_SEQUENCE
- JSColumn.DATABASE_IDENTITY
- JSColumn.UUID_GENERATOR;

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – int sequence type.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
	// handle column with no sequence
break;

case JSColumn.UUID_GENERATOR:
	// handle uuid generated column
break;
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTitle}{tr:id=name}{td}h6.getTitle{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTitle{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the title property of the column.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String column title.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTitle

Table Row (tr)

id	name

Table Cell (td)
getTitle

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTitle

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the title property of the column.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String column title.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var title = column.getTitle()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getType}{tr:id=name}{td}h6.getType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the JDBC type of the column. The type reported by the JDBC driver will be mapped to one of: \- JSColumn.DATETIME \- JSColumn.TEXT \- JSColumn.NUMBER \- JSColumn.INTEGER \- JSColumn.MEDIA{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- int sql type.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getType

Table Row (tr)

id	name

Table Cell (td)
getType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the JDBC type of the column.
The type reported by the JDBC driver will be mapped to one of:
- JSColumn.DATETIME
- JSColumn.TEXT
- JSColumn.NUMBER
- JSColumn.INTEGER
- JSColumn.MEDIA

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number – int sql type.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
	// handle text column
break;

case JSColumn.NUMBER:
case JSColumn.INTEGER:
	// handle numerical column
break;
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTypeAsString}{tr:id=name}{td}h6.getTypeAsString{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getTypeAsString{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the name JDBC type of the column. The same mapping as defined in JSColumn.getType() is applied.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- String sql name.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTypeAsString

Table Row (tr)

id	name

Table Cell (td)
getTypeAsString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getTypeAsString

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the name JDBC type of the column.
The same mapping as defined in JSColumn.getType() is applied.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String – String sql name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var typeName = column.getTypeAsString()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=hasFlag-Number}{tr:id=name}{td}h6.hasFlag{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}hasFlag{span}{span}\(flag){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Check a flag of the column. The flags are a bit pattern consisting of 1 or more of the following bits: \- JSColumn.UUID\_COLUMN \- JSColumn.EXCLUDED\_COLUMN{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} flag {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- boolean whether flag is set.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	hasFlag-Number

Table Row (tr)

id	name

Table Cell (td)
hasFlag

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasFlag

Span
(flag)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Check a flag of the column.
The flags are a bit pattern consisting of 1 or more of the following bits:
- JSColumn.UUID_COLUMN
- JSColumn.EXCLUDED_COLUMN

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} flag

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – boolean whether flag is set.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
	// handle uuid column
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 19

New Version 20

Key

DATABASE_IDENTITY

DATABASE_SEQUENCE

DATETIME

EXCLUDED_COLUMN

INTEGER

MEDIA

NONE

NUMBER

PK_COLUMN

ROWID_COLUMN

SERVOY_SEQUENCE

TEXT

UUID_COLUMN

UUID_GENERATOR

getAllowNull

getDataProviderID

getDescription

getForeignType

getLength

getQualifiedName

getQuotedSQLName

getRowIdentifierType

getSQLName

getScale

getSequenceType

getTitle

getType

getTypeAsString

hasFlag