Child pages
  • JSTable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{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:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSColumn]{td}{td}[#getColumn]\(name)
Returns a JSColumn for the named column.{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}[#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}{table}\\ 

{table:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1}{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:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_des|text=|trigger=button}{sub-section}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_des|trigger=none|class=sIndent}Returns a JSColumn for the named column.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_prs|trigger=none}name -- The name of the column to return the value from.
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_ret|text=|trigger=button}{sub-section}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_see|text=|trigger=button}{sub-section}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_see|text=|trigger=button}{sub-section}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_sam|text=|trigger=button}{sub-section}{sub-section:15A2D394B26AF3E9-E82B02AC-479E4940-8238A16E-149B648067E7FF6720A913A1_sam|class=sIndent|trigger=none}{code:language=javascript}
var jsTable = databaseManager.getTable('udm', 'campaigns')
var jsColumn = jsTable.getColumn('campaign_name')
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B}{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:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_des|text=|trigger=button}{sub-section}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_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=prs}{td}*Parameters*\\{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_ret|text=|trigger=button}{sub-section}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_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:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_see|text=|trigger=button}{sub-section}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_see|text=|trigger=button}{sub-section}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_sam|text=|trigger=button}{sub-section}{sub-section:8560E9AF153C00A5-6E7B4372-4F164A71-9EE7976D-2F6ED80FB711AEB31AE5475B_sam|class=sIndent|trigger=none}{code:language=javascript}
var jsTable = databaseManager.getTable('udm', 'campaigns')
var columnNames = jsTable.getColumnNames()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E}{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:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_des|text=|trigger=button}{sub-section}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_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=prs}{td}*Parameters*\\{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_ret|text=|trigger=button}{sub-section}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_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:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_see|text=|trigger=button}{sub-section}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_see|text=|trigger=button}{sub-section}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_sam|text=|trigger=button}{sub-section}{sub-section:478BAC4AFF38D970-B23E687C-479C4DD3-AD64BECA-7338F8947A2B591F5FDAF29E_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261}{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:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_des|text=|trigger=button}{sub-section}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_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=prs}{td}*Parameters*\\{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_ret|text=|trigger=button}{sub-section}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_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:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_see|text=|trigger=button}{sub-section}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_see|text=|trigger=button}{sub-section}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_sam|text=|trigger=button}{sub-section}{sub-section:D455C15A35E73917-C4561E05-4DAB4739-9DA1B642-13E5F52E0787C22EFA28D261_sam|class=sIndent|trigger=none}{code:language=javascript}
var jsTable = databaseManager.getTable('udm', 'campaigns')
var identifierColumnNames = jsTable.getRowIdentifierColumnNames()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49}{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:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_des|text=|trigger=button}{sub-section}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_ret|text=|trigger=button}{sub-section}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_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:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_see|text=|trigger=button}{sub-section}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_see|text=|trigger=button}{sub-section}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_sam|text=|trigger=button}{sub-section}{sub-section:36673A4E5EDEED59-1664CA06-4A144376-BE68AB59-D110E0896C0240692B9BEF49_sam|class=sIndent|trigger=none}{code:language=javascript}
var jsTable = databaseManager.getTable('udm', 'campaigns')
var tableNameForDisplay = jsTable.getSQLName()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C}{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:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_des|text=|trigger=button}{sub-section}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_des|trigger=none|class=sIndent}Returns the Servoy server name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_ret|text=|trigger=button}{sub-section}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_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:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_see|text=|trigger=button}{sub-section}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_see|text=|trigger=button}{sub-section}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_sam|text=|trigger=button}{sub-section}{sub-section:63924F87B2EFF99E-FA3A911F-46D2422A-B1DC9959-59ADF178996338A57779149C_sam|class=sIndent|trigger=none}{code:language=javascript}
var jsTable = databaseManager.getTable('udm', 'campaigns')
var serverName = jsTable.getServerName()
{code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}