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=9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4}{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:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_des|text=|trigger=button}{sub-section}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_des|trigger=none|class=sIndent}Returns a JSColumn for the named column.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_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:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_ret|text=|trigger=button}{sub-section}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_see|text=|trigger=button}{sub-section}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_see|text=|trigger=button}{sub-section}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_sam|text=|trigger=button}{sub-section}{sub-section:9D85C6E8463884AB-C7A9974C-404244A5-9D0D8959-B6B12B15833FD4A17F4A45B4_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=74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC}{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:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_des|text=|trigger=button}{sub-section}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_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:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_ret|text=|trigger=button}{sub-section}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_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:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_see|text=|trigger=button}{sub-section}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_see|text=|trigger=button}{sub-section}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_sam|text=|trigger=button}{sub-section}{sub-section:74474414B81D62C5-0E0AA488-44A242B8-ACEC9ED1-5A39B5B6E05F38DB789555DC_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=AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F}{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:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_des|text=|trigger=button}{sub-section}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_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:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_ret|text=|trigger=button}{sub-section}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_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:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_see|text=|trigger=button}{sub-section}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_see|text=|trigger=button}{sub-section}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_sam|text=|trigger=button}{sub-section}{sub-section:AFE4199F2F062E32-43CDA52B-4D5D42BE-8B62B910-6DB237B2D601FF9E9626431F_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=E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00}{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:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_des|text=|trigger=button}{sub-section}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_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:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_ret|text=|trigger=button}{sub-section}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_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:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_see|text=|trigger=button}{sub-section}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_see|text=|trigger=button}{sub-section}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_sam|text=|trigger=button}{sub-section}{sub-section:E0E6C2596072D798-0E03117D-4DD84ADE-93868FDA-80275916A4B3D37514077E00_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=3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C}{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:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_des|text=|trigger=button}{sub-section}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_ret|text=|trigger=button}{sub-section}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_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:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_see|text=|trigger=button}{sub-section}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_see|text=|trigger=button}{sub-section}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_sam|text=|trigger=button}{sub-section}{sub-section:3BEFA3A1A965A5AF-A3704AFD-496943C5-8B1287A9-38CBF07CCA3DEB627A55AE5C_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=2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777}{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:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_des|text=|trigger=button}{sub-section}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_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:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_ret|text=|trigger=button}{sub-section}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_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:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_see|text=|trigger=button}{sub-section}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_see|text=|trigger=button}{sub-section}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_sam|text=|trigger=button}{sub-section}{sub-section:2CAE44D0996A2DB1-DEC4DE56-42A64D70-AEC88E9C-30DC45ECC9CAC06FE9F1B777_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}