Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

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

Table Cell (td)
createNewTable(tableName) Creates in this server a new table with the specified name.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
dropTable(tableName) Drops the table with the specified name from this server.

Table Row (tr)

Table Cell (td)
JSTableObject

Table Cell (td)
getTable(tableName) Returns a JSTable instance corresponding to the table with the specified name from this server.

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
getTableNames() Returns an array with the names of all tables in this server.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
isValid() Get valid state for the server.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
reloadDataModel() Reloads the datamodel from the database, if changed externally or via rawSQL plugin.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
synchronizeWithDB(table) Synchronizes a JSTable instance with the database.

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	createNewTable-String

Table Row (tr)

id	name

Table Cell (td)
createNewTable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTableObject

Span

style	font-weight: bold;

createNewTable

Span
(tableName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates in this server a new table with the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} tableName - The name of the table to create.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTableObject - JSTableObject created table.

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("new_table");
	if (table) {
		var pk = table.createNewColumn("new_table_id", JSColumn.INTEGER, 0);
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		if (server.synchronizeWithDB(table))
			application.output("New table created in the database.");
		else
			application.output("New table not created in database.");
	}
	else application.output("New table not created at all.");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dropTable-String

Table Row (tr)

id	name

Table Cell (td)
dropTable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

dropTable

Span
(tableName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Drops the table with the specified name from this server.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} tableName - The name of the table to drop.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean success.

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 result = server.dropTable("new_table");
	if (result)
		application.output("Table dropped.");
	else
		application.output("Table not dropped.");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTable-String

Table Row (tr)

id	name

Table Cell (td)
getTable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTableObject

Span

style	font-weight: bold;

getTable

Span
(tableName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSTable instance corresponding to the table with the specified name from this server.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} tableName - The name of the table to retrieve.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTableObject - JSTableObject table.

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("employees");
	if (table) {
		var colNames = table.getColumnNames()
		application.output("Table has " + colNames.length + " columns.");
		for (var i=0; i<colNames.length; i++)
			application.output("Column " + i + ": " + colNames[i]);
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTableNames

Table Row (tr)

id	name

Table Cell (td)
getTableNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getTableNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array with the names of all tables in this server.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[] - Array of String table names.

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 tableNames = server.getTableNames();
	application.output("There are " + tableNames.length + " tables.");
	for (var i=0; i<tableNames.length; i++)
		application.output("Table " + i + ": " + tableNames[i]);
}
else {
	plugins.dialogs.showInfoDialog("Attention","Server 'example_data' cannot be found.","OK");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isValid

Table Row (tr)

id	name

Table Cell (td)
isValid

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isValid

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get valid state for the server.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean valid state.

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.isValid()) {
	application.output("Server not valid!");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	reloadDataModel

Table Row (tr)

id	name

Table Cell (td)
reloadDataModel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

reloadDataModel

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Reloads the datamodel from the database, if changed externally or via rawSQL plugin.

This call is not needed after a call to synchronizeWithDB().

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");
var result = plugins.rawSQL.executeSQL("example_data", null, 'CREATE TABLE raw_table (raw_table_id INTEGER)');
if (result) {
	application.output("Table created through rawSQL plugin.");
	if (server) {
		server.reloadDataModel();
		// All existing JSTableObject/JSColumn object references are invalid now! Use getTable to get new ones.
		var table = server.getTable("raw_table");
		if (table) {
			var colNames = table.getColumnNames()
			application.output("Table has " + colNames.length + " columns.");
			for (var i=0; i<colNames.length; i++)
				application.output("Column " + i + ": " + colNames[i]);
		}
	}
}
else {
	application.output("Raw table creation failed: " + plugins.rawSQL.getException());
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	synchronizeWithDB-JSTableObject

Table Row (tr)

id	name

Table Cell (td)
synchronizeWithDB

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

synchronizeWithDB

Span
(table)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Synchronizes a JSTable instance with the database. If columns were added to or removed from the JSTable instance, all these changes will now be persisted to the database.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSTableObject} table - A JSTableObject instance that should be synchronized.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean success.

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("new_table");
	if (table) {
		var pk = table.createNewColumn("new_table_id", JSColumn.INTEGER, 0);
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		if (server.synchronizeWithDB(table))
			application.output("New table created in the database.");
		else
			application.output("New table not created in database.");
	}
	else application.output("New table not created at all.");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 26

New Version Current

Key

createNewTable

dropTable

getTable

getTableNames

isValid

reloadDataModel

synchronizeWithDB