Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.DatabaseColumnNames


Name DatabaseColumnNames
Type Method
Summary Return a table of all the columns returned by an SQL statement
Prototype VARIANT DatabaseColumnNames(BSTR DbName);
Description

You can use this, after successfully doing a DatabasePrepare, to find the names of columns that each row will return.

You can do this before doing a DatabaseStep, because the column names (and number of columns) is a property of the SQL statement, whether or not any rows are found that actually match the query.

The column name is the name given in the "AS" clause in the query, if any. Otherwise SQLite assigns a column name, which is not guaranteed to be consistent between versions. Often the column name will simply be the name of the variable being queried, however calculations may return generated names.

For example, using this SQL statement:

DatabasePrepare ("db", "SELECT name AS 'weapon name', damage * 5 from weapons")


The returned column names were 'weapon name' and 'damage * 5'.

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

Also see DatabaseColumnName which returns an entry for a single column.


Note: Available in version 4.40 onwards.


Lua example
DatabasePrepare ("db", "SELECT * from weapons")
t = DatabaseColumnNames ("db")  --> the names of all columns
Lua notes
Lua returns nil if there are no columns.
Returns A table of all the column names, indexed by column number (ie. 1 is the first column).
Introduced in version 4.40

See also ...

Function Description
DatabaseColumnName Find the name of a specified column returned by an SQL statement
DatabaseColumns Find how many columns will be returned by an SQL statement
DatabaseColumnText Returns the contents of an SQL column, as text
DatabaseColumnType Returns the type of data in an SQL column
DatabaseColumnValue Returns the contents of an SQL column, as text, float, integer, or null
DatabaseColumnValues Returns the contents of all the SQL columns after a step
DatabaseError Returns an English string describing the most recent SQL error
DatabaseExec Executes SQL code against an SQLite database
DatabaseFinalize Finalizes (wraps up) a previously-prepared SQL statement
DatabaseLastInsertRowid Returns the most recently automatically allocated database key
DatabaseOpen Opens an SQLite database
DatabasePrepare Prepares an SQL statement for execution
DatabaseReset Resets a previously-prepared SQL statement to the start

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.