Child pages
  • JSColumnObject

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;3Constants SummaryConstant 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 flags 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.

servoy sSummary12%30%58%height: 30px;3Property SummaryGet 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.

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet 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.voidSet the database sequence name of the column, used for columns with sequence type JSColumn.voidSet or clear a flag of a new column.

constantservoy sDetail2100%height:30px2Constants DetailsDATABASE_IDENTITYname

DATABASE_IDENTITY

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowDATABASE_SEQUENCEname

DATABASE_SEQUENCE

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
DATETIMEname

DATETIME

dessIndent
Constant used when setting or getting the type of columns.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
EXCLUDED_COLUMNname

EXCLUDED_COLUMN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
INTEGERname

INTEGER

dessIndent
Constant used when setting or getting the type of columns.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MEDIAname

MEDIA

dessIndent
Constant used when setting or getting the type of columns.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
NONEname

NONE

dessIndent
Constant for column information indicating unset values.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
NUMBERname

NUMBER

dessIndent
Constant used when setting or getting the type of columns.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
PK_COLUMNname

PK_COLUMN

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
ROWID_COLUMNname

ROWID_COLUMN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
SERVOY_SEQUENCEname

SERVOY_SEQUENCE

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
TENANT_COLUMNname

TENANT_COLUMN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
TEXTname

TEXT

dessIndent
Constant used when setting or getting the type of columns.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
UUID_COLUMNname

UUID_COLUMN

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
UUID_GENERATORname

UUID_GENERATOR

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property DetailsallowNullname

allowNull

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowrowIdentifierTypename

rowIdentifierType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sequenceTypename

sequenceType

dessIndent
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;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetDataProviderIDname

getDataProviderID()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetDefaultFormatname

getDefaultFormat()

dessIndent
Get the default format of the column.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDescriptionname

getDescription()

dessIndent
Get the description property of the column.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getForeignTypename

getForeignType()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLengthname

getLength()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQualifiedNamename

getQualifiedName()

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getQuotedSQLNamename

getQuotedSQLName()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSQLNamename

getSQLName()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSQLTypename

getSQLType()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getScalename

getScale()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTitlename

getTitle()

dessIndent
Get the title property of the column.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTypename

getType()

dessIndent
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
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTypeAsStringname

getTypeAsString()

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
hasFlagname

hasFlag(flag)

dessIndent
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
prs

Parameters

sIndentflag ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDatabaseSequenceNamename

setDatabaseSequenceName(sequenceName)

dessIndent
Set the database sequence name of the column, used for columns with sequence type JSColumn.DATABASE_SEQUENCE.
prs

Parameters

sIndentsequenceNamethe sequence name
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setFlagname

setFlag(flag, set)

dessIndent
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;
prs

Parameters

sIndentflagthe flag to setsettrue for set flag, false for clear flag
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow