Child pages
  • JSTableObject

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreates a new column in this table.Creates a new column in this table.Creates a new column in this table.voidDeletes the column with the specified name from this table.Returns a JSColumn for the named column (or column dataproviderID).Returns an array containing the names of all table columns.Returns the table data source uri.Returns a quoted version of the table name, if necessary, as defined by the actual database used.Returns an array containing the names of the identifier (PK) column(s).Returns the table name.Returns the Servoy server name.Returns whether table was flagged as metadata table.

functionservoy sDetail2100%height:30px2Methods DetailscreateNewColumnname

createNewColumn(columnName, type, length)

dessIndent
Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the
type of the column, use the JSColumn constants. The column is not actually created in the database until this
table is synchronized with the database using the JSServer.synchronizeWithDB method. 

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method
returns null.
prs

Parameters

sIndentcolumnName ;type ;length ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowcreateNewColumnname

createNewColumn(columnName, type, length, allowNull)

dessIndent
Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the
type of the column, use the JSColumn constants. The column is not actually created in the database until this
table is synchronized with the database using the JSServer.synchronizeWithDB method. 

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method
returns null.
prs

Parameters

sIndentcolumnName ;type ;length ;allowNull ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createNewColumnname

createNewColumn(columnName, type, length, allowNull, pkColumn)

dessIndent
Creates a new column in this table. The name, type and length of the new column must be specified. For specifying the
type of the column, use the JSColumn constants. The column is not actually created in the database until this
table is synchronized with the database using the JSServer.synchronizeWithDB method. 

The method returns a JSColumn instance that corresponds to the newly created column. If any error occurs and the column cannot be created, then the method
returns null.
prs

Parameters

sIndentcolumnName ;type ;length ;allowNull ;pkColumn ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
deleteColumnname

deleteColumn(columnName)

dessIndent
Deletes the column with the specified name from this table. The column is not actually deleted from the database until this
table is synchronized with the database using the JSServer.synchronizeWithDB method.
prs

Parameters

sIndentcolumnName ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getColumnname

getColumn(name)

dessIndent
Returns a JSColumn for the named column (or column dataproviderID).
prs

Parameters

sIndentnameThe name of the column to return the value from.
ret

Returns

sIndent JSColumn column.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getColumnNamesname

getColumnNames()

dessIndent
Returns an array containing the names of all table columns.
If the table is in mem, then the internal rowid column name is not returned.
ret

Returns

sIndent String array of column names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourcename

getDataSource()

dessIndent
Returns the table data source uri.
ret

Returns

sIndent String datasource uri.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQuotedSQLNamename

getQuotedSQLName()

dessIndent
Returns a quoted version of the table name, if necessary, as defined by the actual database used.
ret

Returns

sIndent String table name, quoted if needed.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getRowIdentifierColumnNamesname

getRowIdentifierColumnNames()

dessIndent
Returns an array containing the names of the identifier (PK) column(s).
 Please note that if the table is in mem, then the internal rowid column name is also returned.
ret

Returns

sIndent String array of row identifier column names.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSQLNamename

getSQLName()

dessIndent
Returns the table name.
ret

Returns

sIndent String table name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getServerNamename

getServerName()

dessIndent
Returns the Servoy server name.
ret

Returns

sIndent String server name.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isMetadataTablename

isMetadataTable()

dessIndent
Returns whether table was flagged as metadata table.
ret

Returns

sIndent boolean is metadata
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow