SQL::Connection::GetSchema()

Syntax

Result_Flag as L = <SQL::Connection>.GetSchema( <Schema> as SQL::Schema [, Owner as C [, IncludeTables as L [, IncludeViews as L [, IncludeLinkedTables as L [, IncludeSystemTables as L [, IncludeSynonyms as L [, IncludeAliases as L ]]]]]]] )

Argument	Description
Result_Flag	TRUE (.T.) if the operation was successful; otherwise FALSE (.F.).
<SQL::Connection>	A SQL::Connection object.
<Schema>	A SQL::Schema object created with the DIM statement.
Owner	Optional. Default = "". The owner of the database.
IncludeTables	Optional. Default = .T. Whether to include table definitions.
IncludeViews	Optional. Default = .T. Whether to include view definitions.
IncludeLinkedTables	Optional. Default = .T. Whether to include linked table definitions.
IncludeSystemTables	Optional. Default = .T. Whether to include system table definitions.
IncludeSynonyms	Optional. Default = .T. Whether to include synonym definitions.
IncludeAliases	Optional. Default = .T. Whether to include alias definitions.

Description

The GetSchema() method returns a collection of the tables requested for the current database and optionally for those owned by a specific user.

Supported By

Alpha Five Version 8 Enterprise Edition

Limitations

Desktop applications only.

Examples

dim conn as SQL::Connection

dim sch as SQL::Schema

dim connString as C

connString = "{A5API='Access', FileName='c:\program files\a5v8\mdbfiles\alphasports.mdb'}"

if .not. conn.open(connString)

ui_msg_box("Error", conn.CallResult.text)

end

end if

if .not. conn.GetSchema(sch)

ui_msg_box("Error", conn.CallResult.text)

end

end if

file.from_string("c:\schema.txt", sch.xml)

conn.close()