Constant used when setting or getting the sequence type of columns. |
|
Constant used when setting or getting the sequence type of columns. |
|
Constant used when setting or getting the type of columns. |
|
Constant used when setting or getting the flags of columns. |
|
Constant used when setting or getting the type of columns. |
|
Constant used when setting or getting the type of columns. |
|
Constant for column information indicating unset values. |
|
Constant used when setting or getting the type of columns. |
|
Constant used when setting or getting the row identifier type of columns. |
|
Constant used when setting or getting the row identifier type of columns. |
|
Constant used when setting or getting the sequence type of columns. |
|
Constant used when setting or getting the type of columns. |
|
Constant used when setting or getting the flags of columns. |
|
Constant used when setting or getting the sequence type of columns. |
|
|
Get or set the allow-null flag of a new column. |
|
Get or set the row identifier type of the column. |
|
Get or set the sequence type of the column. |
|
|
Get the data provider id for this column (which is the same as name if not explicitly defined otherwise). |
|
Get the default format of the column. |
|
Get the description property of the column. |
|
Get the foreign type of the column. |
|
Get the length of the column as reported by the JDBC driver. |
|
Get the qualified name (including table name) of the column as known by the database. |
|
Returns a quoted version of the column name, if necessary, as defined by the actual database used. |
|
Get the name of the column as known by the database. |
|
Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations. |
|
Get the scale of the column as reported by the JDBC driver. |
|
Get the title property of the column. |
|
Get the JDBC type of the column. |
|
Get the name JDBC type of the column. |
|
Check a flag of the column. |
|
Set the database sequence name of the column, used for columns with sequence type JSColumn. |
|
Set or clear a flag of a new column. |
|
|
Constant used when setting or getting the sequence type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the sequence type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the flags of columns.
This flag identifies columns that are skipped in the sql. |
|
|
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
} |
|
|
|
|
Constant used when setting or getting the type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the type of columns. |
|
|
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;
} |
|
|
|
|
Constant for column information indicating unset values. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the type of columns. |
|
|
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;
} |
|
|
|
|
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. |
|
|
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;
} |
|
|
|
|
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). |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the sequence type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the type of columns. |
|
|
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;
} |
|
|
|
|
Constant used when setting or getting the flags of columns.
This flag identifies columns whose values are treated as UUID. |
|
|
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
} |
|
|
|
|
Constant used when setting or getting the sequence type of columns. |
|
|
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;
} |
|
|
|
|
|
|
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. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample 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.");
}
} |
|
|
|
|
Get or set the row identifier type of the column.
The sequence type is one of:
- JSColumn.PK_COLUMN
- JSColumn.ROWID_COLUMN
- JSColumn.NONE |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample 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.");
}
} |
|
|
|
|
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; |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample 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.");
}
} |
|
|
|
|
|
Get the data provider id for this column (which is the same as name if not explicitly defined otherwise). |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var dataProviderId = column.getDataProviderID() |
|
|
|
|
Get the default format of the column. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var format = column.getDefaultFormat() |
|
|
|
|
Get the description property of the column. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var desc = column.getDescription() |
|
|
|
|
Get the foreign type of the column.
The foreign type can be defined design time as a foreign key reference to another table. |
|
|
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)
} |
|
|
|
|
Get the length of the column as reported by the JDBC driver. |
|
|
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
} |
|
|
|
|
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. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var qualifiedSqlName = column.getQualifiedName() |
|
|
|
|
Returns a quoted version of the column name, if necessary, as defined by the actual database used. |
|
|
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]) |
|
|
|
|
Get the name of the column as known by the database. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlName = column.getSQLName() |
|
|
|
|
Get the raw JDBC type of the column, which allows to check database specific types, like sting/byte column type variations. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var sqlType = column.getSQLType(); |
|
|
|
|
Get the scale of the column as reported by the JDBC driver. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var scale = column.getScale() |
|
|
|
|
Get the title property of the column. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customername')
var title = column.getTitle() |
|
|
|
|
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 |
|
|
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;
} |
|
|
|
|
Get the name JDBC type of the column.
The same mapping as defined in JSColumn.getType() is applied. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var table = databaseManager.getTable('db:/example_data/orders')
var column = table.getColumn('customerid')
var typeName = column.getTypeAsString() |
|
|
|
|
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 |
|
|
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
} |
|
|
|
|
setDatabaseSequenceName(sequenceName) |
|
Set the database sequence name of the column, used for columns with sequence type JSColumn.DATABASE_SEQUENCE. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample 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.");
}
} |
|
|
|
|
Set or clear a flag of a new column.
The flags are a bit pattern consisting of 1 or more of the following bits:
- JSColumn.UUID_COLUMN;
- JSColumn.EXCLUDED_COLUMN; |
|
|
Parameters true for set flag, false for clear flag |
|
|
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample 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.");
}
} |
|
|
|
|
|
|