JSServer

Unknown macro: {sub-section}

Unknown macro: {table}

{column:width=80px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

JSTableObject

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

JSTableObject

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String[]

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

isValid()
Get valid state for the server.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createNewTable

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

JSTableObject

Unknown macro: {span}

createNewTable

Unknown macro: {span}

(tableName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

tableName – The name of the table to create.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

JSTableObject – JSTableObject created table.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("new_table");
	if (table) {
		table.createNewColumn("new_table_id", JSColumn.INTEGER, 0, false, true);
		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.");
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

dropTable

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

dropTable

Unknown macro: {span}

(tableName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Drops the table with the specified name from this server.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

tableName – The name of the table to drop.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Boolean – boolean success.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTable

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

JSTableObject

Unknown macro: {span}

getTable

Unknown macro: {span}

(tableName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

tableName – The name of the table to retrieve.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

JSTableObject – JSTableObject table.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTableNames

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String[]

Unknown macro: {span}

getTableNames

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String[] – Array of String table names.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

isValid

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

isValid

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Get valid state for the server.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Boolean – boolean valid state.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

var server = plugins.maintenance.getServer("example_data");
if (!server.isValid()) {
			application.output("Server not valid!");
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

reloadDataModel

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

reloadDataModel

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

void

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

synchronizeWithDB

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

synchronizeWithDB

Unknown macro: {span}

(table)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

table – A JSTableObject instance that should be synchronized.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Boolean – boolean success.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("new_table");
	if (table) {
		table.createNewColumn("new_table_id", JSColumn.INTEGER, 0, false, true);
		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.");
}

Unknown macro: {tr}

Unknown macro: {td}

No labels

Child pages

JSServer

createNewTable

dropTable

getTable

getTableNames

isValid

reloadDataModel

synchronizeWithDB