Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)DATABASE_IDENTITY

indexstyle	true	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.

refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

Table Cell (td)
Number

Table Cell (td)DATABASE_SEQUENCE

servoy sSummary

12%

30%

58%

height: 30px;

3

Constants Summary

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

Table Row (tr)

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

Constant used when setting or getting the

sequence

type of columns.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)DATETIME

Constant used when setting or getting the

type Table Row (tr)

Table Cell (td)
Number

Table Cell (td)EXCLUDED_COLUMN

flags of columns.

Constant used when setting or getting the

flags

type of columns.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)INTEGER
Table Row (tr)

Table Cell (td)
Number

Table Cell (td)MEDIA

Constant used when setting or getting the type of columns.

Constant used when setting or getting the

type Table Row (tr)

Table Cell (td)
Number

Table Cell (td)NONE
Constant

flags of columns.

Constant for column information indicating unset values.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)NUMBER
Table Row (tr)

Table Cell (td)
Number

Table Cell (td)PK_COLUMN

Constant used when setting or getting the type of columns.

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 Row (tr)

Table Cell (td)
Number

Table Cell (td)SERVOY_SEQUENCE

Constant used when setting or getting the row identifier type of columns.

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)TEXT
Table Row (tr)

Table Cell (td)
Number

Table Cell (td)UUID_COLUMN

Constant used when setting or getting the flags of columns.

Constant used when setting or getting the type of columns.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)UUID_GENERATOR

Constant used when setting or getting the flags of columns.

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

HTML Table

idclassservoy sSummaryid

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)getAllowNull()
Get

servoy sSummary

12%

30%

58%

height: 30px;

3

Methods Summary

Get the allow-null flag of the column.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getDataProviderID()
Table Row (tr)

Table Cell (td)
String

Table Cell (td)getDescription()

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getForeignType()

Get the default format of the column.

Get the description property of the column.

Get the foreign type of the column.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)getLength()
Get the length

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

. Table Row (tr)

Table Cell (td)
String

Table Cell (td)getQualifiedName()

.

Get the name of the column as used by Servoy.

Get the qualified name (including table name) of the column as known by the database.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getQuotedSQLName()
Table Row (tr)

Table Cell (td)
Number

Table Cell (td)getRowIdentifierType()

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

Get the row identifier type of the column.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getSQLName()
Get the name of the

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)getScale()
Table Row (tr)

Table Cell (td)
Number

Table Cell (td)getSequenceType()

Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations.

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getTitle()

Get the sequence type of the column.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)getType()

Get the JSTable of this column.

Get the title property of the column.

Get the JDBC type of the column.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getTypeAsString()
Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)hasFlag(flag)

Get the name JDBC type of the column.

Check a flag of the column.

HTML Table

constantclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

; Table Head (th)colspan

2

id

Constants Details

Table Body (tbody)id

DATABASE_IDENTITY

Table Row (tr)

name

tdid

DATABASE_IDENTITY

Table Row (tr)

des

Table Cell (td) Divclassid

sIndent

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

Table Row (tr)

ret

Table Cell (td)

Returns

div

sIndent

clients

class

Supported Clients

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

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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
}

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()

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()

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)
}

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
}

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()

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])

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;
}

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()

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()

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;
}

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()

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;
}

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()

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
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

DATABASE_SEQUENCE

name

DATABASE_SEQUENCE

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

DATETIME

name

DATETIME

des

sIndent

Constant used when setting or getting the type of columns.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

EXCLUDED_COLUMN

name

EXCLUDED_COLUMN

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

INTEGER

name

INTEGER

des

sIndent

Constant used when setting or getting the type of columns.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

MEDIA

name

MEDIA

des

sIndent

Constant used when setting or getting the type of columns.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

NATIVE_COLUMN

name

NATIVE_COLUMN

des

sIndent

Constant used when setting or getting the flags of columns.
This flag identifies columns that are marked as a native type column (for example uniqueidentifier).

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

NONE

name

NONE

des

sIndent

Constant for column information indicating unset values.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

NUMBER

name

NUMBER

des

sIndent

Constant used when setting or getting the type of columns.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

PK_COLUMN

name

PK_COLUMN

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ROWID_COLUMN

name

ROWID_COLUMN

des

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).

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

SERVOY_SEQUENCE

name

SERVOY_SEQUENCE

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

TENANT_COLUMN

name

TENANT_COLUMN

des

sIndent

Constant used when setting or getting the flags of columns.
This flag identifies columns that are marked as a tenant column.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

TEXT

name

TEXT

des

sIndent

Constant used when setting or getting the type of columns.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

UUID_COLUMN

name

UUID_COLUMN

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

UUID_GENERATOR

name

UUID_GENERATOR

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetAllowNullname

getAllowNull()

des

sIndent

Get the allow-null flag of the column.

ret

Returns

sIndent

boolean allow-null flag.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDataProviderID

name

getDataProviderID()

des

sIndent

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

ret

Returns

sIndent

String dataprovider id.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDefaultFormat

name

getDefaultFormat()

des

sIndent

Get the default format of the column.

ret

Returns

sIndent

String column default format.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDescription

name

getDescription()

des

sIndent

Get the description property of the column.

ret

Returns

sIndent

String column description.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getForeignType

name

getForeignType()

des

sIndent

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

ret

Returns

sIndent

String foreign type.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getLength

name

getLength()

des

sIndent

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

ret

Returns

sIndent

int column length.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getName

name

getName()

des

sIndent

Get the name of the column as used by Servoy.

ret

Returns

sIndent

String column name

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getQualifiedName

name

getQualifiedName()

des

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.

ret

Returns

sIndent

String qualified column name.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getQuotedSQLName

name

getQuotedSQLName()

des

sIndent

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

ret

Returns

sIndent

column name, quoted if needed.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getRowIdentifierType

name

getRowIdentifierType()

des

sIndent

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

ret

Returns

sIndent

int row identifier type.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getSQLName

name

getSQLName()

des

sIndent

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

ret

Returns

sIndent

String sql name

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getSQLType

name

getSQLType()

des

sIndent

Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations.

ret

Returns

sIndent

int sql type.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getScale

name

getScale()

des

sIndent

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

ret

Returns

sIndent

int column scale.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getSequenceType

name

getSequenceType()

des

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;

ret

Returns

sIndent

int sequence type.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTable

name

getTable()

des

sIndent

Get the JSTable of this column.

ret

Returns

sIndent

table The JSTable of this column.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTitle

name

getTitle()

des

sIndent

Get the title property of the column. If title is null will return column name.

ret

Returns

sIndent

String column title.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getType

name

getType()

des

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

ret

Returns

sIndent

int sql type.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTypeAsString

name

getTypeAsString()

des

sIndent

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

ret

Returns

sIndent

String sql name.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasFlag

name

hasFlag(flag)

des

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
 - JSColumn.TENANT_COLUMN
 - JSColumn.NATIVE_COLUMN

prs

Parameters

sIndent

flag

;

ret

Returns

sIndent

boolean whether flag is set.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 23

New Version Current

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

DATABASE_SEQUENCE

DATETIME

EXCLUDED_COLUMN

INTEGER

MEDIA

NATIVE_COLUMN

NONE

NUMBER

PK_COLUMN

ROWID_COLUMN

SERVOY_SEQUENCE

TENANT_COLUMN

TEXT

UUID_COLUMN

UUID_GENERATOR

getAllowNull()

getDataProviderID()

getDefaultFormat()

getDescription()

getForeignType()

getLength()

getName()

getQualifiedName()

getQuotedSQLName()

getRowIdentifierType()

getSQLName()

getSQLType()

getScale()

getSequenceType()

getTable()

getTitle()

getType()

getTypeAsString()

hasFlag(flag)