Child pages
  • JSTable
Skip to end of metadata
Go to start of metadata

Refresh page Mar 18, 2024 15:23

Supported Clients
SmartClient WebClient NGClient

Methods Summary
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

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.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getColumnNames()

Returns an array containing the names of all table columns.
If the table is in mem, then the internal rowid column name is not returned.

Returns

Array String array of column names.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getDataSource()

Returns the table data source uri.

Returns

String String datasource uri.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

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.

Supported Clients

SmartClient,WebClient,NGClient

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

Returns an array containing the names of the identifier (PK) column(s).
 Please note that if the table is in mem, then the internal rowid column name is also returned.

Returns

Array String array of row identifier column names.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getSQLName()

Returns the table name.

Returns

String String table name.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getServerName()

Returns the Servoy server name.

Returns

String String server name.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

isMetadataTable()

Returns whether table was flagged as metadata table.

Returns

Boolean boolean is metadata

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

  • No labels