Child pages
  • JSTableObject

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSColumnObject]{td}{td}[#createNewColumn]\(columnName, type, length) Creates a new column in this table.{td}{tr}{tbody}{tbody}{tr}{td}[JSColumnObject]{td}{td}[#createNewColumn]\(columnName, type, length, allowNull)
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreates a new column in this table.Creates a new column in this table.Creates a new column in this table.voidDeletes the column with the specified name from this table.Returns a JSColumn for the named column (or column dataproviderID).Returns an array containing the names of all table columns.Returns the table data source uri.Returns a quoted version of the table name, if necessary, as defined by the actual database used.Returns an array containing the names of the identifier (PK) column(s).Returns the table name.Returns the Servoy server name.Returns whether table was flagged as metadata table.

functionservoy sDetail2100%height:30px2Methods DetailscreateNewColumnname

createNewColumn(columnName, type, length)

dessIndent
Creates a new column in this table.
{td}{tr}{tbody}{tbody}{tr}{td}[JSColumnObject]{td}{td}[#createNewColumn]\(columnName, type, length, allowNull, pkColumn) Creates a new column in this table.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#deleteColumn]\(columnName) Deletes the column with the specified name from this table.{td}{tr}{tbody}{tbody}{tr}{td}[JSColumn]{td}{td}[#getColumn]\(name) Returns a JSColumn for the named column (or column dataproviderID).{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getColumnNames]\() Returns an array containing the names of all table columns.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataSource]\() Returns the table data source uri.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getQuotedSQLName]\() Returns a quoted version of the table name, if necessary, as defined by the actual database used.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getRowIdentifierColumnNames]\() Returns an array containing the names of the identifier (PK) column(s).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getSQLName]\() Returns the table name.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getServerName]\() Returns the Servoy server name.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isMetadataTable]\() Returns whether table was flagged as metadata table.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=createNewColumn-String_Number_Number|class=node}{tr:id=name}{td}h6.createNewColumn{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSColumnObject]{span}{span:id=iets|style=float: left; font-weight: bold;}createNewColumn{span}{span:id=iets|style=float: left;}\(columnName, type, length){span}{td}{tr}{tr:id=des}{td}{sub-section:createNewColumn-String_Number_Number_des|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_des|trigger=none|class=sIndent}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 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 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.
prs

Parameters

sIndentcolumnName ;type ;length ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createNewColumnname

createNewColumn(columnName, type, length, allowNull)

dessIndent
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 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.
prs

Parameters

sIndentcolumnName ;type ;length ;allowNull ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createNewColumnname

createNewColumn(columnName, type, length, allowNull, pkColumn)

dessIndent
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 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.
prs

Parameters

sIndentcolumnName ;type ;length ;allowNull ;pkColumn ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
deleteColumnname

deleteColumn(columnName)

dessIndent
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.
The method returns
prs

Parameters

sIndentcolumnName ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetColumnname

getColumn(name)

dessIndent
Returns a JSColumn 
instance that corresponds to
for the 
newly
named 
created
column
.
 
If
(or 
any error occurs and the column cannot be created, then the method returns null.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createNewColumn-String_Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createNewColumn-String_Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_prs|trigger=none|class=sIndent}\{[String]} columnName \{[Number]} type \{[Number]} length {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createNewColumn-String_Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_ret|trigger=none|class=sIndent}[JSColumnObject]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createNewColumn-String_Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createNewColumn-String_Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createNewColumn-String_Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_sam|trigger=none}{code:language=javascript} 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."); } } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createNewColumn-String_Number_Number_Boolean|class=node}{tr:id=name}{td}h6.createNewColumn{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSColumnObject]{span}{span:id=iets|style=float: left; font-weight: bold;}createNewColumn{span}{span:id=iets|style=float: left;}\(columnName, type, length, allowNull){span}{td}{tr}{tr:id=des}{td}{sub-section:createNewColumn-String_Number_Number_Boolean_des|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_des|trigger=none|class=sIndent}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 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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createNewColumn-String_Number_Number_Boolean_snc|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createNewColumn-String_Number_Number_Boolean_prs|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_prs|trigger=none|class=sIndent}\{[String]} columnName \{[Number]} type \{[Number]} length \{[Boolean]} allowNull {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createNewColumn-String_Number_Number_Boolean_ret|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_ret|trigger=none|class=sIndent}[JSColumnObject]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createNewColumn-String_Number_Number_Boolean_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createNewColumn-String_Number_Number_Boolean_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createNewColumn-String_Number_Number_Boolean_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_sam|trigger=none}{code:language=javascript} 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."); } } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createNewColumn-String_Number_Number_Boolean_Boolean|class=node}{tr:id=name}{td}h6.createNewColumn{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSColumnObject]{span}{span:id=iets|style=float: left; font-weight: bold;}createNewColumn{span}{span:id=iets|style=float: left;}\(columnName, type, length, allowNull, pkColumn){span}{td}{tr}{tr:id=des}{td}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_des|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_des|trigger=none|class=sIndent}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 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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_snc|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_prs|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_prs|trigger=none|class=sIndent}\{[String]} columnName \{[Number]} type \{[Number]} length \{[Boolean]} allowNull \{[Boolean]} pkColumn {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_ret|trigger=button|text=}{sub-section}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_ret|trigger=none|class=sIndent}[JSColumnObject]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:createNewColumn-String_Number_Number_Boolean_Boolean_sam|trigger=none}{code:language=javascript} 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."); } } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=deleteColumn|class=node}{tr:id=name}{td}h6.deleteColumn{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}deleteColumn{span}{span:id=iets|style=float: left;}\(columnName){span}{td}{tr}{tr:id=des}{td}{sub-section:deleteColumn_des|trigger=button|text=}{sub-section}{sub-section:deleteColumn_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:deleteColumn_snc|trigger=button|text=}{sub-section}{sub-section:deleteColumn_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:deleteColumn_prs|trigger=button|text=}{sub-section}{sub-section:deleteColumn_prs|trigger=none|class=sIndent}\{[String]} columnName {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:deleteColumn_ret|trigger=button|text=}{sub-section}{sub-section:deleteColumn_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:deleteColumn_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:deleteColumn_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:deleteColumn_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:deleteColumn_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:deleteColumn_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:deleteColumn_sam|trigger=none}{code:language=javascript} var server = plugins.maintenance.getServer("example_data"); if (server) { var table = server.getTable("users"); if (table) { table.deleteColumn("last_login"); server.synchronizeWithDB(table); } } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getColumn|class=node}{tr:id=name}{td}h6.getColumn{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSColumn]{span}{span:id=iets|style=float: left; font-weight: bold;}getColumn{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{tr:id=des}{td}{sub-section:getColumn_des|trigger=button|text=}{sub-section}{sub-section:getColumn_des|trigger=none|class=sIndent}Returns a JSColumn for the named column (or column dataproviderID).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getColumn_snc|trigger=button|text=}{sub-section}{sub-section:getColumn_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getColumn_prs|trigger=button|text=}{sub-section}{sub-section:getColumn_prs|trigger=none|class=sIndent}\{[String]} name -- The name of the column to return the value from. {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getColumn_ret|trigger=button|text=}{sub-section}{sub-section:getColumn_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getColumn_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumn_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getColumn_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumn_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getColumn_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumn_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var jsColumn = jsTable.getColumn('campaign_name') {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getColumnNames|class=node}{tr:id=name}{td}h6.getColumnNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getColumnNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getColumnNames_des|trigger=button|text=}{sub-section}{sub-section:getColumnNames_des|trigger=none|class=sIndent}Returns an array containing the names of all table columns.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getColumnNames_snc|trigger=button|text=}{sub-section}{sub-section:getColumnNames_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getColumnNames_prs|trigger=button|text=}{sub-section}{sub-section:getColumnNames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getColumnNames_ret|trigger=button|text=}{sub-section}{sub-section:getColumnNames_ret|trigger=none|class=sIndent}[String]\[] -- String array of column names.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getColumnNames_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumnNames_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getColumnNames_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumnNames_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getColumnNames_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getColumnNames_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var columnNames = jsTable.getColumnNames() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataSource|class=node}{tr:id=name}{td}h6.getDataSource{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getDataSource{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getDataSource_des|trigger=button|text=}{sub-section}{sub-section:getDataSource_des|trigger=none|class=sIndent}Returns the table data source uri.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getDataSource_snc|trigger=button|text=}{sub-section}{sub-section:getDataSource_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getDataSource_prs|trigger=button|text=}{sub-section}{sub-section:getDataSource_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getDataSource_ret|trigger=button|text=}{sub-section}{sub-section:getDataSource_ret|trigger=none|class=sIndent}[String] -- String datasource uri.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getDataSource_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getDataSource_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getDataSource_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getDataSource_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getDataSource_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getDataSource_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var dataSource = jsTable.getDataSource() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getQuotedSQLName|class=node}{tr:id=name}{td}h6.getQuotedSQLName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getQuotedSQLName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getQuotedSQLName_des|trigger=button|text=}{sub-section}{sub-section:getQuotedSQLName_des|trigger=none|class=sIndent}Returns a quoted version of the table name, if necessary, as defined by the actual database used.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getQuotedSQLName_snc|trigger=button|text=}{sub-section}{sub-section:getQuotedSQLName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getQuotedSQLName_prs|trigger=button|text=}{sub-section}{sub-section:getQuotedSQLName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getQuotedSQLName_ret|trigger=button|text=}{sub-section}{sub-section:getQuotedSQLName_ret|trigger=none|class=sIndent}[String] -- String table name, quoted if needed.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getQuotedSQLName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getQuotedSQLName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getQuotedSQLName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getQuotedSQLName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getQuotedSQLName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getQuotedSQLName_sam|trigger=none}{code:language=javascript} //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]) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRowIdentifierColumnNames|class=node}{tr:id=name}{td}h6.getRowIdentifierColumnNames{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getRowIdentifierColumnNames{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getRowIdentifierColumnNames_des|trigger=button|text=}{sub-section}{sub-section:getRowIdentifierColumnNames_des|trigger=none|class=sIndent}Returns an array containing the names of the identifier (PK) column(s).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getRowIdentifierColumnNames_snc|trigger=button|text=}{sub-section}{sub-section:getRowIdentifierColumnNames_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getRowIdentifierColumnNames_prs|trigger=button|text=}{sub-section}{sub-section:getRowIdentifierColumnNames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getRowIdentifierColumnNames_ret|trigger=button|text=}{sub-section}{sub-section:getRowIdentifierColumnNames_ret|trigger=none|class=sIndent}[String]\[] -- String array of row identifier column names.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getRowIdentifierColumnNames_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRowIdentifierColumnNames_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getRowIdentifierColumnNames_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRowIdentifierColumnNames_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getRowIdentifierColumnNames_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getRowIdentifierColumnNames_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var identifierColumnNames = jsTable.getRowIdentifierColumnNames() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSQLName|class=node}{tr:id=name}{td}h6.getSQLName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getSQLName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getSQLName_des|trigger=button|text=}{sub-section}{sub-section:getSQLName_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getSQLName_snc|trigger=button|text=}{sub-section}{sub-section:getSQLName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getSQLName_prs|trigger=button|text=}{sub-section}{sub-section:getSQLName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getSQLName_ret|trigger=button|text=}{sub-section}{sub-section:getSQLName_ret|trigger=none|class=sIndent}[String] -- String table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getSQLName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getSQLName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getSQLName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getSQLName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getSQLName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getSQLName_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var tableNameForDisplay = jsTable.getSQLName() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServerName|class=node}{tr:id=name}{td}h6.getServerName{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getServerName{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getServerName_des|trigger=button|text=}{sub-section}{sub-section:getServerName_des|trigger=none|class=sIndent}Returns the Servoy server name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getServerName_snc|trigger=button|text=}{sub-section}{sub-section:getServerName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getServerName_prs|trigger=button|text=}{sub-section}{sub-section:getServerName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getServerName_ret|trigger=button|text=}{sub-section}{sub-section:getServerName_ret|trigger=none|class=sIndent}[String] -- String server name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getServerName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getServerName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getServerName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getServerName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getServerName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getServerName_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var serverName = jsTable.getServerName() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isMetadataTable|class=node}{tr:id=name}{td}h6.isMetadataTable{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isMetadataTable{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:isMetadataTable_des|trigger=button|text=}{sub-section}{sub-section:isMetadataTable_des|trigger=none|class=sIndent}Returns whether table was flagged as metadata table.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isMetadataTable_snc|trigger=button|text=}{sub-section}{sub-section:isMetadataTable_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:isMetadataTable_prs|trigger=button|text=}{sub-section}{sub-section:isMetadataTable_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:isMetadataTable_ret|trigger=button|text=}{sub-section}{sub-section:isMetadataTable_ret|trigger=none|class=sIndent}[Boolean] -- boolean is metadata{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isMetadataTable_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMetadataTable_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isMetadataTable_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMetadataTable_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:isMetadataTable_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMetadataTable_sam|trigger=none}{code:language=javascript} var jsTable = databaseManager.getTable('udm', 'campaigns') var isMetaDataTable = jsTable.isMetadataTable() {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
column dataproviderID).
prs

Parameters

sIndentnameThe name of the column to return the value from.
ret

Returns

sIndent JSColumn column.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getColumnNamesname

getColumnNames()

dessIndent
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.
ret

Returns

sIndent String array of column names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourcename

getDataSource()

dessIndent
Returns the table data source uri.
ret

Returns

sIndent String datasource uri.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQuotedSQLNamename

getQuotedSQLName()

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

Returns

sIndent String table name, quoted if needed.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRowIdentifierColumnNamesname

getRowIdentifierColumnNames()

dessIndent
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.
ret

Returns

sIndent String array of row identifier column names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSQLNamename

getSQLName()

dessIndent
Returns the table name.
ret

Returns

sIndent String table name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getServerNamename

getServerName()

dessIndent
Returns the Servoy server name.
ret

Returns

sIndent String server name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isMetadataTablename

isMetadataTable()

dessIndent
Returns whether table was flagged as metadata table.
ret

Returns

sIndent boolean is metadata
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow