Register forum user name Search FAQ

DatabaseInfo

Script function

world.DatabaseInfo

Read about scripting

Type

Method

Summary

Returns information about a database

Prototype

VARIANT DatabaseInfo(BSTR DbName, long InfoType);

View list of data type meanings

Description

This returns information about a particular database.

DbName - the identifying name of an existing database (as supplied to DatabaseOpen). Not the file name.

InfoType - the information you want:

1 - Name of database on disk

2 - Has a DatabasePrepare been validly done recently (and is still active)?

3 - Has a valid row been returned by DatabaseStep?

4 - Count of columns returned from the last DatabasePrepare.


Available in MUSHclient version 4.40 onwards.



Lua example

DatabaseInfo ("db", 4) --> get count of columns


Lua notes

Lua returns nil instead of a NULL or EMPTY variant.


Return value

The specified information about the database, as described above.
An EMPTY variant, if the database does not exist.
A NULL variant if the InfoType is not a valid type.


See Also ...

Topics

Database (SQLite)
Lua SQLite (database) interface
Scripting

Functions

(DatabaseChanges) Returns a count of the changes to the database by the most recent SQL statement
(DatabaseClose) Closes an SQLite database
(DatabaseColumnName) Find the name of a specified column returned by an SQL statement
(DatabaseColumnNames) Return a table of all the columns 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
(DatabaseGetField) Returns a single field from an SQL database
(DatabaseLastInsertRowid) Returns the most recently automatically allocated database key
(DatabaseList) Lists all databases
(DatabaseOpen) Opens an SQLite database
(DatabasePrepare) Prepares an SQL statement for execution
(DatabaseReset) Resets a previously-prepared SQL statement to the start
(DatabaseStep) Executes a previously-prepared SQL statement
(DatabaseTotalChanges) Returns a count of the total changes to the database

(Help topic: function=DatabaseInfo)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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