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

...

Table Cell (td)
String

...

Returns the table name.

...

Returns the Servoy server name.

...

Table Cell (td)
Boolean

Returns whether table was flagged as metadata table.

...

function

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

Table Head (th)

colspan	1

Method Details

...

id	createNewColumn-String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

...

id	sig

...

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

...

2

Methods Details

createNewColumn

name

createNewColumn(columnName, type, length)

...

des

...

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.

...

prs

...

Parameters

...

sIndent

...

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.");
	}
}

...

class	lastDetailRow

...

id	createNewColumn-String_Number_Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

...

id	sig

...

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

...

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)

...

des

...

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.

...

prs

...

Parameters

...

sIndent

...

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.");
	}
}

...

class	lastDetailRow

...

id	createNewColumn-String_Number_Number_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
createNewColumn

...

id	sig

...

Span

style	margin-right: 5px;

JSColumnObject

Span

style	font-weight: bold;

createNewColumn

...

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)

...

des

...

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.

...

prs

...

Parameters

...

sIndent

...

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.");
	}
}

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

id	prs

...

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 is synchronized with the database using the JSServer.synchronizeWithDB method.

prs

Parameters

sIndent

columnName

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getColumn

name

getColumn(name)

des

sIndent

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

prs

Parameters

sIndent

name

The name of the column to return the value from.

...

ret

...

Returns

...

sIndent

...

JSColumn column.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

id	ret

...

class	sIndent

...

Sample

...

class	sIndent

...

Code Block

language	javascript

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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.

...

sIdent

javascript

lastDetailRow

getColumnNames

name

getColumnNames()

des

sIndent

Returns an array containing the names of all table columns.
If the table is in mem, then the internal rowid column name is not returned.

ret

Returns

sIndent

String array of column names.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDataSource

name

getDataSource()

des

sIndent

Returns the table data source uri.

ret

Returns

sIndent

String datasource uri.

clients

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.

ret

Returns

sIndent

String table name, quoted if needed.

clients

...

id	sam

...

class	lastDetailRow

...

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

...

id	ret

...

class	sIndent

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

...

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

...

sIdent

javascript

lastDetailRow

getRowIdentifierColumnNames

name

getRowIdentifierColumnNames()

des

sIndent

Returns an array containing the names of the identifier (PK) column(s).
 Please note that if the table is in mem, then the internal rowid column name is also returned.

ret

Returns

sIndent

String array of row identifier column names.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

Sample

...

class	sIndent

...

Code Block

language	javascript

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

sIdent

javascript

lastDetailRow

getSQLName

name

getSQLName()

des

sIndent

Returns the table name.

ret

Returns

sIndent

String table name.

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

String server name.

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.

ret

Returns

sIndent

boolean is metadata

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 24

New Version Current

Key

createNewColumn

createNewColumn(columnName, type, length)

des

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