Skip to end of metadata
Go to start of metadata

Refresh page Jun 20, 2019 01:30

Supported Clients
SmartClient WebClient NGClient

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 TENANT_COLUMN Constant used when setting or getting the flags 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.

Methods 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 getDefaultFormat() Get the default format of the column.
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 getSQLType() Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations.
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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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;
}

TENANT_COLUMN

Constant used when setting or getting the flags of columns.
This flag identifies columns that are marked as a tenant column.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
	// handle uuid column
}

TEXT

Constant used when setting or getting the type of columns.

Returns

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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;
}

Methods Details

getAllowNull()

Get the allow-null flag of the column.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (!column.getAllowNull())
{
	 // column cannot be null
}

getDataProviderID()

Get the data provider id for this column (which is the same as name if not explicitly defined otherwise).

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var dataProviderId = column.getDataProviderID()

getDefaultFormat()

Get the default format of the column.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var format = column.getDefaultFormat()

getDescription()

Get the description property of the column.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var desc = column.getDescription()

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

Supported Clients

SmartClient,WebClient,NGClient

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()

Get the length of the column as reported by the JDBC driver.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
if (column.getLength() < 10)
{
	 // handle short column
}

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var qualifiedSqlName = column.getQualifiedName()

getQuotedSQLName()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

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()

Get the row identifier type of the column.
The sequence type is one of:
 - JSColumn.PK_COLUMN
 - JSColumn.ROWID_COLUMN
 - JSColumn.NONE

Returns

Supported Clients

SmartClient,WebClient,NGClient

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()

Get the name of the column as known by the database.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlName = column.getSQLName()

getSQLType()

Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlType = column.getSQLType();

getScale()

Get the scale of the column as reported by the JDBC driver.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var scale = column.getScale()

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

Supported Clients

SmartClient,WebClient,NGClient

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()

Get the title property of the column.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var title = column.getTitle()

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

Supported Clients

SmartClient,WebClient,NGClient

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()

Get the name JDBC type of the column.
The same mapping as defined in JSColumn.getType() is applied.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var typeName = column.getTypeAsString()

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
 - JSColumn.TENANT_COLUMN

Parameters

Number flag ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
if (column.hasFlag(JSColumn.UUID_COLUMN))
{
	// handle uuid column
}

  • No labels