May 02, 2024 08:32 Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
Methods Summary
JSColumnObject
createNewColumn(columnName, type, length)
Creates a new column in this table.
JSColumnObject
createNewColumn(columnName, type, length, allowNull)
Creates a new column in this table.
JSColumnObject
createNewColumn(columnName, type, length, allowNull, pkColumn)
Creates a new column in this table.
void
deleteColumn(columnName)
Deletes the column with the specified name from this table.
JSColumn
getColumn(name)
Returns a JSColumn for the named column (or column dataproviderID).
Array
getColumnNames()
Returns an array containing the names of all table columns.
String
getDataSource()
Returns the table data source uri.
String
getQuotedSQLName()
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
Array
getRowIdentifierColumnNames()
Returns an array containing the names of the identifier (PK) column(s).
String
getSQLName()
Returns the table name.
String
getServerName()
Returns the Servoy server name.
Boolean
isMetadataTable()
Returns whether table was flagged as metadata table.
Methods Details
createNewColumn(columnName, type, length)
String
columnName
Number
type
Number
length
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.");
}
}
createNewColumn(columnName, type, length, allowNull)
String
columnName
Number
type
Number
length
Boolean
allowNull
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.");
}
}
createNewColumn(columnName, type, length, allowNull, pkColumn)
String
columnName
Number
type
Number
length
Boolean
allowNull
Boolean
pkColumn
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.");
}
}
deleteColumn(columnName)
String
columnName
var server = plugins.maintenance.getServer("example_data");
if (server) {
var table = server.getTable("users");
if (table) {
table.deleteColumn("last_login");
server.synchronizeWithDB(table);
}
}
getColumn(name)
String
name
The name of the column to return the value from.
var jsTable = databaseManager.getTable('udm', 'campaigns')
var jsColumn = jsTable.getColumn('campaign_name')
getColumnNames()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()
getDataSource()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var dataSource = jsTable.getDataSource()
getQuotedSQLName()
//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])
getRowIdentifierColumnNames()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()
getSQLName()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()
getServerName()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()
isMetadataTable()
var jsTable = databaseManager.getTable('udm', 'campaigns')
var isMetaDataTable = jsTable.isMetadataTable()