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=6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5}{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:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_des|text=|trigger=button}{sub-section}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_des|trigger=none|class=sIndent}Returns a JSColumn for the named column.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_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:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_ret|text=|trigger=button}{sub-section}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_see|text=|trigger=button}{sub-section}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_see|text=|trigger=button}{sub-section}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_sam|text=|trigger=button}{sub-section}{sub-section:6CB92A4791A7F9AC-190904B4-41B94A8D-ABF082D1-2A2F9A7E3458991B0AC7BEC5_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=BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC}{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:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_des|text=|trigger=button}{sub-section}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_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:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_ret|text=|trigger=button}{sub-section}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_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:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_see|text=|trigger=button}{sub-section}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_see|text=|trigger=button}{sub-section}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_sam|text=|trigger=button}{sub-section}{sub-section:BC9C7F5025761A20-7EC86F60-447648FA-B706B963-9CF551F6E612A0D6AEA700EC_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=80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6}{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:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_des|text=|trigger=button}{sub-section}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_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:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_ret|text=|trigger=button}{sub-section}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_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:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_see|text=|trigger=button}{sub-section}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_see|text=|trigger=button}{sub-section}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_sam|text=|trigger=button}{sub-section}{sub-section:80636A9A1951FDE1-514E64C4-4CF24175-8C68A70A-B9BB82E981F67F7E48D466B6_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=0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89}{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:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_des|text=|trigger=button}{sub-section}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_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:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_ret|text=|trigger=button}{sub-section}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_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:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_see|text=|trigger=button}{sub-section}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_see|text=|trigger=button}{sub-section}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_sam|text=|trigger=button}{sub-section}{sub-section:0E81438D93D21776-D41FCCED-43BD4E5A-85349B6E-82E3A936F2930EEF12605E89_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=339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80}{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:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_des|text=|trigger=button}{sub-section}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_ret|text=|trigger=button}{sub-section}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_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:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_see|text=|trigger=button}{sub-section}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_see|text=|trigger=button}{sub-section}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_sam|text=|trigger=button}{sub-section}{sub-section:339EF81FF7AE80ED-4A28638B-41024AE6-BCB8AF48-27ECF17AD097CF0DDBDD9F80_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=9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3}{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:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_des|text=|trigger=button}{sub-section}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_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:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_ret|text=|trigger=button}{sub-section}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_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:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_see|text=|trigger=button}{sub-section}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_see|text=|trigger=button}{sub-section}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_sam|text=|trigger=button}{sub-section}{sub-section:9CA5DBC2EC93D5D0-A6E8D76F-4FE448AC-831EA05F-1212E599303A8B45DA98ECA3_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}