MUSHclient documentation: DatabaseList

DatabaseList

DatabaseList
Script function world.DatabaseList Read about scripting Type Method Summary Lists all databases Prototype `VARIANT DatabaseList();` View list of data type meanings Description `This returns a list of all databases created for this world. You could use this to find which databases have been created, and then use DatabaseInfo to find information about each one.` Lua example `-- show all databases databases = DatabaseList() if databases then for _, v in ipairs (databases) do Note (v) end end -- if any` Lua notes `Lua returns nil if there are no databases.` Return value `If there are no databases then the return value is empty. Use "IsEmpty" to test for this possibility. Otherwise, it returns a variant array containing the names of all the databases. Use "ubound" to find the number of databases in the list. You can then use "DatabaseInfo" to find details about each database.` 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) DatabaseInfo (Returns information about a database) 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) DatabaseStep (Executes a previously-prepared SQL statement) DatabaseTotalChanges (Returns a count of the total changes to the database) (Help topic: function=DatabaseList) Documentation contents page

Script function

world.DatabaseList

Read about scripting

Type

Method

Summary

Lists all databases

Prototype

VARIANT DatabaseList();

Description

This returns a list of all databases created for this world. You could use this to find which databases have been created, and then use DatabaseInfo to find information about each one.

Lua example

-- show all databases
databases = DatabaseList()

if databases then
  for _, v in ipairs (databases) do 
    Note (v) 
  end
end -- if any

Lua notes

Lua returns nil if there are no databases.

Return value

If there are no databases then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the databases. Use "ubound" to find the number of databases in the list. You can then use "DatabaseInfo" to find details about each database.

See Also ...

Topics