Skip to end of metadata
Go to start of metadata



Method Summary
JSColumn getColumn(name)
Returns a JSColumn for the named column (or column dataproviderID).
String[] 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.
String[] 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.



Method Details

getColumn

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

Parameters

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

Returns

JSColumn - JSColumn column.

Sample

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

getColumnNames

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

Returns

String[] - String array of column names.

Sample

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

getDataSource

String getDataSource ()
Returns the table data source uri.

Returns

String - String datasource uri.

Sample

var jsTable = databaseManager.getTable('udm', 'campaigns')
var dataSource = jsTable.getDataSource()
 

getQuotedSQLName

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

Returns

String - String table name, quoted if needed.

Sample

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

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

Returns

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

Sample

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

getSQLName

String getSQLName ()
Returns the table name.

Returns

String - String table name.

Sample

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

getServerName

String getServerName ()
Returns the Servoy server name.

Returns

String - String server name.

Sample

var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()
 

isMetadataTable

Boolean isMetadataTable ()
Returns whether table was flagged as metadata table.

Returns

Boolean - boolean is metadata

Sample

var jsTable = databaseManager.getTable('udm', 'campaigns')
var isMetaDataTable = jsTable.isMetadataTable()
 



  • No labels