JSColumnObject

Unknown macro: {td}

DATABASE_IDENTITY
Constant used when setting or getting the sequence type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

DATABASE_SEQUENCE
Constant used when setting or getting the sequence type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

DATETIME
Constant used when setting or getting the type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

EXCLUDED_COLUMN
Constant used when setting or getting the flags of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

INTEGER
Constant used when setting or getting the type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

MEDIA
Constant used when setting or getting the type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

NONE
Constant for column information indicating unset values.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

NUMBER
Constant used when setting or getting the type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

PK_COLUMN
Constant used when setting or getting the row identifier type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

ROWID_COLUMN
Constant used when setting or getting the row identifier type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

SERVOY_SEQUENCE
Constant used when setting or getting the sequence type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

TEXT
Constant used when setting or getting the type of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

UUID_COLUMN
Constant used when setting or getting the flags of columns.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

UUID_GENERATOR
Constant used when setting or getting the sequence type of columns.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

allowNull
Get or set the allow-null flag of a new column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

rowIdentifierType
Get or set the row identifier type of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

sequenceType
Get or set the sequence type of the column.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getDescription()
Get the description property of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getForeignType()
Get the foreign type of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getLength()
Get the length of the column as reported by the JDBC driver.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getQualifiedName()
Get the qualified name (including table name) of the column as known by the database.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getSQLName()
Get the name of the column as known by the database.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getScale()
Get the scale of the column as reported by the JDBC driver.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getTitle()
Get the title property of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getType()
Get the JDBC type of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

getTypeAsString()
Get the name JDBC type of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {td}

hasFlag(flag)
Check a flag of the column.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setDatabaseSequenceName()
Set the database sequence name of the column, used for columns with sequence type JSColumn.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setFlag(flag, set)
Set or clear a flag of a new column.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Constants Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

DATABASE_IDENTITY

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the sequence type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

DATABASE_SEQUENCE

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the sequence type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

DATETIME

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

EXCLUDED_COLUMN

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the flags of columns.
This flag identifies columns that are skipped in the sql.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

INTEGER

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

MEDIA

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

NONE

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant for column information indicating unset values.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

NUMBER

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

PK_COLUMN

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

ROWID_COLUMN

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

SERVOY_SEQUENCE

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the sequence type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

TEXT

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

UUID_COLUMN

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the flags of columns.
This flag identifies columns whose values are treated as UUID.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

UUID_GENERATOR

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant used when setting or getting the sequence type of columns.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

allowNull

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get or set the allow-null flag of a new column.
Note that when a column is added to an existing table, allowNull will always be set.
For a primary key column, the allowNull flag will be always off, for other columns the flag is set by default.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use (JSColumn.TEXT, 36) for UUIDs
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		var c = table.createNewColumn("name", JSColumn.TEXT, 100);
		c.allowNull = false
		table.createNewColumn("age", JSColumn.INTEGER, 0);
		table.createNewColumn("last_login", JSColumn.DATETIME, 0);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table successfully created.");
		else application.output("Table not created.");
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

rowIdentifierType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	// users has uuid pk
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use <JSColumn.TEXT, 36> for UUIDs)
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		table.createNewColumn("name", JSColumn.TEXT, 100);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table users successfully created.");
		else application.output("Table users not created.");
	}

	// groups has database sequence pk
	table = server.createNewTable("groups");
	if (table)
	{
		pk = table.createNewColumn("id", JSColumn.INTEGER, 0);
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.sequenceType = JSColumn.DATABASE_SEQUENCE
		pk.setDatabaseSequenceName('mygroupsequence')
		table.createNewColumn("name", JSColumn.TEXT, 100);
		result = server.synchronizeWithDB(table);
		if (result) application.output("Table groups successfully created.");
		else application.output("Table groups not created.");
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

sequenceType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get or set 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;

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var server = plugins.maintenance.getServer("example_data");
if (server)
{
	// users has uuid pk
	var table = server.createNewTable("users");
	if (table)
	{
		var pk = table.createNewColumn("id", JSColumn.MEDIA, 16); // can also use <JSColumn.TEXT, 36> for UUIDs)
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.setFlag(JSColumn.UUID_COLUMN, true)
		pk.sequenceType = JSColumn.UUID_GENERATOR
		table.createNewColumn("name", JSColumn.TEXT, 100);
		var result = server.synchronizeWithDB(table);
		if (result) application.output("Table users successfully created.");
		else application.output("Table users not created.");
	}

	// groups has database sequence pk
	table = server.createNewTable("groups");
	if (table)
	{
		pk = table.createNewColumn("id", JSColumn.INTEGER, 0);
		pk.rowIdentifierType = JSColumn.PK_COLUMN;
		pk.sequenceType = JSColumn.DATABASE_SEQUENCE
		pk.setDatabaseSequenceName('mygroupsequence')
		table.createNewColumn("name", JSColumn.TEXT, 100);
		result = server.synchronizeWithDB(table);
		if (result) application.output("Table groups successfully created.");
		else application.output("Table groups not created.");
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDataProviderID

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getDataProviderID

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String dataprovider id.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDescription

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getDescription

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the description property of the column.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String column description.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getForeignType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getForeignType

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the foreign type of the column.
The foreign type can be defined design time as a foreign key reference to another table.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String foreign type.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLength

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getLength

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int column length.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getQualifiedName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getQualifiedName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String qualified column name.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getQuotedSQLName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getQuotedSQLName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – column name, quoted if needed.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

//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])

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getSQLName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getSQLName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String sql name

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getScale

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getScale

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int column scale.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTitle

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getTitle

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the title property of the column.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String column title.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getType

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int sql type.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getTypeAsString

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Unknown macro: {span}

getTypeAsString

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – String sql name.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

hasFlag

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}