Page History

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
JSTableObject

...

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

...

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 in this server a new table with the specified name.

...

Table Cell (td)
Boolean

...

Table Cell (td)
JSTableObject

...

Drops the table with the specified name from this server.

...

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

...

Table Cell (td)
String[]

...

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

...

Table Cell (td)
Boolean

...

Get valid state for the server.

...

void

...

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

...

Table Cell (td)
Boolean

...

Synchronizes a JSTable instance with the database.

...

function

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

Table Head (th)

colspan	1

Method Details

...

id	createNewTable-String

Table Row (tr)

id	name

Table Cell (td)
createNewTable

...

id	sig

...

Span

style	margin-right: 5px;

JSTableObject

Span

style	font-weight: bold;

createNewTable

...

2

Methods Details

createNewTable

name

createNewTable(tableName)

...

des

...

sIndent

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

...

prs

...

Parameters

...

sIndent

...

tableName

...

The name of the table to create.

...

ret

...

Returns

...

sIndent

...

id	prs

...

class	sIndent

...

JSTableObject created table.

clients

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

...

class	lastDetailRow

...

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.

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dropTable

name

dropTable(tableName)

des

sIndent

Drops the table with the specified name from this server.

prs

Parameters

sIndent

tableName

The name of the table to drop.

...

ret

...

Returns

...

sIndent

...

boolean success.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

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.

...

id	prs

...

class	sIndent

...

Sample

...

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

...

sIdent

javascript

lastDetailRow

getTable

name

getTable(tableName)

des

sIndent

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

prs

Parameters

sIndent

tableName

The name of the table to retrieve.

...

ret

...

Returns

...

sIndent

...

JSTableObject table.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

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.

...

id	ret

...

class	sIndent

...

Sample

...

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)

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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.

...

id	prs

...

class	sIndent

...

sIdent

javascript

lastDetailRow

getTableNames

name

getTableNames()

des

sIndent

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

ret

Returns

sIndent

Array of String table names.

clients

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

...

class	lastDetailRow

...

id	isValid

Table Row (tr)

id	name

Table Cell (td)
isValid

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isValid

name

isValid()

des

sIndent

Get valid state for the server.

ret

Returns

sIndent

boolean valid state.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

reloadDataModel

name

reloadDataModel()

des

sIndent

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

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

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

synchronizeWithDB

name

synchronizeWithDB(table)

des

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.

prs

Parameters

sIndent

table

A JSTableObject instance that should be synchronized.

...

ret

...

Returns

...

sIndent

...

boolean success.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

Sample

...

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

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 24

New Version Current

Key

createNewTable

createNewTable(tableName)

dropTable

dropTable(tableName)

getTable

getTable(tableName)

getTableNames

reloadDataModel

synchronizeWithDB

getTableNames()

isValid

isValid()

reloadDataModel()

synchronizeWithDB(table)