JSTableObject

Unknown macro: {td}

createNewColumn(columnName, type, length, allowNull, pkColumn)
Creates a new column in this table.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

deleteColumn(columnName)
Deletes the column with the specified name from this table.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getColumn(name)
Returns a JSColumn for the named column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getColumnNames()
Returns an array containing the names of all table columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getSQLName()
Returns the table name.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getServerName()
Returns the Servoy server name.

Unknown macro: {table}

{column:padding=0px|width=100%}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createNewColumn

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

createNewColumn

Unknown macro: {span}

(columnName, type, length, allowNull, pkColumn)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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 "allowNull" optional argument specifies if the
column accepts null values (by default it does). The "pkColumn" optional argument specifies if the column is a primary key column (by default it is not).
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.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

columnName
type
length
allowNull
pkColumn

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

deleteColumn

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

deleteColumn

Unknown macro: {span}

(columnName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

{String} columnName

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: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

var server = plugins.maintenance.getServer("example_data");
if (server) {
	var table = server.getTable("users");
	if (table) {
		table.deleteColumn("last_login");
		server.synchronizeWithDB(table);
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getColumn

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getColumn

Unknown macro: {span}

(name)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Returns a JSColumn for the named column.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

{String} name – The name of the column to return the value from.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

JSColumn – JSColumn column.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getColumnNames

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getColumnNames

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Returns an array containing the names of all table columns.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String[] – String array of column names.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getQuotedSQLName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getQuotedSQLName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String – String table name, quoted if needed.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getRowIdentifierColumnNames

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getRowIdentifierColumnNames

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String[] – String array of row identifier column names.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getSQLName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getSQLName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Returns the table name.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Since

Unknown macro: {sub-section}

Replace with version info

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String – String table name.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getServerName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}