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=B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853}{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:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_des|text=|trigger=button}{sub-section}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_des|trigger=none|class=sIndent}Returns a JSColumn for the named column.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_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:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_ret|text=|trigger=button}{sub-section}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_see|text=|trigger=button}{sub-section}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_see|text=|trigger=button}{sub-section}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_sam|text=|trigger=button}{sub-section}{sub-section:B26AF3E9BBB74BA5-02ACF435-49404D77-A16EA324-FF6720A913A1BD26B2D9B853_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=153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E}{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:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_des|text=|trigger=button}{sub-section}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_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:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_ret|text=|trigger=button}{sub-section}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_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:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_see|text=|trigger=button}{sub-section}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_see|text=|trigger=button}{sub-section}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_sam|text=|trigger=button}{sub-section}{sub-section:153C00A5982EADED-4372EB10-4A714067-976DB0D0-AEB31AE5475B31953D88C49E_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=FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F}{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:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_des|text=|trigger=button}{sub-section}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_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:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_ret|text=|trigger=button}{sub-section}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_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:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_see|text=|trigger=button}{sub-section}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_see|text=|trigger=button}{sub-section}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_sam|text=|trigger=button}{sub-section}{sub-section:FF38D9702D88EF3B-687C0A39-4DD3452C-BECA898D-591F5FDAF29EEB25F1C72F2F_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=35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0}{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:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_des|text=|trigger=button}{sub-section}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_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:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_ret|text=|trigger=button}{sub-section}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_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:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_see|text=|trigger=button}{sub-section}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_see|text=|trigger=button}{sub-section}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_sam|text=|trigger=button}{sub-section}{sub-section:35E7391736A374CF-1E054598-47394753-B6428DC5-C22EFA28D2611153863B0FC0_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=5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345}{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:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_des|text=|trigger=button}{sub-section}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_ret|text=|trigger=button}{sub-section}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_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:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_see|text=|trigger=button}{sub-section}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_see|text=|trigger=button}{sub-section}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_sam|text=|trigger=button}{sub-section}{sub-section:5EDEED59CA23A0F0-CA061735-437647E8-AB59986C-40692B9BEF497F82373A6345_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=B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1}{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:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_des|text=|trigger=button}{sub-section}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_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:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_ret|text=|trigger=button}{sub-section}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_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:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_see|text=|trigger=button}{sub-section}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_see|text=|trigger=button}{sub-section}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_sam|text=|trigger=button}{sub-section}{sub-section:B2EFF99E5641750B-911FCBFF-422A444A-9959B775-38A57779149C0E951509CAA1_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}