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

Method Summary

Table Row (tr)

Table Cell (td)
JSColumnObject

Table Cell (td)createNewColumn(columnName, type, length)

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

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

id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

Table Cell (td)
JSColumnObject

Table Cell (td)createNewColumn(columnName, type, length, allowNull)

servoy sSummary

12%

30%

58%

height: 30px;

3

Methods Summary

Creates a new column in this table.

Table Row (tr)

Creates a new column in this table.

Table Row (tr)

Table Cell (td)
JSColumnObject

Table Cell (td)createNewColumn(columnName, type, length, allowNull, pkColumn)
Table Cell (td)

Creates a new column in this table.

Table Row (tr) Table Cell (td)deleteColumn(columnName)

void

getColumn(name)

Deletes the column with the specified name from this table.

Table Row (tr)

Table Cell (td)
JSColumn

Table Cell (td)

Returns a JSColumn for the named column (or column dataproviderID).

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)getColumnNames()

Returns an array containing the names of all table columns.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getDataSource()

Returns the table data source uri.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)getQuotedSQLName()

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

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)getRowIdentifierColumnNames()
Table Row (tr)

Table Cell (td)
String

Table Cell (td)getSQLName()

Returns an array containing the names of the identifier (PK) column(s).

Table Cell (td)
String

Table Cell (td)getServerName()

Returns the table name.

Table Row (tr)

Table Cell (td)isMetadataTable()

Returns the Servoy server name.

Table Row (tr)

Table Cell (td)
Boolean

Returns whether table was flagged as metadata table.

HTML Table

functionclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	createNewColumn-String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

Spanid

2

Methods Details

createNewColumn

name

createNewColumn(columnName, type, length)

Table Row (tr)

des

Table Cell (td) Divclass

sIndent

Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the

type of the column, use the JSColumn constants. The column is not actually created in the database until this

table is synchronized with the database using the JSServer.synchronizeWithDB method.

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method

Table Row (tr)id

returns null.

td

prs

Parameters

Divclass Table Body (tbody)

id	createNewColumn-String_Number_Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

Span

sIndent{String} columnName
{Number} type
{Number} length

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSColumnObject

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

columnName

type

length

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createNewColumn

name

createNewColumn(columnName, type, length, allowNull)

tr

idclass

des

Table Cell (td) Div

sIndent

Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the

type of the column, use the JSColumn constants. The column is not actually created in the database until this

table is synchronized with the database using the JSServer.synchronizeWithDB method.

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method

Table Row (tr)id

returns null.

prs

Table Cell (td)class

Parameters

Div Table Body (tbody)

id	createNewColumn-String_Number_Number_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

Span

sIndent

{String} columnName
{Number} type
{Number} length
{Boolean} allowNull

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSColumnObject

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

columnName

type

length

allowNull

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createNewColumn

name

createNewColumn(columnName, type, length, allowNull, pkColumn)

tr

idclass

des

Table Cell (td) Div

sIndent

Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the

type of the column, use the JSColumn constants. The column is not actually created in the database until this

table is synchronized with the database using the JSServer.synchronizeWithDB method.

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method

Table Row (tr)id

returns null.

td

prs

Parameters

Divclass

sIndent{String} columnName
{Number} type
{Number} length
{Boolean} allowNull
{Boolean} pkColumn

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSColumnObject

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteColumn-String

Table Row (tr)

id	name

Table Cell (td)
deleteColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

deleteColumn

Span
(columnName)

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

columnName

type

length

allowNull

pkColumn

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

deleteColumn

name

deleteColumn(columnName)

des

sIndent

Deletes the column with the specified name from this table. The column is not actually deleted from the database until this

Table Row (tr)id

table is synchronized with the database using the JSServer.synchronizeWithDB method.

td

prs

Parameters

Divclass Table Row (tr)

id	ret

td

sIndent{String} columnNamecolumnName ret

Returns

div

sIndent

clients

classid

Supported Clients

sIndent

void Table Row (tr)

SmartClient,WebClient,NGClient

sam

Table Cell (td)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumn-String

Table Row (tr)

id	name

Table Cell (td)
getColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSColumn

Span

style	font-weight: bold;

getColumn

Span
(name)

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Sample

Div

class	sIndent

Code Block

language	javascript

var server = plugins.maintenance.getServer("example_data");
if (server) {
	var table = server.getTable("users");
	if (table) {
		table.deleteColumn("last_login");
		server.synchronizeWithDB(table);
	}
}

Table Row (tr)id

sIdent

javascript

lastDetailRow

getColumn

name

getColumn(name)

des

sIndent

Returns a JSColumn for the named column (or column dataproviderID).

prs

Table Cell (td)class

Parameters

Div

sIndent

{String}

name

- Table Row (tr)id

The name of the column to return the value from.

td

ret

Returns

div

sIndent

clients

class	sIndent

JSColumn - JSColumn column.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var jsColumn = jsTable.getColumn('campaign_name')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumnNames

Table Row (tr)

id	name

Table Cell (td)
getColumnNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getColumnNames

Span
()

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getColumnNames

name

getColumnNames()

des

sIndent

Returns an array containing the names of all table columns.

td

ret

Returns

div

sIndent

clients

class	sIndent

String[] - String array of column names.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDataSource

Table Row (tr)

id	name

Table Cell (td)
getDataSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDataSource

Span
()

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDataSource

name

getDataSource()

des

sIndent

Returns the table data source uri.

td

ret

Returns

div

sIndent

clients

class	sIndent

String - String datasource uri.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var dataSource = jsTable.getDataSource()

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

Table Row (tr)id

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getQuotedSQLName

name

getQuotedSQLName()

des

sIndent

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

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String - String table 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()
plugins.rawSQL.executeSQL('udm',  quotedTableName,  'select * from ' + quotedTableName + ' where is_active = ?', [1])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRowIdentifierColumnNames

Table Row (tr)

id	name

Table Cell (td)
getRowIdentifierColumnNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getRowIdentifierColumnNames

Span
()

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getRowIdentifierColumnNames

name

getRowIdentifierColumnNames()

des

sIndent

Returns an array containing the names of the identifier (PK) column(s).

td

ret

Returns

div

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

Returns the table name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String table name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getServerName

Table Row (tr)

id	name

Table Cell (td)
getServerName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getServerName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the Servoy server name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String server name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isMetadataTable

Table Row (tr)

id	name

Table Cell (td)
isMetadataTable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isMetadataTable

Span
()

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

sIndent

clients

class	sIndent

String[] - String array of row identifier column names.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getSQLName

name

getSQLName()

des

sIndent

Returns the table name.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getServerName

name

getServerName()

des

sIndent

Returns the Servoy server name.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isMetadataTable

name

isMetadataTable()

des

sIndent

Returns whether table was flagged as metadata table.

Table Row (tr)idtd

ret

Returns

div

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var isMetaDataTable = jsTable.isMetadataTable()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIndent

clients

class	sIndent

Boolean - boolean is metadata

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 27

New Version 28

Key

createNewColumn

createNewColumn(columnName, type, length)

createNewColumn

createNewColumn(columnName, type, length, allowNull)

createNewColumn

createNewColumn(columnName, type, length, allowNull, pkColumn)

deleteColumn

deleteColumn(columnName)

getColumn

getColumn(name)

getColumnNames

getColumnNames()

getDataSource

getDataSource()

getQuotedSQLName

getQuotedSQLName()

getRowIdentifierColumnNames

getRowIdentifierColumnNames()

getSQLName

getServerName

isMetadataTable

getSQLName()

getServerName()

isMetadataTable()