Page History

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 'class' inside the {div} macro with 'id=description'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
JSColumnObject

...

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

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreates a new column in this table.

...

Table Cell (td)
JSColumnObject

...

Creates a new column in this table.

...

Table Cell (td)
JSColumnObject

...

Creates a new column in this table.

...

void

...

Deletes the column with the specified name from this table.

...

Table Cell (td)
JSColumn

...

Table Cell (td)
String[]

...

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

...

Table Cell (td)
String

...

Returns an array containing the names of all table columns.

...

Returns the table data source uri.

...

Table Cell (td)
String

...

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

...

Table Cell (td)
String[]

...

Table Cell (td)
String

...

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

...

Returns the table name.

...

Table Cell (td)
String

...

Returns the Servoy server name.

...

Table Cell (td)
Boolean

...

id

HTML Table
Returns whether table was flagged as metadata table.

...

servoy sDetail

function

class

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style

2100%

height:30px

;

Table Head (th)

colspan	1

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

Span

2

Methods Details

createNewColumn

name

createNewColumn(columnName, type, length)

Table Row (tr)id

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


returns null.

Table Row (tr)id

prs Table Cell (td)class
Parameters Div 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 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
 SpansIndent{String} columnName
 {Number} type
 {Number} lengthcolumnName ;type ;length ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowcreateNewColumnnamecreateNewColumn(columnName, type, length, allowNull) Table Row (tr)idclassdes Table Cell (td) DivsIndentCreates 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

returns null. Table Row (tr)idtdprsParameters
divclasssIndent{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) 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
 SpancolumnName ;type ;length ;allowNull ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowcreateNewColumnnamecreateNewColumn(columnName, type, length, allowNull, pkColumn) Table Row (tr)idclassdes Table Cell (td) DivsIndentCreates 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

returns null. Table Row (tr)idtdprsParameters
divclasssIndent{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
Deletes the column with the specified name from this table. The column is not actually deleted from the database until this
 table is synchronized with the database using the JSServer.synchronizeWithDB method.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{String} columnName
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
void
 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.getTable("users");
	if (table) {
		table.deleteColumn("last_login");
		server.synchronizeWithDB(table);
	}
}
 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
Returns a JSColumn for the named column (or column dataproviderID).
 Table Row (tr)id prs
 Table Cell (td)Parameters
 Divclass sIndent
{String} name –  Table Row (tr)idcolumnName ;type ;length ;allowNull ;pkColumn ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowdeleteColumnnamedeleteColumn(columnName)dessIndentDeletes the column with the specified name from this table. The column is not actually deleted from the database until this
table is synchronized with the database using the JSServer.synchronizeWithDB method.prsParameters
sIndentcolumnName ;clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetColumnnamegetColumn(name)dessIndentReturns a JSColumn for the named column (or column dataproviderID).prsParameters
sIndentnameThe name of the column to return the value from.tdretReturns
 DivclassJSColumn – sIndent JSColumn column.clients
 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
Returns an array containing the names of all table columns.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
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
Returns the table data source uri.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
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
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
 Table Row (tr)id ret
 Table Cell (td)Returns
 Divclass sIndent
String – String tdSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetColumnNamesnamegetColumnNames()dessIndentReturns an array containing the names of all table columns.
If the table is in mem, then the internal rowid column name is not returned.retReturns
sIndent String array of column names.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetDataSourcenamegetDataSource()dessIndentReturns the table data source uri.retReturns
sIndent String datasource uri.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetQuotedSQLNamenamegetQuotedSQLName()dessIndentReturns a quoted version of the table name, if necessary, as defined by the actual database used.retReturns
sIndent String table name, quoted if needed.clients Table Row (tr)
id sam

//use with the raw SQL plugin:
//if the table name contains characters that are illegal in sql,Supported Clients
sIndentSmartClient,WebClient,NGClientsamSample Divclass sIndent
 Code Blocklanguage javascript
sIdentjavascriptlastDetailRowgetRowIdentifierColumnNamesnamegetRowIdentifierColumnNames()dessIndentReturns an array containing the names of the identifier (PK) column(s).
 Please note that if the table nameis 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
Returns an array containing the names of the identifier (PK) column(s).
 Table Row (tr)id ret
 Table Cell (td)Returns
 Divclass sIndent
String[] – idin mem, then the internal rowid column name is also returned.retReturns
sIndent String array of row identifier column names.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClientsam Table Cell (td) 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
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
Returns whether table was flagged as metadata table.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
Boolean – boolean is metadata
 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
tdSample Div
class sIndent
 Code Block
language javascript

var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()
sIdentjavascriptlastDetailRowgetSQLNamenamegetSQLName()dessIndentReturns the table name.retReturns
sIndent String table name.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetServerNamenamegetServerName()dessIndentReturns the Servoy server name.retReturns
sIndent String server name.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowisMetadataTablenameisMetadataTable()dessIndentReturns whether table was flagged as metadata table.retReturns
sIndent boolean is metadataclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 23

New Version Current

Key

createNewColumn

createNewColumn(columnName, type, length)

createNewColumn

createNewColumn(columnName, type, length, allowNull)

createNewColumn

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

deleteColumn

getColumn

deleteColumn(columnName)

getColumn(name)

getColumnNames

getDataSource

getQuotedSQLName

getColumnNames()

getDataSource()

getQuotedSQLName()

getRowIdentifierColumnNames()

getRowIdentifierColumnNames

getSQLName

getServerName

isMetadataTable

getSQLName()

getServerName()

isMetadataTable()