world.DatabaseColumnType

MUSHclient script function (Method) — introduced in version 4.40

Returns the type of data in an SQL column

Prototype

long DatabaseColumnType(BSTR DbName, long Column);

Data type meanings

Description

You can use this, after successfully doing a DatabaseStep, to find the type of data actually in each column of the current row.

Data types are:

Integer: 1
Float: 2
Text: 3
Blob: 4
Null: 5

This can be called after DatabaseStep to find whether a particular column is text, a number, or NULL (no data).

Columns start at 1 for the first column, up to the number returned by DatabaseColumns.

Lua example

t = DatabaseColumnType ("db", 2)  --> 3 (if the column is text)

Return value

A positive integer representing the data type of the specified column, as follows:

Integer: 1
Float: 2
Text: 3
Blob: 4
Null: 5

Otherwise, an error code:

-1 : Database id not found
-2 : Database not open
-4 : Do not have prepared statement
-5 : Do not have a valid row
-7 : Column number out of range

Related topic

Database (SQLite)

See also

FunctionDescription
DatabaseColumnNameFind the name of a specified column returned by an SQL statement
DatabaseColumnNamesReturn a table of all the columns returned by an SQL statement
DatabaseColumnTextReturns the contents of an SQL column, as text
DatabaseColumnValueReturns the contents of an SQL column, as text, float, integer, or null
DatabaseColumnValuesReturns the contents of all the SQL columns after a step
DatabaseColumnsFind how many columns will be returned by an SQL statement
DatabaseErrorReturns an English string describing the most recent SQL error
DatabaseExecExecutes SQL code against an SQLite database
DatabaseFinalizeFinalizes (wraps up) a previously-prepared SQL statement
DatabaseLastInsertRowidReturns the most recently automatically allocated database key
DatabaseOpenOpens an SQLite database
DatabasePreparePrepares an SQL statement for execution
DatabaseResetResets a previously-prepared SQL statement to the start