get a list of tables from the database - Maple Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Connectivity : Database Package : Connection : Database/Connection/GetTables

Connection:-GetTables - get a list of tables from the database

Calling Sequence

connection:-GetTables( opts )

Parameters

connection

-

Connection module

opts

-

(optional) equation(s) of the form option=value where option is one of catalog, schema, table, or output

Description

• 

GetTables returns an Array where each row of the Array contains matches from one table in the database connected to using connection.  A column in the Array is data associated with the table.  The output option controls the columns and their order in the returned Array.

• 

The opts argument can contain one or more of the following equations.

  

 

  

output = list containing a selection of symbols from: name, catalog, schema, and type

  

The output option specifies the columns to return. The order of the columns in the output is the same as the order of the symbols in the list. By default, only the name is returned. Some databases do not support all of these fields.

  

- name returns the name of the table.

  

- catalog returns the name of the catalog that contains the table.

  

- schema returns the name of the schema that the table uses.

  

- type returns the type of the table.  These are a database-specific values. Typical results are "TABLE", "VIEW", "SYSTEM TABLE","GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", and "SYNONYM".

  

 

  

catalog = string

  

Return only columns from the specified catalog. To return columns from tables not in a catalog, specify the empty string ("").  By default, no restrictions are applied.

  

 

  

schema = string

  

Return only columns from databases in which the schema matches the specified pattern. The pattern can consist of any valid schema name characters and the special characters % and _. A % matches any string and an _ matches any character. To match a literal _ or %, you must prepend the escape character \.  For example to match a _ use \_. By default, no restrictions are applied.

  

 

  

table = string

  

Return only columns for which the table matches the specified pattern. The pattern can consist of any valid table name characters and the special characters % and _. A % matches any string and an _ matches any character. To match a literal _ or %, you must prepend the escape character \.  For example to match a _ use \_. By default, no restrictions are applied.

Examples

driver:=Database[LoadDriver]:

conn:=driver:-OpenConnectionurl,name,pass:conn:-GetTables'output'='schema','name'

Schema1Table1Schema1Table2Schema2Table3Schema2Table4Schema3Table5

(1)

conn:-GetTables'schema'=%1,'output'='name'

Table1Table2

(2)

conn:-GetTables'table'=%1,'output'='name','schema','type'

Table1,Schema1,TABLE

(3)

See Also

Array, Database, Database[Connection], Database[Connection][GetCatalogs], Database[Connection][GetColumns], Database[Connection][GetSchemas], Database[Driver], Database[usage]


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam