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

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow DATABASE_SEQUENCEname

DATABASE_SEQUENCE

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant used when setting or getting the type of columns.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
MEDIAname

MEDIA

dessIndentConstant used when setting or getting the type of columns.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
NONEname

NONE

dessIndentConstant for column information indicating unset values.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
NUMBERname

NUMBER

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant 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

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
TEXTname

TEXT

dessIndentConstant 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

dessIndentConstant 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

dessIndentConstant 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

dessIndentGet 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
lastDetailRow rowIdentifierTypename

rowIdentifierType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
sequenceTypename

sequenceType

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

dessIndentGet 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
lastDetailRow getDefaultFormatname

getDefaultFormat()

dessIndentGet the default format of the column.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getDescriptionname

getDescription()

dessIndentGet the description property of the column.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getForeignTypename

getForeignType()

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

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

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

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

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

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

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

dessIndentGet the title property of the column.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getTypename

getType()

dessIndentGet 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.MEDIAret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getTypeAsStringname

getTypeAsString()

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

dessIndentCheck 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_COLUMNprs

Parameters

sIndentflag 
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
setDatabaseSequenceNamename

setDatabaseSequenceName(sequenceName)

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

Parameters

sIndentsequenceNamethe sequence name
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
setFlagname

setFlag(flag, set)

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

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow