| Constants Summary | |
|---|---|
| Number | #DATABASE_IDENTITY Constant used when setting or getting the sequence type of columns. |
| Number | #DATABASE_SEQUENCE Constant used when setting or getting the sequence type of columns. |
| Number | #DATETIME Constant used when setting or getting the type of columns. |
| Number | #EXCLUDED_COLUMN Constant used when setting or getting the flags of columns. |
| Number | #INTEGER Constant used when setting or getting the type of columns. |
| Number | #MEDIA Constant used when setting or getting the type of columns. |
| Number | #NONE Constant for column information indicating unset values. |
| Number | #NUMBER Constant used when setting or getting the type of columns. |
| Number | #PK_COLUMN Constant used when setting or getting the row identifier type of columns. |
| Number | #ROWID_COLUMN Constant used when setting or getting the row identifier type of columns. |
| Number | #SERVOY_SEQUENCE Constant used when setting or getting the sequence type of columns. |
| Number | #TEXT Constant used when setting or getting the type of columns. |
| Number | #UUID_COLUMN Constant used when setting or getting the flags of columns. |
| Number | #UUID_GENERATOR Constant used when setting or getting the sequence type of columns. |
| Method Summary | |
|---|---|
| Boolean | #getAllowNull() Get the allow-null flag of the column. |
| String | #getDataProviderID() Get the data provider id for this column (which is the same as name if not explicitly defined otherwise). |
| String | #getDescription() Get the description property of the column. |
| String | #getForeignType() Get the foreign type of the column. |
| Number | #getLength() Get the length of the column as reported by the JDBC driver. |
| String | #getQualifiedName() Get the qualified name (including table name) of the column as known by the database. |
| String | #getQuotedSQLName() Returns a quoted version of the column name, if necessary, as defined by the actual database used. |
| Number | #getRowIdentifierType() Get the row identifier type of the column. |
| String | #getSQLName() Get the name of the column as known by the database. |
| Number | #getScale() Get the scale of the column as reported by the JDBC driver. |
| Number | #getSequenceType() Get the sequence type of the column. |
| String | #getTitle() Get the title property of the column. |
| Number | #getType() Get the JDBC type of the column. |
| String | #getTypeAsString() Get the name JDBC type of the column. |
| Boolean | #hasFlag(flag) Check a flag of the column. |
| Constants Details |
|---|
DATABASE_IDENTITY |
Constant used when setting or getting the sequence type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
DATABASE_SEQUENCE |
Constant used when setting or getting the sequence type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
DATETIME |
Constant used when setting or getting the type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
EXCLUDED_COLUMN |
Constant used when setting or getting the flags of columns.
This flag identifies columns that are skipped in the sql. |
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
// handle uuid column
}
|
INTEGER |
Constant used when setting or getting the type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
MEDIA |
Constant used when setting or getting the type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
NONE |
Constant for column information indicating unset values.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
NUMBER |
Constant used when setting or getting the type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
PK_COLUMN |
Constant used when setting or getting the row identifier type of columns.
This value identifies columns that are defined as primary key in the database. |
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
// handle normal column
break;
case JSColumn.PK_COLUMN:
// handle database pk column
break;
case JSColumn.ROWID_COLUMN:
// handle developer defined pk column
break;
}
|
ROWID_COLUMN |
Constant used when setting or getting the row identifier type of columns.
This value identifies columns that are defined as primary key by the developer (but not in the database). |
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
// handle normal column
break;
case JSColumn.PK_COLUMN:
// handle database pk column
break;
case JSColumn.ROWID_COLUMN:
// handle developer defined pk column
break;
}
|
SERVOY_SEQUENCE |
Constant used when setting or getting the sequence type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
TEXT |
Constant used when setting or getting the type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
UUID_COLUMN |
Constant used when setting or getting the flags of columns.
This flag identifies columns whose values are treated as UUID. |
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
// handle uuid column
}
|
UUID_GENERATOR |
Constant used when setting or getting the sequence type of columns.
|
| Returns |
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
| Method Details |
|---|
getAllowNull |
Boolean getAllowNull () |
Get the allow-null flag of the column.
|
| Returns Boolean – boolean allow-null flag.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (!column.getAllowNull())
{
// column cannot be null
}
|
getDataProviderID |
String getDataProviderID () |
Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).
|
| Returns String – String dataprovider id.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var dataProviderId = column.getDataProviderID()
|
getDescription |
String getDescription () |
Get the description property of the column.
|
| Returns String – String column description.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var desc = column.getDescription()
|
getForeignType |
String getForeignType () |
Get the foreign type of the column.
The foreign type can be defined design time as a foreign key reference to another table. |
| Returns String – String foreign type.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var foreignType = column.getForeignType()
if (foreignType != null)
{
var fkTable = databaseManager.getTable('example_data', foreignType)
}
|
getLength |
Number getLength () |
Get the length of the column as reported by the JDBC driver.
|
| Returns Number – int column length.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
if (column.getLength() < 10)
{
// handle short column
}
|
getQualifiedName |
String getQualifiedName () |
Get the qualified name (including table name) of the column as known by the database.
The name is quoted, if necessary, as defined by the actual database used. |
| Returns String – String qualified column name.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var qualifiedSqlName = column.getQualifiedName()
|
getQuotedSQLName |
String getQuotedSQLName () |
Returns a quoted version of the column name, if necessary, as defined by the actual database used.
|
| Returns String – column name, quoted if needed.
|
Sample
//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()
var jsColumn = jsTable.getColumn('active')
var quotedColumnName = jsColumn.getQuotedSQLName()
plugins.rawSQL.executeSQL('udm', quotedTableName, 'select * from ' + quotedTableName + ' where ' + quotedColumnName + ' = ?', [1])
|
getRowIdentifierType |
Number getRowIdentifierType () |
Get the row identifier type of the column.
The sequence type is one of: - JSColumn.PK_COLUMN - JSColumn.ROWID_COLUMN - JSColumn.NONE |
| Returns Number – int row identifier type.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getRowIdentifierType())
{
case JSColumn.NONE:
// handle normal column
break;
case JSColumn.PK_COLUMN:
// handle database pk column
break;
case JSColumn.ROWID_COLUMN:
// handle developer defined pk column
break;
}
|
getSQLName |
String getSQLName () |
Get the name of the column as known by the database.
|
| Returns String – String sql name
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlName = column.getSQLName()
|
getScale |
Number getScale () |
Get the scale of the column as reported by the JDBC driver.
|
| Returns Number – int column scale.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var scale = column.getScale()
|
getSequenceType |
Number getSequenceType () |
Get the sequence type of the column.
The sequence type is one of: - JSColumn.NONE - JSColumn.SERVOY_SEQUENCE - JSColumn.DATABASE_SEQUENCE - JSColumn.DATABASE_IDENTITY - JSColumn.UUID_GENERATOR; |
| Returns Number – int sequence type.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getSequenceType())
{
case JSColumn.NONE:
// handle column with no sequence
break;
case JSColumn.UUID_GENERATOR:
// handle uuid generated column
break;
}
|
getTitle |
String getTitle () |
Get the title property of the column.
|
| Returns String – String column title.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var title = column.getTitle()
|
getType |
Number getType () |
Get the JDBC type of the column.
The type reported by the JDBC driver will be mapped to one of: - JSColumn.DATETIME - JSColumn.TEXT - JSColumn.NUMBER - JSColumn.INTEGER - JSColumn.MEDIA |
| Returns Number – int sql type.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
switch (column.getType())
{
case JSColumn.TEXT:
// handle text column
break;
case JSColumn.NUMBER:
case JSColumn.INTEGER:
// handle numerical column
break;
}
|
getTypeAsString |
String getTypeAsString () |
Get the name JDBC type of the column.
The same mapping as defined in JSColumn.getType() is applied. |
| Returns String – String sql name.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var typeName = column.getTypeAsString()
|
hasFlag |
Boolean hasFlag (flag) |
Check a flag of the column.
The flags are a bit pattern consisting of 1 or more of the following bits: - JSColumn.UUID_COLUMN - JSColumn.EXCLUDED_COLUMN |
| Parameters {Number} flag
|
| Returns Boolean – boolean whether flag is set.
|
Sample
var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
// handle uuid column
}
|
Overview
Content Tools
Activity