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=288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F}{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:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_des|text=|trigger=button}{sub-section}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_des|trigger=none|class=sIndent}Returns a JSColumn for the named column.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_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:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_ret|text=|trigger=button}{sub-section}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_ret|trigger=none|class=sIndent}[JSColumn] -- JSColumn column.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_see|text=|trigger=button}{sub-section}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_see|text=|trigger=button}{sub-section}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_sam|text=|trigger=button}{sub-section}{sub-section:288E528A9D85C6E8-B617C7A9-4BE04042-84739D0D-558CB07B4650B6B12B15833F_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=1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F}{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:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_des|text=|trigger=button}{sub-section}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_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:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_ret|text=|trigger=button}{sub-section}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_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:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_see|text=|trigger=button}{sub-section}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_see|text=|trigger=button}{sub-section}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_sam|text=|trigger=button}{sub-section}{sub-section:1B14197374474414-229C0E0A-476844A2-9399ACEC-FBFB4A9C0EEF5A39B5B6E05F_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=4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601}{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:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_des|text=|trigger=button}{sub-section}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_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:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_ret|text=|trigger=button}{sub-section}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_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:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_see|text=|trigger=button}{sub-section}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_see|text=|trigger=button}{sub-section}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_sam|text=|trigger=button}{sub-section}{sub-section:4808C9F0AFE4199F-3B5243CD-47E34D5D-8D388B62-C817ECBE6C6B6DB237B2D601_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=12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3}{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:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_des|text=|trigger=button}{sub-section}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_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:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_ret|text=|trigger=button}{sub-section}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_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:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_see|text=|trigger=button}{sub-section}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_see|text=|trigger=button}{sub-section}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_sam|text=|trigger=button}{sub-section}{sub-section:12CD9582E0E6C259-2DE70E03-40D44DD8-92A29386-2C285071CB4980275916A4B3_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=52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D}{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:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_des|text=|trigger=button}{sub-section}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_des|trigger=none|class=sIndent}Returns the table name.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_ret|text=|trigger=button}{sub-section}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_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:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_see|text=|trigger=button}{sub-section}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_see|text=|trigger=button}{sub-section}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_sam|text=|trigger=button}{sub-section}{sub-section:52A3CAEE3BEFA3A1-6AD0A370-493C4969-97968B12-8C6D46AD680938CBF07CCA3D_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=9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA}{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:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_des|text=|trigger=button}{sub-section}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_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:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_ret|text=|trigger=button}{sub-section}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_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:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_see|text=|trigger=button}{sub-section}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_see|text=|trigger=button}{sub-section}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_sam|text=|trigger=button}{sub-section}{sub-section:9D3397CE2CAE44D0-C8BADEC4-4D4142A6-9834AEC8-BC6948180AA730DC45ECC9CA_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}